canvas_layer.h

#include <modkit/canvas_layer.h>13 functions · 1 structs · 2 enums · 4 typedefs · 1 macros

Retained offscreen Canvas layers for UI compositing.

Functions

mk_canvas_layer_beginfunction

mk_canvas_t mk_canvas_layer_begin(mk_canvas_layer_t *layer, uint32_t clear_color)

Begin an offscreen pass and return the layer-owned Canvas.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.
clear_color	uint32_t	Value for clear color.

Returns The resulting handle or value.

mk_canvas_layer_capabilitiesfunction

uint32_t mk_canvas_layer_capabilities(void)

Perform the canvas layer capabilities operation.

Returns The resulting value.

mk_canvas_layer_createfunction

mk_canvas_layer_t * mk_canvas_layer_create(const mk_canvas_layer_desc_t *desc)

Create canvas layer.

Parameter	Type	Description
desc	const mk_canvas_layer_desc_t *	Configuration descriptor.

Returns A borrowed pointer, or NULL when unavailable.

mk_canvas_layer_desc_initfunction

void mk_canvas_layer_desc_init(mk_canvas_layer_desc_t *desc)

Initialize the canvas layer desc.

Parameter	Type	Description
desc	mk_canvas_layer_desc_t *	Configuration descriptor.

mk_canvas_layer_drawfunction

mk_result mk_canvas_layer_draw(mk_canvas_layer_t *layer, mk_canvas_t destination, float x, float y, float width, float height)

Composite the layer into an already active destination Canvas.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.
destination	mk_canvas_t	Value for destination.
x	float	Value for x.
y	float	Value for y.
width	float	Value for width.
height	float	Value for height.

Returns MK_SUCCESS or an error result.

mk_canvas_layer_endfunction

mk_result mk_canvas_layer_end(mk_canvas_layer_t *layer)

End canvas layer.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.

Returns MK_SUCCESS or an error result.

mk_canvas_layer_invalidatefunction

void mk_canvas_layer_invalidate(mk_canvas_layer_t *layer)

Perform the canvas layer invalidate operation.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.

mk_canvas_layer_is_validfunction

bool mk_canvas_layer_is_valid(const mk_canvas_layer_t *layer)

Test whether the canvas layer is valid.

Parameter	Type	Description
layer	const mk_canvas_layer_t *	Value for layer.

Returns True when the condition holds.

mk_canvas_layer_needs_redrawfunction

bool mk_canvas_layer_needs_redraw(const mk_canvas_layer_t *layer)

Perform the canvas layer needs redraw operation.

Parameter	Type	Description
layer	const mk_canvas_layer_t *	Value for layer.

Returns True when the operation succeeds.

mk_canvas_layer_releasefunction

void mk_canvas_layer_release(mk_canvas_layer_t *layer)

Release canvas layer.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.

mk_canvas_layer_resizefunction

mk_result mk_canvas_layer_resize(mk_canvas_layer_t *layer, float width, float height, float content_scale)

Resize the canvas layer.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.
width	float	Value for width.
height	float	Value for height.
content_scale	float	Value for content scale.

Returns MK_SUCCESS or an error result.

mk_canvas_layer_retainfunction

mk_canvas_layer_t * mk_canvas_layer_retain(mk_canvas_layer_t *layer)

Retain canvas layer.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.

Returns A borrowed pointer, or NULL when unavailable.

mk_canvas_layer_set_opacityfunction

void mk_canvas_layer_set_opacity(mk_canvas_layer_t *layer, float opacity)

Set opacity on the canvas layer.

Parameter	Type	Description
layer	mk_canvas_layer_t *	Value for layer.
opacity	float	Value for opacity.

Structs

mk_canvas_layer_descstruct

Data for canvas layer desc.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
width	float	The width.
height	float	The height.
content_scale	float	The content scale.
opacity	float	The opacity.
blur_radius	float	The blur radius.
backdrop_blur_radius	float	The backdrop blur radius.
manual_invalidation	bool	The manual invalidation.
filter_fallback	mk_canvas_layer_filter_fallback_t	The filter fallback.

Enums

mk_canvas_layer_capabilityenum

Values for canvas layer capability.

Value	Description
MK_CANVAS_LAYER_CAP_BLUR	Selects blur.
MK_CANVAS_LAYER_CAP_BACKDROP_BLUR	Selects backdrop blur.

mk_canvas_layer_filter_fallbackenum

Values for canvas layer filter fallback.

Value	Description
MK_CANVAS_LAYER_FILTER_UNFILTERED	Selects canvas layer filter unfiltered.

Typedefs

mk_canvas_layer_capability_ttypedef

typedef enum mk_canvas_layer_capability mk_canvas_layer_capability_t

Values for canvas layer capability.

mk_canvas_layer_desc_ttypedef

typedef struct mk_canvas_layer_desc mk_canvas_layer_desc_t

Data for canvas layer desc.

mk_canvas_layer_filter_fallback_ttypedef

typedef enum mk_canvas_layer_filter_fallback mk_canvas_layer_filter_fallback_t

Values for canvas layer filter fallback.

mk_canvas_layer_ttypedef

typedef struct mk_canvas_layer_s mk_canvas_layer_t

Type used for canvas layer.

Macros

MK_CANVAS_LAYER_DESC_VERSIONdefine

MK_CANVAS_LAYER_DESC_VERSION

ABI or format version for canvas layer desc.