shaping.h

#include <modkit/shaping.h>10 functions · 5 structs · 3 enums · 8 typedefs · 4 macros

Optional HarfBuzz-backed text shaping package.

A shaped run has one font, size, script, language, and direction. HarfBuzz performs glyph selection and positioning. Use text_layout.h for retained paragraph bidi, Unicode line breaking, fallback, and mixed styles.

Functions

`mk_text_run_advance`function

bool mk_text_run_advance(mk_text_run_t run, float *x_advance, float *y_advance)

Get total pen advance in modkit layout coordinates.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.
`x_advance`	`float *`	Value for x advance.
`y_advance`	`float *`	Value for y advance.

Returns True when the operation succeeds.

`mk_text_run_bounds`function

bool mk_text_run_bounds(mk_text_run_t run, mk_text_bounds_t *bounds)

Get the visible glyph bounds relative to the run origin.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.
`bounds`	`mk_text_bounds_t *`	Value for bounds.

Returns True when the operation succeeds.

`mk_text_run_build`function

uint32_t mk_text_run_build(mk_text_run_t run, mk_glyph_quad *out_quads, uint32_t max_quads, mk_text_geometry *out_geom)

Build atlas-backed glyph quads without drawing.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.
`out_quads`	`mk_glyph_quad *`	Receives the quads.
`max_quads`	`uint32_t`	Value for max quads.
`out_geom`	`mk_text_geometry *`	Receives the geom.

Returns The resulting value.

`mk_text_run_create`function

mk_text_run_t mk_text_run_create(mk_font_t font, const mk_text_shape_desc_t *desc)

Shape one uniform text run.

Parameter	Type	Description
`font`	`mk_font_t`	Value for font.
`desc`	`const mk_text_shape_desc_t *`	Configuration descriptor.

Returns The resulting handle or value.

`mk_text_run_destroy`function

void mk_text_run_destroy(mk_text_run_t run)

Destroy the text run.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.

`mk_text_run_draw`function

float mk_text_run_draw(mk_text_run_t run, float x, float y, const mk_text_style_t *style, int align)

Draw a shaped run inside mk_text_begin()/mk_text_end().

Returns the run's horizontal advance.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.
`x`	`float`	Value for x.
`y`	`float`	Value for y.
`style`	`const mk_text_style_t *`	Value for style.
`align`	`int`	Value for align.

Returns The resulting value.

`mk_text_run_draw_instances`function

float mk_text_run_draw_instances(mk_text_run_t run, float x, float y, const mk_text_style_t *style, int align, const mk_text_glyph_instance_t *instances, uint32_t instance_count)

Draw a shaped run with optional one-to-one per-glyph transform and tint overrides.

Missing entries inherit identity and the run style.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.
`x`	`float`	Value for x.
`y`	`float`	Value for y.
`style`	`const mk_text_style_t *`	Value for style.
`align`	`int`	Value for align.
`instances`	`const mk_text_glyph_instance_t *`	Value for instances.
`instance_count`	`uint32_t`	Number of instance entries.

Returns The resulting value.

`mk_text_run_glyph`function

bool mk_text_run_glyph(mk_text_run_t run, uint32_t index, mk_shaped_glyph_t *glyph)

Copy one glyph.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.
`index`	`uint32_t`	Zero-based index.
`glyph`	`mk_shaped_glyph_t *`	Value for glyph.

Returns True when the operation succeeds.

`mk_text_run_glyph_count`function

uint32_t mk_text_run_glyph_count(mk_text_run_t run)

Perform the text run glyph count operation.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.

Returns The resulting value.

`mk_text_run_is_valid`function

bool mk_text_run_is_valid(mk_text_run_t run)

Return whether a run handle currently refers to a live shaped run.

Parameter	Type	Description
`run`	`mk_text_run_t`	Value for run.

Returns True when the condition holds.

Structs

`mk_shaped_glyph`struct

Positioned glyph output.

Coordinates use modkit layout space: +X right and +Y down. cluster is a UTF-8 byte offset into the input string.

Field	Type	Description
`glyph_id`	`uint32_t`	The glyph ID.
`cluster`	`uint32_t`	The cluster.
`x_advance`	`float`	The x advance.
`y_advance`	`float`	The y advance.
`x_offset`	`float`	The x offset.
`y_offset`	`float`	The y offset.
`flags`	`uint32_t`	The flags.

`mk_text_feature`struct

Data for text feature.

Field	Type	Description
`tag`	`uint32_t`	Four-byte OpenType tag, for example 'liga'.
`value`	`uint32_t`	Feature value; 0 disables and 1 usually enables.
`start`	`uint32_t`	First UTF-8 byte offset, inclusive.
`end`	`uint32_t`	Last UTF-8 byte offset, exclusive, or GLOBAL_END.

`mk_text_glyph_instance`struct

Optional overrides for one shaped glyph.

The affine matrix is [a,b,c,d,tx,ty] and is applied around the glyph's shaped pen origin.

Field	Type	Description
`transform`	`float`	The transform.
`tint`	`uint32_t`	The tint.
`flags`	`uint32_t`	The flags.

`mk_text_run`struct

Data for text run.

Field	Type	Description
`idx`	`uint16_t`	The idx.
`generation`	`uint16_t`	The generation.

`mk_text_shape_desc`struct

Data for text shape desc.

Field	Type	Description
`text`	`const char *`	UTF-8 input.
`text_len`	`size_t`	Bytes, or 0 for a NUL-terminated string.
`size_px`	`float`	Pixel size, or 0 for the font default.
`direction`	`mk_text_direction_t`	AUTO asks HarfBuzz to infer direction.
`script`	`uint32_t`	ISO 15924 tag, or 0 to infer it.
`language`	`const char *`	BCP-47 language, or NULL.
`features`	`const mk_text_feature_t *`	Optional OpenType features.
`feature_count`	`uint32_t`	The feature count.

