text_segment_t Struct Reference

Text segment for subtitles. More...

#include <vlc_text_style.h>

Collaboration diagram for text_segment_t:

Data Fields
char *	psz_text
	text string of the segment More...
text_style_t *	style
	style applied to this segment More...
text_segment_t *	p_next
	next segment More...
text_segment_ruby_t *	p_ruby
	ruby descriptions More...

Detailed Description

Text segment for subtitles.

This structure is used to store a formatted text, with mixed styles Every segment is comprised of one text and a unique style

On style change, a new segment is created with the next part of text and the new style, and chained to the list

Create with text_segment_New and clean the chain with text_segment_ChainDelete

Field Documentation

p_next

text_segment_t* text_segment_t::p_next

next segment

Referenced by text_segment_ChainDelete(), text_segment_Copy(), vout_OSDEpgEvent(), and vout_OSDSegmentSetNoWrap().

p_ruby

text_segment_ruby_t* text_segment_t::p_ruby

ruby descriptions

Referenced by text_segment_Copy(), text_segment_Delete(), and text_segment_FromRuby().

psz_text

char* text_segment_t::psz_text

text string of the segment

Referenced by text_segment_Copy(), text_segment_Delete(), text_segment_FromRuby(), and text_segment_New().

style

text_style_t* text_segment_t::style

style applied to this segment

Referenced by text_segment_Copy(), text_segment_Delete(), text_segment_NewInheritStyle(), vout_OSDSegment(), and vout_OSDSegmentSetNoWrap().

---

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

• include/vlc_text_style.h