clay.h

#include <modkit/clay.h>9 functions · 3 structs · 5 typedefs · 1 macros

Optional Clay v0.14 layout bridge.

This header intentionally re-exports upstream Clay. Include it explicitly when using Clay's public types and declarative macros.

Functions

mk_clay_begin_layoutfunction

bool mk_clay_begin_layout(mk_clay_t clay, const mk_clay_frame_desc *frame)

Begin a wrapper layout.

A null frame descriptor reads the main window, mouse, scroll, and frame delta. The matching end call restores the Clay context that was active before this call.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.
frame	const mk_clay_frame_desc *	Value for frame.

Returns True when the operation succeeds.

mk_clay_contextfunction

Clay_Context * mk_clay_context(mk_clay_t clay)

Perform the clay context operation.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.

Returns A borrowed pointer, or NULL when unavailable.

mk_clay_createfunction

mk_clay_t mk_clay_create(const mk_clay_desc *desc)

Create clay.

Parameter	Type	Description
desc	const mk_clay_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_clay_desc_initfunction

mk_clay_desc mk_clay_desc_init(void)

Initialize the clay desc.

Returns The resulting value.

mk_clay_destroyfunction

void mk_clay_destroy(mk_clay_t clay)

Destroy the clay.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.

mk_clay_end_layoutfunction

Clay_RenderCommandArray mk_clay_end_layout(mk_clay_t clay)

End layout.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.

Returns The resulting value.

mk_clay_renderfunction

bool mk_clay_render(mk_clay_t clay, Clay_RenderCommandArray commands)

Render an emitted Clay command array through the active Modkit pass.

Commands retain Clay's painter order across Canvas and font batches.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.
commands	Clay_RenderCommandArray	Value for commands.

Returns True when the operation succeeds.

mk_clay_reset_text_cachefunction

void mk_clay_reset_text_cache(mk_clay_t clay)

Reset the text cache for the clay.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.

mk_clay_set_fontfunction

bool mk_clay_set_font(mk_clay_t clay, uint16_t font_id, mk_font_t font)

Set font on the clay.

Parameter	Type	Description
clay	mk_clay_t	Value for clay.
font_id	uint16_t	Value for font ID.
font	mk_font_t	Value for font.

Returns True when the operation succeeds.

Structs

mk_clay_descstruct

Data for clay desc.

Field	Type	Description
arena_capacity	size_t	The arena capacity.
max_element_count	int32_t	The max element count.
max_measure_text_cache_word_count	int32_t	The max measure text cache word count.
custom_command_callback	mk_clay_custom_command_callback	The custom command callback.
user_data	void *	The user data.

mk_clay_frame_descstruct

Data for clay frame desc.

Field	Type	Description
width	float	The width.
height	float	The height.
pointer_x	float	The pointer x.
pointer_y	float	The pointer y.
pointer_down	bool	The pointer down.
scroll_x	float	The scroll x.
scroll_y	float	The scroll y.
delta_time	float	The delta time.
enable_drag_scrolling	bool	The enable drag scrolling.

mk_clay_imagestruct

Data for clay image.

Field	Type	Description
texture	mk_texture_t	The texture.
uv	mk_rectf	The UV.
tint	uint32_t	The tint.

Typedefs

mk_clay_custom_command_callbacktypedef

typedef void(*) mk_clay_custom_command_callback(mk_canvas_t canvas, const Clay_RenderCommand *command, void *user_data)

Callback used for clay custom command callback.

mk_clay_desctypedef

typedef struct mk_clay_desc mk_clay_desc

Data for clay desc.

mk_clay_frame_desctypedef

typedef struct mk_clay_frame_desc mk_clay_frame_desc

Data for clay frame desc.

mk_clay_image_ttypedef

typedef struct mk_clay_image mk_clay_image_t

Data for clay image.

mk_clay_ttypedef

typedef struct mk_clay* mk_clay_t

Type used for clay.

Macros

MK_CLAY_INVALIDdefine

MK_CLAY_INVALID

Invalid sentinel for clay.