render_graph.h

#include <modkit/render_graph.h>10 functions · 3 structs · 5 typedefs · 3 macros

Optional ordered render graph orchestration over mk_pass_desc.

The render graph owns or imports named render targets and executes pass callbacks in registration order. Read/write declarations are validated and document dependencies; v1 does not reorder passes, alias resources, or impose renderer policy.

Functions

mk_graph_add_passfunction

mk_result mk_graph_add_pass(mk_render_graph_t graph, const mk_graph_pass_desc *desc)

Append an ordered pass declaration.

Parameter	Type	Description
graph	mk_render_graph_t	Destination graph.
desc	const mk_graph_pass_desc *	Pass descriptor.

Returns MK_SUCCESS or an error result.

mk_graph_add_targetfunction

mk_result mk_graph_add_target(mk_render_graph_t graph, const char *name, const mk_render_target_desc *desc)

Add a graph-owned named render target.

Parameter	Type	Description
graph	mk_render_graph_t	Destination graph.
name	const char *	Stable target name.
desc	const mk_render_target_desc *	Target descriptor.

Returns MK_SUCCESS or an error result.

mk_graph_destroyfunction

void mk_graph_destroy(mk_render_graph_t graph)

Destroy a graph and its graph-owned targets.

Parameter	Type	Description
graph	mk_render_graph_t	Graph to destroy.

mk_graph_executefunction

mk_result mk_graph_execute(mk_render_graph_t graph, void *frame_user_data)

Execute every registered pass in declaration order.

Parameter	Type	Description
graph	mk_render_graph_t	Graph to execute.
frame_user_data	void *	Per-execution user pointer forwarded to callbacks.

Returns MK_SUCCESS or an error result.

mk_graph_get_depth_texturefunction

mk_texture_t mk_graph_get_depth_texture(mk_render_graph_t graph, const char *name)

Look up the depth attachment on a named target.

Parameter	Type	Description
graph	mk_render_graph_t	Graph to query.
name	const char *	Target name.

Returns The depth texture handle, or an invalid handle when unavailable.

mk_graph_get_targetfunction

mk_render_target_t mk_graph_get_target(mk_render_graph_t graph, const char *name)

Look up a named render target.

Parameter	Type	Description
graph	mk_render_graph_t	Graph to query.
name	const char *	Target name.

Returns The target handle, or an invalid handle when absent.

mk_graph_get_texturefunction

mk_texture_t mk_graph_get_texture(mk_render_graph_t graph, const char *name, uint8_t attachment)

Look up a color attachment on a named target.

Parameter	Type	Description
graph	mk_render_graph_t	Graph to query.
name	const char *	Target name.
attachment	uint8_t	Color attachment index.

Returns The texture handle, or an invalid handle when unavailable.

mk_graph_import_targetfunction

mk_result mk_graph_import_target(mk_render_graph_t graph, const char *name, mk_render_target_t target)

Import an externally owned named render target.

Parameter	Type	Description
graph	mk_render_graph_t	Destination graph.
name	const char *	Stable target name.
target	mk_render_target_t	Existing target handle.

Returns MK_SUCCESS or an error result.

mk_graph_resizefunction

void mk_graph_resize(mk_render_graph_t graph)

Resize graph-owned relative-size targets to the current output.

Parameter	Type	Description
graph	mk_render_graph_t	Graph to update.

mk_render_graph_createfunction

mk_render_graph_t mk_render_graph_create(const mk_render_graph_desc *desc)

Create an empty ordered render graph.

Parameter	Type	Description
desc	const mk_render_graph_desc *	Optional creation options.

Returns A graph handle, or NULL on failure.

Structs

mk_graph_pass_ctxstruct

Runtime resources exposed while recording a graph pass.

Field	Type	Description
graph	mk_render_graph_t	Executing graph.
pass	const mk_pass_desc *	Resolved pass descriptor.
encoder	mk_encoder_t	Encoder for pass draw commands.
view	mk_view_id_t	View assigned to the pass.
target	mk_render_target_t	Resolved target, or the backbuffer handle.
width	uint16_t	Render width in pixels.
height	uint16_t	Render height in pixels.
graph_user_data	void *	User data from mk_render_graph_desc.
frame_user_data	void *	User data supplied to mk_graph_execute.
pass_user_data	void *	User data from mk_graph_pass_desc.

mk_graph_pass_descstruct

Declaration and callback for one ordered render-graph pass.

Field	Type	Description
name	const char *	Pass name (optional).
target	const char *	Named target to render to; NULL = backbuffer.
pass	mk_pass_desc	Base pass descriptor; graph resolves target.
reads	const char *	Named targets sampled/read.
read_count	uint8_t	Number of valid entries in reads.
writes	const char *	Named targets written.
write_count	uint8_t	Number of valid entries in writes.
callback	mk_graph_pass_fn	Called inside mk_begin_pass/mk_end_pass.
user_data	void *	Pass-level user data forwarded to callback.

mk_render_graph_descstruct

Render-graph creation options.

Field	Type	Description
name	const char *	Debug name (optional).
user_data	void *	Graph-level user data forwarded to callbacks.

Typedefs

mk_graph_pass_ctxtypedef

typedef struct mk_graph_pass_ctx mk_graph_pass_ctx

Context passed to a render-graph pass callback.

mk_graph_pass_desctypedef

typedef struct mk_graph_pass_desc mk_graph_pass_desc

Declaration and callback for one ordered render-graph pass.

mk_graph_pass_fntypedef

typedef void(*) mk_graph_pass_fn(const mk_graph_pass_ctx *ctx)

Record drawing commands for one graph pass.

mk_render_graph_desctypedef

typedef struct mk_render_graph_desc mk_render_graph_desc

Render-graph creation options.

mk_render_graph_ttypedef

typedef struct mk_render_graph* mk_render_graph_t

Opaque render-graph handle.

Macros

MK_GRAPH_MAX_DEPSdefine

MK_GRAPH_MAX_DEPS

Maximum declared reads or writes for one pass.

MK_GRAPH_MAX_PASSESdefine

MK_GRAPH_MAX_PASSES

Maximum passes in one render graph.

MK_GRAPH_MAX_TARGETSdefine

MK_GRAPH_MAX_TARGETS

Maximum named targets in one render graph.