VLC: text_style_t Struct Reference

VLC 3.0.18

Text style. More...

Public Types
enum	{ STYLE_WRAP_DEFAULT = 0, STYLE_WRAP_CHAR, STYLE_WRAP_NONE }

Data Fields
char *	psz_fontname
	The name of the font. More...

char *	psz_monofontname
	The name of the mono font. More...

uint16_t	i_features
	Feature flags (means non default) More...

uint16_t	i_style_flags
	Formatting style flags. More...

float	f_font_relsize
	The font size in video height %. More...

int	i_font_size
	The font size in pixels. More...

int	i_font_color
	The color of the text 0xRRGGBB (native endianness) More...

uint8_t	i_font_alpha
	The transparency of the text. More...

int	i_spacing
	The spaceing between glyphs in pixels. More...

int	i_outline_color
	The color of the outline 0xRRGGBB. More...

uint8_t	i_outline_alpha
	The transparency of the outline. More...

int	i_outline_width
	The width of the outline in pixels. More...

int	i_shadow_color
	The color of the shadow 0xRRGGBB. More...

uint8_t	i_shadow_alpha
	The transparency of the shadow. More...

int	i_shadow_width
	The width of the shadow in pixels. More...

int	i_background_color
	The color of the background 0xRRGGBB. More...

uint8_t	i_background_alpha
	The transparency of the background. More...

int	i_karaoke_background_color
	Background color for karaoke 0xRRGGBB. More...

uint8_t	i_karaoke_background_alpha
	The transparency of the karaoke bg. More...

enum text_style_t:: { ... }	e_wrapinfo

Detailed Description

Text style.

A text style is used to specify the formatting of text. A font renderer can use the supplied information to render the text specified.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
STYLE_WRAP_DEFAULT	Breaks on whitespace or fallback on char.
STYLE_WRAP_CHAR	Breaks at character level only.
STYLE_WRAP_NONE	No line breaks (except explicit ones)

Field Documentation

◆ e_wrapinfo

enum { ... } text_style_t::e_wrapinfo

Referenced by text_style_Create(), and vout_OSDSegmentSetNoWrap().

◆ f_font_relsize

float text_style_t::f_font_relsize

The font size in video height %.

Referenced by text_style_Create().

◆ i_background_alpha

uint8_t text_style_t::i_background_alpha

The transparency of the background.

Referenced by text_style_Create().

◆ i_background_color

int text_style_t::i_background_color

The color of the background 0xRRGGBB.

Referenced by text_style_Create().

◆ i_features

uint16_t text_style_t::i_features

Feature flags (means non default)

Referenced by text_style_Create(), text_style_Merge(), vout_OSDSegment(), and vout_OSDSegmentSetNoWrap().

◆ i_font_alpha

uint8_t text_style_t::i_font_alpha

The transparency of the text.

Referenced by text_style_Create(), and vout_OSDSegment().

◆ i_font_color

int text_style_t::i_font_color

The color of the text 0xRRGGBB (native endianness)

Referenced by text_style_Create(), and vout_OSDSegment().

◆ i_font_size

int text_style_t::i_font_size

The font size in pixels.

Referenced by text_style_Create(), and vout_OSDSegment().

◆ i_karaoke_background_alpha

uint8_t text_style_t::i_karaoke_background_alpha

The transparency of the karaoke bg.

Referenced by text_style_Create().

◆ i_karaoke_background_color

int text_style_t::i_karaoke_background_color

Background color for karaoke 0xRRGGBB.

Referenced by text_style_Create().

◆ i_outline_alpha

uint8_t text_style_t::i_outline_alpha

The transparency of the outline.

Referenced by text_style_Create(), and vout_OSDSegment().

◆ i_outline_color

int text_style_t::i_outline_color

The color of the outline 0xRRGGBB.

Referenced by text_style_Create().

◆ i_outline_width

int text_style_t::i_outline_width

The width of the outline in pixels.

Referenced by text_style_Create().

◆ i_shadow_alpha

uint8_t text_style_t::i_shadow_alpha

The transparency of the shadow.

Referenced by text_style_Create(), and vout_OSDSegment().

◆ i_shadow_color

int text_style_t::i_shadow_color

The color of the shadow 0xRRGGBB.

Referenced by text_style_Create().

◆ i_shadow_width

int text_style_t::i_shadow_width

The width of the shadow in pixels.

Referenced by text_style_Create().

◆ i_spacing

int text_style_t::i_spacing

The spaceing between glyphs in pixels.

Referenced by text_style_Create().

◆ i_style_flags

uint16_t text_style_t::i_style_flags

Formatting style flags.

Referenced by text_style_Create(), and text_style_Merge().

◆ psz_fontname

char* text_style_t::psz_fontname

The name of the font.

Referenced by text_style_Copy(), text_style_Create(), text_style_Delete(), and text_style_Merge().

◆ psz_monofontname

char* text_style_t::psz_monofontname

The name of the mono font.

Referenced by text_style_Copy(), text_style_Create(), text_style_Delete(), and text_style_Merge().

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

include/vlc_text_style.h