Class handling the splitting of a paragraph of text into lines and visual runs. More...

Inheritance diagram for FallbackParagraphLayout:

Data Structures
class	FallbackLine
	A single line worth of VisualRuns. More...

class	FallbackVisualRun
	Visual run contains data about the bit of text with the same font. More...

Public Member Functions
	FallbackParagraphLayout (char32_t *buffer, int length, FontMap &runs)
	Create a new paragraph layouter.

void	Reflow () override
	Reset the position to the start of the paragraph.

std::unique_ptr< const Line >	NextLine (int max_width) override
	Construct a new line with a maximum width.

Data Fields
const char32_t *	buffer_begin
	Begin of the buffer.

const char32_t *	buffer
	The current location in the buffer.

FontMap &	runs
	The fonts we have to use for this paragraph.

Detailed Description

Class handling the splitting of a paragraph of text into lines and visual runs.

One constructs this class with the text that needs to be split into lines. Then nextLine is called with the maximum width until nullptr is returned. Each nextLine call creates VisualRuns which contain the length of text that are to be drawn with the same font. In other words, the result of this class is a list of sub strings with their font. The sub strings are then already fully laid out, and only need actual drawing.

The positions in a visual run are sequential pairs of X,Y of the begin of each of the glyphs plus an extra pair to mark the end.

Note: This variant does not handle right-to-left properly.

Definition at line 38 of file gfx_layout_fallback.cpp.

Constructor & Destructor Documentation

◆ FallbackParagraphLayout()

FallbackParagraphLayout::FallbackParagraphLayout	(	char32_t *	buffer,
		int	length,
		FontMap &	runs
	)

Create a new paragraph layouter.

Parameters

buffer	The characters of the paragraph.
length	The length of the paragraph.
runs	The font mapping of this paragraph.

Definition at line 194 of file gfx_layout_fallback.cpp.

References runs.

Member Function Documentation

◆ NextLine()

std::unique_ptr< const ParagraphLayouter::Line > FallbackParagraphLayout::NextLine ( int max_width )

overridevirtual

Construct a new line with a maximum width.

Parameters

max_width The maximum width of the string.

Returns: A Line, or nullptr when at the end of the paragraph.

Implements ParagraphLayouter.

Definition at line 212 of file gfx_layout_fallback.cpp.

References buffer, buffer_begin, GetCharacterWidth(), FontCache::GetSize(), IsTextDirectionChar(), IsWhitespace(), and runs.

◆ Reflow()

void FallbackParagraphLayout::Reflow ( )

overridevirtual

Reset the position to the start of the paragraph.

Implements ParagraphLayouter.

Definition at line 202 of file gfx_layout_fallback.cpp.

References buffer, and buffer_begin.

Field Documentation

◆ buffer

const char32_t* FallbackParagraphLayout::buffer

The current location in the buffer.

Definition at line 70 of file gfx_layout_fallback.cpp.

Referenced by NextLine(), and Reflow().

◆ buffer_begin

const char32_t* FallbackParagraphLayout::buffer_begin

Begin of the buffer.

Definition at line 69 of file gfx_layout_fallback.cpp.

Referenced by NextLine(), and Reflow().

◆ runs

FontMap& FallbackParagraphLayout::runs

The fonts we have to use for this paragraph.

Definition at line 71 of file gfx_layout_fallback.cpp.

Referenced by FallbackParagraphLayout(), and NextLine().

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

src/gfx_layout_fallback.cpp

Data Structures

Public Member Functions

Data Fields