Video subtitle. More...
Data Fields | |
| subpicture_region_t * | p_region |
| region list composing this subtitle More... | |
| subpicture_updater_t | updater |
| subpicture_private_t * | p_private |
Channel ID | |
| int | i_channel |
| subpicture channel ID More... | |
Type and flags | |
Should NOT be modified except by the vout thread | |
| int64_t | i_order |
| subpicture_t * | p_next |
| an increasing unique number More... | |
Date properties | |
| mtime_t | i_start |
| beginning of display date More... | |
| mtime_t | i_stop |
| end of display date More... | |
| bool | b_ephemer |
| If this flag is set to true the subtitle will be displayed until the next one appear. More... | |
| bool | b_fade |
| enable fading More... | |
Display properties | |
These properties are only indicative and may be changed by the video output thread, or simply ignored depending of the subtitle type. | |
| bool | b_subtitle |
| the picture is a movie subtitle More... | |
| bool | b_absolute |
| position is absolute More... | |
| int | i_original_picture_width |
| original width of the movie More... | |
| int | i_original_picture_height |
| original height of the movie More... | |
| int | i_alpha |
| transparency More... | |
Detailed Description
Video subtitle.
Any subtitle destined to be displayed by a video output thread should be stored in this structure from it's creation to it's effective display. Subtitle type and flags should only be modified by the output thread. Note that an empty subtitle MUST have its flags set to 0.
Field Documentation
◆ b_absolute
| bool subpicture_t::b_absolute |
position is absolute
Referenced by picture_BlendSubpicture(), SpuRegionPlace(), SpuRenderRegion(), subpicture_New(), SubpictureCmp(), vout_OSDEpg(), and vout_OSDText().
◆ b_ephemer
| bool subpicture_t::b_ephemer |
If this flag is set to true the subtitle will be displayed until the next one appear.
Referenced by SpuSelectSubpictures(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().
◆ b_fade
| bool subpicture_t::b_fade |
enable fading
Referenced by picture_BlendSubpicture(), SpuRenderRegion(), subpicture_New(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().
◆ b_subtitle
| bool subpicture_t::b_subtitle |
the picture is a movie subtitle
Referenced by spu_new_buffer(), SpuRenderRegion(), SpuSelectSubpictures(), subpicture_New(), and vout_OSDEpg().
◆ i_alpha
| int subpicture_t::i_alpha |
transparency
Referenced by picture_BlendSubpicture(), SpuRenderRegion(), and subpicture_New().
◆ i_channel
| int subpicture_t::i_channel |
subpicture channel ID
Referenced by spu_new_buffer(), SpuSelectSubpictures(), SubpictureCmp(), SubSourceInit(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().
◆ i_order
| int64_t subpicture_t::i_order |
Referenced by spu_new_buffer(), SpuSelectSubpictures(), subpicture_New(), and SubpictureCmp().
◆ i_original_picture_height
| int subpicture_t::i_original_picture_height |
original height of the movie
Referenced by OSDEpgUpdate(), SpuRegionPlace(), subpicture_NewFromPicture(), and VoutSnapshotPip().
◆ i_original_picture_width
| int subpicture_t::i_original_picture_width |
original width of the movie
Referenced by OSDEpgUpdate(), SpuRegionPlace(), subpicture_NewFromPicture(), and VoutSnapshotPip().
◆ i_start
| mtime_t subpicture_t::i_start |
beginning of display date
Referenced by spu_RegisterChannel(), SpuRenderRegion(), SpuSelectSubpictures(), SubpictureCmp(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().
◆ i_stop
| mtime_t subpicture_t::i_stop |
end of display date
Referenced by spu_RegisterChannel(), SpuRenderRegion(), SpuSelectSubpictures(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().
◆ p_next
| subpicture_t* subpicture_t::p_next |
◆ p_private
| subpicture_private_t* subpicture_t::p_private |
Referenced by subpicture_Delete(), and subpicture_Update().
◆ p_region
| subpicture_region_t* subpicture_t::p_region |
region list composing this subtitle
Referenced by OSDEpgUpdate(), picture_BlendSubpicture(), subpicture_Delete(), subpicture_New(), subpicture_NewFromPicture(), and subpicture_Update().
◆ updater
| subpicture_updater_t subpicture_t::updater |
Referenced by OSDEpgDestroy(), OSDEpgUpdate(), OSDTextDestroy(), subpicture_Delete(), and subpicture_Update().
The documentation for this struct was generated from the following file:
- include/vlc_subpicture.h
