types.h

#include <modkit/types.h>1 functions · 4 structs · 2 enums · 6 typedefs · 12 macros

Core types and definitions for modkit.

Functions

mk_color_to_abgrfunction

uint32_t mk_color_to_abgr(mk_color c)

Perform the color to abgr operation.

Parameter	Type	Description
c	mk_color	Value for c.

Returns The resulting value.

Structs

mk_colorstruct

Data for color.

Field	Type	Description
r	uint8_t	Red channel.
g	uint8_t	Green channel.
b	uint8_t	Blue channel.
a	uint8_t	Alpha channel.

mk_insetsstruct

Data for insets.

Field	Type	Description
left	int32_t	Left inset.
top	int32_t	Top inset.
right	int32_t	Right inset.
bottom	int32_t	Bottom inset.

mk_rectstruct

Data for rect.

Field	Type	Description
x	int32_t	Left coordinate.
y	int32_t	Top coordinate.
width	int32_t	Width.
height	int32_t	Height.

mk_rectfstruct

Data for rectf.

Field	Type	Description
x	float	Left coordinate.
y	float	Top coordinate.
width	float	Width.
height	float	Height.

Enums

mk_color_space_tenum

Values for color space.

Value	Description
MK_COLOR_SPACE_AUTO	Selects auto.
MK_COLOR_SPACE_LINEAR	Selects linear.
MK_COLOR_SPACE_SRGB	Selects srgb.

mk_resultenum

Values for result.

Value	Description
MK_SUCCESS	Selects success.
MK_ERROR_INIT_FAILED	Selects error init failed.
MK_ERROR_WINDOW_FAILED	Selects error window failed.
MK_ERROR_RENDERER_FAILED	Selects error renderer failed.
MK_ERROR_OUT_OF_MEMORY	Selects error out of memory.
MK_ERROR_INVALID_ARGUMENT	Selects error invalid argument.
MK_ERROR_VIEW_EXHAUSTED	Selects error view exhausted.
MK_ERROR_NOT_INITIALIZED	Selects error not initialized.
MK_ERROR_MATERIAL_TABLE_CAPACITY	Selects error material table capacity.
MK_ERROR_UNSUPPORTED_PBR_VARIANT	Selects error unsupported PBR variant.
MK_ERROR_VIEW_BUDGET	Selects error view budget.
MK_ERROR_UNSUPPORTED	Selects error unsupported.
MK_ERROR_INVALID_STATE	Selects error invalid state.
MK_ERROR_RESOURCE_PENDING	Selects error resource pending.
MK_ERROR_RESOURCE_CYCLE	Selects error resource cycle.
MK_ERROR_RENDER_WORLD_CONFLICT	Selects error render world conflict.
MK_ERROR_DRAW_BINDING_CAPACITY	Selects error draw binding capacity.
MK_ERROR_DRAW_BINDING_CONFLICT	Selects error draw binding conflict.
MK_ERROR_DRAW_BINDING_TYPE	Selects error draw binding type.
MK_ERROR_PERMISSION_DENIED	Selects error permission denied.
MK_ERROR_DEVICE_UNAVAILABLE	Selects error device unavailable.
MK_ERROR_QUEUE_FULL	Selects error queue full.
MK_ERROR_DECODE_FAILED	Selects error decode failed.
MK_ERROR_IO	Selects error I/O.
MK_ERROR_SHADER_COMPILE	Selects error shader compile.
MK_ERROR_CANCELLED	Selects error cancelled.
MK_ERROR_MESSAGE_TOO_LARGE	Selects error message too large.

Typedefs

mk_colortypedef

typedef struct mk_color mk_color

Data for color.

mk_color_space_ttypedef

typedef enum mk_color_space_t mk_color_space_t

Values for color space.

mk_insetstypedef

typedef struct mk_insets mk_insets

Data for insets.

mk_recttypedef

typedef struct mk_rect mk_rect

Data for rect.

mk_rectftypedef

typedef struct mk_rectf mk_rectf

Data for rectf.

mk_resulttypedef

typedef enum mk_result mk_result

Values for result.

Macros

MK_ABGRdefine

MK_ABGR(r, g, b, a)

Pack r,g,b,a (0-255) as 0xAABBGGRR bgfx vertex-color order.

MK_COLORdefine

MK_COLOR(r, g, b, a)

Constant for color.

MK_COLOR_BLACKdefine

MK_COLOR_BLACK

Constant for color black.

MK_COLOR_BLUEdefine

MK_COLOR_BLUE

Constant for color blue.

MK_COLOR_CORNFLOWER_BLUEdefine

MK_COLOR_CORNFLOWER_BLUE

Constant for color cornflower blue.

MK_COLOR_GREENdefine

MK_COLOR_GREEN

Constant for color green.

MK_COLOR_REDdefine

MK_COLOR_RED

Constant for color red.

MK_COLOR_WHITEdefine

MK_COLOR_WHITE

Constant for color white.

MK_DEPRECATEDdefine

MK_DEPRECATED(msg)

Constant for deprecated.

MK_RGBdefine

MK_RGB(r, g, b)

Pack r,g,b (0-255) as 0xRRGGBBFF (opaque) modkit API color order.

MK_RGBAdefine

MK_RGBA(r, g, b, a)

Pack r,g,b,a (0-255) as 0xRRGGBBAA modkit API color order.

MODKIT_APIdefine

MODKIT_API

Constant for modkit API.