shader_compiler.h

#include <modkit/shader_compiler.h>8 functions · 5 structs · 1 enums · 5 typedefs · 1 macros

Optional runtime compilation of portable bgfx .sc shader source.

Runtime compilation is enabled with MODKIT_ENABLE_RUNTIME_SHADERS. Native desktop/mobile applications use this C API; browser applications use the isolated Modkit web compiler provider. Both accept the same portable source and virtual-file model. MK_RENDERER_AUTO targets the active native renderer.

Functions

mk_shader_compilation_freefunction

void mk_shader_compilation_free(mk_shader_compilation *compilation)

Release all allocations owned by a compilation result.

Parameter	Type	Description
compilation	mk_shader_compilation *	Value for compilation.

mk_shader_compilefunction

mk_result mk_shader_compile(const mk_shader_compile_desc *desc, mk_shader_compilation *out_compilation)

Blocking compiler entry point.

Parameter	Type	Description
desc	const mk_shader_compile_desc *	Configuration descriptor.
out_compilation	mk_shader_compilation *	Receives the compilation.

Returns MK_SUCCESS or an error result.

mk_shader_compile_asyncfunction

mk_shader_compile_request_t mk_shader_compile_async(const mk_shader_compile_desc *desc)

Queue a compilation after copying all descriptor data.

Parameter	Type	Description
desc	const mk_shader_compile_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_shader_compile_cancelfunction

void mk_shader_compile_cancel(mk_shader_compile_request_t request)

Request cancellation.

Parameter	Type	Description
request	mk_shader_compile_request_t	Value for request.

mk_shader_compile_pollfunction

mk_shader_compile_state_t mk_shader_compile_poll(mk_shader_compile_request_t request)

Query without blocking.

Parameter	Type	Description
request	mk_shader_compile_request_t	Value for request.

Returns The resulting handle or value.

mk_shader_compile_request_destroyfunction

void mk_shader_compile_request_destroy(mk_shader_compile_request_t request)

Release a queued/completed request without taking its result.

Parameter	Type	Description
request	mk_shader_compile_request_t	Value for request.

mk_shader_compile_take_resultfunction

mk_result mk_shader_compile_take_result(mk_shader_compile_request_t request, mk_shader_compilation *out_compilation)

Move a completed result to the caller and invalidate the request.

Failed compilations still return their owned diagnostic string.

Parameter	Type	Description
request	mk_shader_compile_request_t	Value for request.
out_compilation	mk_shader_compilation *	Receives the compilation.

Returns MK_SUCCESS or an error result.

mk_shader_compiler_availablefunction

bool mk_shader_compiler_available(void)

True when this build contains a compiler provider for its target.

Returns True when the operation succeeds.

Structs

mk_shader_compilationstruct

Owned result.

Release with mk_shader_compilation_free().

Field	Type	Description
renderer	mk_renderer_type_t	The renderer.
vertex	mk_shader_compiled_blob	The vertex.
fragment	mk_shader_compiled_blob	The fragment.
compute	mk_shader_compiled_blob	The compute.
diagnostics	char *	The diagnostics.

mk_shader_compile_descstruct

A graphics program supplies vertex + fragment source.

A compute program supplies compute source and leaves vertex/fragment NULL.

Field	Type	Description
name	const char *	The name.
renderer	mk_renderer_type_t	AUTO selects the active renderer.
vertex_path	const char *	The vertex path.
vertex_source	const void *	The vertex source.
vertex_size	uint32_t	The vertex size.
fragment_path	const char *	The fragment path.
fragment_source	const void *	The fragment source.
fragment_size	uint32_t	The fragment size.
compute_path	const char *	The compute path.
compute_source	const void *	The compute source.
compute_size	uint32_t	The compute size.
varying_path	const char *	The varying path.
varying_source	const void *	The varying source.
varying_size	uint32_t	The varying size.
files	const mk_shader_source_file *	The files.
file_count	uint32_t	The file count.
defines	const char *const *	The defines.
define_count	uint32_t	The define count.
optimization_level	uint8_t	0 selects default 3; 1..3 are explicit.
debug_information	bool	The debug information.
warnings_are_errors	bool	The warnings are errors.

mk_shader_compile_request_tstruct

Data for shader compile request.

Field	Type	Description
id	uint32_t	The ID.

mk_shader_compiled_blobstruct

Data for shader compiled blob.

Field	Type	Description
data	void *	The data.
size	uint32_t	The size.

mk_shader_source_filestruct

One file visible to shader include directives.

Paths must be relative.

Field	Type	Description
path	const char *	The path.
data	const void *	The data.
size	uint32_t	Zero treats data as a null-terminated UTF-8 string.

Enums

mk_shader_compile_stateenum

Values for shader compile state.

Value	Description
MK_SHADER_COMPILE_INVALID	Selects invalid.
MK_SHADER_COMPILE_QUEUED	Selects queued.
MK_SHADER_COMPILE_RUNNING	Selects running.
MK_SHADER_COMPILE_SUCCEEDED	Selects succeeded.
MK_SHADER_COMPILE_FAILED	Selects failed.
MK_SHADER_COMPILE_CANCELLED	Selects cancelled.

Typedefs

mk_shader_compilationtypedef

typedef struct mk_shader_compilation mk_shader_compilation

Owned result.

Release with mk_shader_compilation_free().

mk_shader_compile_desctypedef

typedef struct mk_shader_compile_desc mk_shader_compile_desc

A graphics program supplies vertex + fragment source.

A compute program supplies compute source and leaves vertex/fragment NULL.

mk_shader_compile_state_ttypedef

typedef enum mk_shader_compile_state mk_shader_compile_state_t

Values for shader compile state.

mk_shader_compiled_blobtypedef

typedef struct mk_shader_compiled_blob mk_shader_compiled_blob

Data for shader compiled blob.

mk_shader_source_filetypedef

typedef struct mk_shader_source_file mk_shader_source_file

One file visible to shader include directives.

Paths must be relative.

Macros

MK_SHADER_COMPILE_REQUEST_INVALIDdefine

MK_SHADER_COMPILE_REQUEST_INVALID

Invalid sentinel for shader compile request.