subpicture_region_t Struct Reference

Video subtitle region. More...

#include <vlc_subpicture.h>

Collaboration diagram for subpicture_region_t:

Data Fields
video_format_t	fmt
	format of the picture
picture_t *	p_picture
	picture comprising this region
bool	b_absolute
	position is absolute in the movie
bool	b_in_window
	position the region in window
int	i_x
	position of region, relative to alignment
int	i_y
	position of region, relative to alignment
int	i_align
	alignment flags SUBPICTURE_ALIGN_xxx
int	i_alpha
	transparency
text_segment_t *	p_text
	subtitle text, made of a list of segments
int	text_flags
	VLC_SUBPIC_TEXT_FLAG_xxx and SUBPICTURE_ALIGN_xxx.
int	i_max_width
int	i_max_height
	horizontal rendering/cropping target/limit
struct vlc_list	node
	vertical rendering/cropping target/limit

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_absolute

bool subpicture_region_t::b_absolute

position is absolute in the movie

Referenced by OSDTextUpdate(), OSDWidgetUpdate(), SpuRegionPlace(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_NewFromPicture(), subpicture_region_NewInternal(), vout_OSDBackground(), vout_OSDEpgSlider(), vout_OSDImage(), and vout_OSDTextRegion().

b_in_window

bool subpicture_region_t::b_in_window

position the region in window

Referenced by OSDTextUpdate(), OSDWidgetUpdate(), SpuRenderSubpictures(), subpicture_NewFromPicture(), subpicture_region_NewInternal(), vout_OSDBackground(), vout_OSDEpgSlider(), vout_OSDImage(), and vout_OSDTextRegion().

fmt

video_format_t subpicture_region_t::fmt

format of the picture

Referenced by OSDTextUpdate(), region_FixFmt(), SpuRegionPlace(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_NewFromPicture(), subpicture_region_Delete(), subpicture_region_ForPicture(), subpicture_region_New(), subpicture_region_NewText(), and vout_OSDTextRegion().

i_align

int subpicture_region_t::i_align

alignment flags SUBPICTURE_ALIGN_xxx

Referenced by OSDTextUpdate(), SpuRenderRegion(), SpuRenderSubpictures(), vout_FillRightPanel(), vout_OSDBackground(), vout_OSDEpgSlider(), vout_OSDImage(), and vout_OSDTextRegion().

i_alpha

int subpicture_region_t::i_alpha

transparency

Referenced by SpuRenderRegion(), and subpicture_region_NewInternal().

i_max_height

int subpicture_region_t::i_max_height

horizontal rendering/cropping target/limit

Referenced by SpuRenderRegion(), and vout_OSDRegionConstrain().

i_max_width

int subpicture_region_t::i_max_width

Referenced by SpuRenderRegion(), and vout_OSDRegionConstrain().

i_x

int subpicture_region_t::i_x

position of region, relative to alignment

Referenced by OSDRegion(), OSDTextUpdate(), SpuRegionPlace(), SpuRenderSubpictures(), SpuRenderText(), subpicture_NewFromPicture(), subpicture_region_NewInternal(), vout_OSDBackground(), vout_OSDEpgSlider(), vout_OSDImage(), and vout_OSDTextRegion().

i_y

int subpicture_region_t::i_y

position of region, relative to alignment

Referenced by OSDRegion(), OSDTextUpdate(), SpuRegionPlace(), SpuRenderSubpictures(), SpuRenderText(), subpicture_NewFromPicture(), subpicture_region_NewInternal(), vout_OSDBackground(), vout_OSDEpgSlider(), vout_OSDImage(), and vout_OSDTextRegion().

node

struct vlc_list subpicture_region_t::node

vertical rendering/cropping target/limit

for inclusion in a vlc_spu_regions

Referenced by spu_PrerenderText(), and SpuRenderSubpictures().

p_picture

picture_t* subpicture_region_t::p_picture

picture comprising this region

Referenced by DrawRect(), DrawTriangle(), region_FixFmt(), SpuRenderRegion(), subpicture_region_Delete(), subpicture_region_ForPicture(), subpicture_region_New(), vout_OSDBackground(), and vout_OSDEpgSlider().

p_text

text_segment_t* subpicture_region_t::p_text

subtitle text, made of a list of segments

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

text_flags

int subpicture_region_t::text_flags

VLC_SUBPIC_TEXT_FLAG_xxx and SUBPICTURE_ALIGN_xxx.

Referenced by OSDTextUpdate(), subpicture_region_NewText(), and vout_OSDTextRegion().

---

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

• include/vlc_subpicture.h