Representation of a pen drawing instruction. More...

#include <advance_info.h>

Public Attributes
CobbletextAdvanceType	type
	The type of movement. More...

uint32_t	text_index
	Position of the text in code points. More...

int32_t	advance_x
	Horizontal movement of the pen. More...

int32_t	advance_y
	Vertical movement of the pen. More...

CobbletextGlyphID	glyph_id
	Glyph to be drawn. More...

int32_t	glyph_offset_x
	Horizontal offset to the current pen position when drawing a glyph. More...

int32_t	glyph_offset_y
	Vertical offset to the current pen position when drawing a glyph. More...

CobbletextInlineObjectID	inline_object
	User-provided inline object ID. More...

CobbletextCustomPropertyID	custom_property
	User-provided custom property. More...

Detailed Description

Representation of a pen drawing instruction.

The origin of the X-Y coordinate system is defined to be the top-left of the drawing area where

Positive X values move to the right
Positive Y values move to the bottom

The advance values are to be added to the current pen position after drawing a glyph or object (if any).

Member Data Documentation

◆ advance_x

int32_t CobbletextAdvanceInfo::advance_x

Horizontal movement of the pen.

◆ advance_y

int32_t CobbletextAdvanceInfo::advance_y

Vertical movement of the pen.

◆ custom_property

CobbletextCustomPropertyID CobbletextAdvanceInfo::custom_property

User-provided custom property.

Default is 0.

◆ glyph_id

CobbletextGlyphID CobbletextAdvanceInfo::glyph_id

Glyph to be drawn.

Only valid when #type is a glyph.

◆ glyph_offset_x

int32_t CobbletextAdvanceInfo::glyph_offset_x

Horizontal offset to the current pen position when drawing a glyph.

◆ glyph_offset_y

int32_t CobbletextAdvanceInfo::glyph_offset_y

Vertical offset to the current pen position when drawing a glyph.

◆ inline_object

CobbletextInlineObjectID CobbletextAdvanceInfo::inline_object

User-provided inline object ID.

Only valid when #type is a inline object.

◆ text_index

uint32_t CobbletextAdvanceInfo::text_index

Position of the text in code points.

◆ type

CobbletextAdvanceType CobbletextAdvanceInfo::type

The type of movement.

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

cobbletext/advance_info.h

Public Attributes