VLC  3.0.0-git
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
subpicture_region_t Struct Reference

Video subtitle region. More...

Collaboration diagram for subpicture_region_t:
Collaboration graph
[legend]

Data Fields

video_format_t fmt
 format of the picture
picture_tp_picture
 picture comprising this region
int i_x
 position of region
int i_y
 position of region
int i_align
 alignment within a region
int i_alpha
 transparency
char * psz_text
 text string comprising this region
char * psz_html
 HTML version of subtitle (NULL = use psz_text)
text_style_tp_style
 a description of the text style formatting
bool b_renderbg
 render black background under text
subpicture_region_tp_next
 next region in the list
subpicture_region_private_tp_private
 Private data for spu_t only

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

bool subpicture_region_t::b_renderbg

render black background under text

video_format_t subpicture_region_t::fmt
int subpicture_region_t::i_align

alignment within a region

Referenced by OSDTextUpdate(), SpuRegionPlace(), SpuRenderRegion(), and vout_OSDEpgText().

int subpicture_region_t::i_alpha

transparency

Referenced by SpuRenderRegion(), and subpicture_region_New().

int subpicture_region_t::i_x
int subpicture_region_t::i_y
subpicture_region_t* subpicture_region_t::p_next
picture_t* subpicture_region_t::p_picture
subpicture_region_private_t* subpicture_region_t::p_private

Private data for spu_t only

Referenced by SpuRenderRegion(), subpicture_region_Delete(), and subpicture_region_New().

text_style_t* subpicture_region_t::p_style

a description of the text style formatting

Referenced by subpicture_region_Delete(), subpicture_region_New(), and vout_OSDEpgText().

char* subpicture_region_t::psz_html

HTML version of subtitle (NULL = use psz_text)

Referenced by SpuRenderText(), and subpicture_region_Delete().

char* subpicture_region_t::psz_text

text string comprising this region

Referenced by OSDTextUpdate(), subpicture_region_Delete(), subpicture_region_New(), and vout_OSDEpgText().


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