Enums

`mk_shaped_glyph_flags`enum

Values for shaped glyph flags.

Value	Description
`MK_SHAPED_GLYPH_UNSAFE_TO_BREAK`	Selects unsafe to break.
`MK_SHAPED_GLYPH_UNSAFE_TO_CONCAT`	Selects unsafe to concat.
`MK_SHAPED_GLYPH_SAFE_TO_INSERT_TATWEEL`	Selects safe to insert tatweel.

`mk_text_direction`enum

Values for text direction.

Value	Description
`MK_TEXT_DIRECTION_AUTO`	Selects auto.
`MK_TEXT_DIRECTION_LTR`	Selects ltr.
`MK_TEXT_DIRECTION_RTL`	Selects rtl.
`MK_TEXT_DIRECTION_TTB`	Selects ttb.
`MK_TEXT_DIRECTION_BTT`	Selects btt.

`mk_text_glyph_instance_flags`enum

Values for text glyph instance flags.

Value	Description
`MK_TEXT_GLYPH_INSTANCE_TRANSFORM`	Selects transform.
`MK_TEXT_GLYPH_INSTANCE_TINT`	Selects tint.

Typedefs

`mk_shaped_glyph_flags_t`typedef

typedef enum mk_shaped_glyph_flags mk_shaped_glyph_flags_t

Values for shaped glyph flags.

`mk_shaped_glyph_t`typedef

typedef struct mk_shaped_glyph mk_shaped_glyph_t

Positioned glyph output.

Coordinates use modkit layout space: +X right and +Y down. cluster is a UTF-8 byte offset into the input string.

`mk_text_direction_t`typedef

typedef enum mk_text_direction mk_text_direction_t

Values for text direction.

`mk_text_feature_t`typedef

typedef struct mk_text_feature mk_text_feature_t

Data for text feature.

`mk_text_glyph_instance_flags_t`typedef

typedef enum mk_text_glyph_instance_flags mk_text_glyph_instance_flags_t

Values for text glyph instance flags.

`mk_text_glyph_instance_t`typedef

typedef struct mk_text_glyph_instance mk_text_glyph_instance_t

Optional overrides for one shaped glyph.

The affine matrix is [a,b,c,d,tx,ty] and is applied around the glyph's shaped pen origin.

`mk_text_run_t`typedef

typedef struct mk_text_run mk_text_run_t

Data for text run.

`mk_text_shape_desc_t`typedef

typedef struct mk_text_shape_desc mk_text_shape_desc_t

Data for text shape desc.

Macros

`MK_TEXT_FEATURE_GLOBAL_END`define

MK_TEXT_FEATURE_GLOBAL_END

Constant for text feature global end.

`MK_TEXT_GLYPH_INSTANCE_DEFAULT`define

MK_TEXT_GLYPH_INSTANCE_DEFAULT

Constant for text glyph instance default.

`MK_TEXT_RUN_INVALID`define

MK_TEXT_RUN_INVALID

Invalid sentinel for text run.

`MK_TEXT_TAG`define

MK_TEXT_TAG(a, b, c, d)

Four-byte OpenType/ISO 15924 tag in HarfBuzz byte order.

shaping.h

Functions

mk_text_run_advancefunction

mk_text_run_boundsfunction

mk_text_run_buildfunction

mk_text_run_createfunction

mk_text_run_destroyfunction

mk_text_run_drawfunction

mk_text_run_draw_instancesfunction

mk_text_run_glyphfunction

mk_text_run_glyph_countfunction

mk_text_run_is_validfunction

Structs

mk_shaped_glyphstruct

mk_text_featurestruct

mk_text_glyph_instancestruct

mk_text_runstruct

mk_text_shape_descstruct

Enums

mk_shaped_glyph_flagsenum

mk_text_directionenum

mk_text_glyph_instance_flagsenum

Typedefs

mk_shaped_glyph_flags_ttypedef

mk_shaped_glyph_ttypedef

mk_text_direction_ttypedef

mk_text_feature_ttypedef

mk_text_glyph_instance_flags_ttypedef

mk_text_glyph_instance_ttypedef

mk_text_run_ttypedef

mk_text_shape_desc_ttypedef

Macros

MK_TEXT_FEATURE_GLOBAL_ENDdefine

MK_TEXT_GLYPH_INSTANCE_DEFAULTdefine

MK_TEXT_RUN_INVALIDdefine

MK_TEXT_TAGdefine

`mk_text_run_advance`function

`mk_text_run_bounds`function

`mk_text_run_build`function

`mk_text_run_create`function

`mk_text_run_destroy`function

`mk_text_run_draw`function

`mk_text_run_draw_instances`function

`mk_text_run_glyph`function

`mk_text_run_glyph_count`function

`mk_text_run_is_valid`function

`mk_shaped_glyph`struct

`mk_text_feature`struct

`mk_text_glyph_instance`struct

`mk_text_run`struct

`mk_text_shape_desc`struct

`mk_shaped_glyph_flags`enum

`mk_text_direction`enum

`mk_text_glyph_instance_flags`enum

`mk_shaped_glyph_flags_t`typedef

`mk_shaped_glyph_t`typedef

`mk_text_direction_t`typedef

`mk_text_feature_t`typedef

`mk_text_glyph_instance_flags_t`typedef

`mk_text_glyph_instance_t`typedef

`mk_text_run_t`typedef

`mk_text_shape_desc_t`typedef

`MK_TEXT_FEATURE_GLOBAL_END`define

`MK_TEXT_GLYPH_INSTANCE_DEFAULT`define

`MK_TEXT_RUN_INVALID`define

`MK_TEXT_TAG`define