VLC  3.0.0-git
Data Fields
subpicture_region_t Struct Reference

Video subtitle region. More...

Collaboration diagram for subpicture_region_t:
Collaboration graph

Data Fields

video_format_t fmt
 format of the picture More...
 picture comprising this region More...
int i_x
 position of region, relative to alignment More...
int i_y
 position of region, relative to alignment More...
int i_align
 alignment flags of region and content More...
int i_alpha
 transparency More...
 subtitle text, made of a list of segments More...
bool b_noregionbg
 render background under text only More...
bool b_gridmode
bool b_balanced_text
 if the decoder sends row/cols based output More...
int i_max_width
 try to balance wrapped text lines More...
int i_max_height
 horizontal rendering/cropping limit More...
 vertical rendering/cropping limit More...
 Private data for spu_t only More...

Detailed Description

Video subtitle region.

A subtitle region is defined by a picture (graphic) and its rendering coordinates. Subtitles contain a list of regions.

Field Documentation

◆ b_balanced_text

bool subpicture_region_t::b_balanced_text

if the decoder sends row/cols based output

Referenced by subpicture_region_New().

◆ b_gridmode

bool subpicture_region_t::b_gridmode

◆ b_noregionbg

bool subpicture_region_t::b_noregionbg

render background under text only

◆ fmt

video_format_t subpicture_region_t::fmt

◆ i_align

int subpicture_region_t::i_align

alignment flags of region and content

Referenced by OSDTextUpdate(), SpuRegionPlace(), SpuRenderRegion(), subpicture_region_Copy(), and vout_OSDTextRegion().

◆ i_alpha

int subpicture_region_t::i_alpha

◆ i_max_height

int subpicture_region_t::i_max_height

horizontal rendering/cropping limit

Referenced by SpuRenderRegion().

◆ i_max_width

int subpicture_region_t::i_max_width

try to balance wrapped text lines

Referenced by SpuRenderRegion().

◆ i_x

int subpicture_region_t::i_x

◆ i_y

int subpicture_region_t::i_y

◆ p_next

subpicture_region_t* subpicture_region_t::p_next

vertical rendering/cropping limit

next region in the list

Referenced by picture_BlendSubpicture(), spu_PutSubpicture(), SpuRenderSubpictures(), subpicture_region_ChainDelete(), and vout_BuildOSDEpg().

◆ p_picture

picture_t* subpicture_region_t::p_picture

◆ p_private

subpicture_region_private_t* subpicture_region_t::p_private

Private data for spu_t only

Referenced by SpuRenderRegion(), and subpicture_region_Delete().

◆ p_text

text_segment_t* subpicture_region_t::p_text

subtitle text, made of a list of segments

Referenced by OSDTextUpdate(), SpuRenderText(), subpicture_region_Copy(), subpicture_region_Delete(), and vout_OSDTextRegion().

The documentation for this struct was generated from the following file: