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 More...
picture_t *	p_picture
	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 More...
int	i_alpha
	transparency More...
text_segment_t *	p_text
	subtitle text, made of a list of segments More...
int	i_text_align
	alignment flags of region content 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 target/limit More...
vlc_rational_t	zoom_h
	vertical rendering/cropping target/limit More...
vlc_rational_t	zoom_v
subpicture_region_t *	p_next
	next region in the list More...
subpicture_region_private_t *	p_private
	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_NewInternal(), and vout_OSDTextRegion().

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

format of the picture

Referenced by spu_PrerenderText(), SpuRegionPlace(), SpuRenderRegion(), SpuRenderSubpictures(), SpuRenderText(), subpicture_region_Copy(), subpicture_region_Delete(), subpicture_region_New(), and subpicture_region_NewInternal().

i_align

int subpicture_region_t::i_align

alignment flags of region

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

i_alpha

int subpicture_region_t::i_alpha

transparency

Referenced by SpuRenderRegion(), subpicture_region_Copy(), 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

try to balance wrapped text lines

Referenced by SpuRenderRegion(), and vout_OSDRegionConstrain().

i_text_align

int subpicture_region_t::i_text_align

alignment flags of region content

Referenced by OSDTextUpdate(), and vout_OSDTextRegion().

i_x

int subpicture_region_t::i_x

position of region, relative to alignment

Referenced by OSDRegion(), OSDTextUpdate(), SpuRegionPlace(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_region_Copy(), 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(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_region_Copy(), vout_OSDBackground(), vout_OSDEpgSlider(), vout_OSDImage(), and vout_OSDTextRegion().

p_next

subpicture_region_t* subpicture_region_t::p_next

next region in the list

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

p_picture

picture_t* subpicture_region_t::p_picture

picture comprising this region

Referenced by DrawRect(), DrawTriangle(), spuregion_CreateFromPicture(), SpuRenderRegion(), subpicture_NewFromPicture(), subpicture_region_Copy(), subpicture_region_Delete(), subpicture_region_New(), vout_OSDBackground(), and vout_OSDEpgSlider().

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(), subpicture_region_Copy(), subpicture_region_Delete(), and vout_OSDTextRegion().

zoom_h

vlc_rational_t subpicture_region_t::zoom_h

vertical rendering/cropping target/limit

Referenced by subpicture_region_NewInternal().

zoom_v

vlc_rational_t subpicture_region_t::zoom_v

Referenced by subpicture_region_NewInternal().

---

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

• include/vlc_subpicture.h