post.h

#include <modkit/post.h>5 functions · 3 structs · 3 typedefs

Post-processing package (opt-in).

An OPT-IN package (MODKIT_ENABLE_POST, default OFF). Explicit post FX applied as fullscreen passes over a linear HDR scene target. Bloom stays linear HDR; tone mapping produces linear LDR; grading, vignette, and FXAA remain linear LDR; and mk_post_present performs the sole display conversion. Typical use (explicit / app-wired) render the scene into a linear HDR target, then tone map and present it:

Functions

mk_post_bloomfunction

mk_texture_t mk_post_bloom(mk_texture_t hdr_src, const mk_bloom_params *params)

Generate a bloom texture from a linear HDR source (dual-filter pyramid: soft-knee prefilter -> downsample chain -> additive tent upsample).

The returned texture is owned by the package (a half-resolution, auto-resizing internal target reused across frames) do NOT destroy it. Sample it via the tone-map composite: pass it as mk_post_tonemap_params.bloom. Lazily self-initializes. Returns MK_TEXTURE_INVALID on failure / invalid source.

Parameter	Type	Description
hdr_src	mk_texture_t	Linear HDR scene texture (e.g. an RGBA16F scene target's color).
params	const mk_bloom_params *	Bloom threshold/knee/levels (NULL = sensible defaults).

Returns Bloom texture to feed into mk_post_tonemap_linear, or MK_TEXTURE_INVALID.

mk_post_fxaa_linearfunction

mk_result mk_post_fxaa_linear(mk_texture_t ldr_src, mk_render_target_t dst)

Anti-alias a linear LDR image with FXAA into another linear target.

Parameter	Type	Description
ldr_src	mk_texture_t	Linear post-tonemap texture to anti-alias.
dst	mk_render_target_t	Linear destination render target.

Returns MK_SUCCESS or a validation/initialization error.

mk_post_grade_linearfunction

mk_result mk_post_grade_linear(mk_texture_t ldr_src, mk_render_target_t dst, const mk_post_grade_params *params)

Apply an optional 3D LUT and vignette to linear LDR.

This stage remains linear and belongs between tone mapping and FXAA/present. An invalid LUT uses an identity transform, allowing vignette-only use.

Parameter	Type	Description
ldr_src	mk_texture_t	Value for ldr src.
dst	mk_render_target_t	Value for dst.
params	const mk_post_grade_params *	Value for params.

Returns MK_SUCCESS or an error result.

mk_post_presentfunction

mk_result mk_post_present(mk_texture_t linear_src, mk_render_target_t dst, mk_color_space_t output_color_space)

Present a linear LDR texture with exactly one requested output conversion.

AUTO derives offscreen output from target metadata and requests sRGB for the backbuffer. An sRGB destination uses hardware conversion from a linear shader write. A linear destination requested as sRGB uses shader encoding. Requesting linear output for an sRGB destination is invalid.

Parameter	Type	Description
linear_src	mk_texture_t	Linear LDR texture.
dst	mk_render_target_t	Destination target; MK_RENDER_TARGET_INVALID selects the backbuffer.
output_color_space	mk_color_space_t	AUTO, LINEAR, or SRGB.

Returns MK_SUCCESS or a validation/initialization error.

mk_post_tonemap_linearfunction

mk_result mk_post_tonemap_linear(mk_texture_t hdr_src, mk_render_target_t dst, const mk_post_tonemap_params *params)

Composite optional bloom and tone map an HDR source into linear LDR.

dst must be a linear render target. Display encoding is deliberately excluded; pass the resulting texture to mk_post_fxaa_linear or mk_post_present. NULL params uses Reinhard at exposure 1.0 with no bloom.

Parameter	Type	Description
hdr_src	mk_texture_t	Linear HDR texture (e.g. an RGBA16F scene target's color attachment).
dst	mk_render_target_t	Linear destination render target.
params	const mk_post_tonemap_params *	Tonemap operator, exposure, and optional bloom.

Returns MK_SUCCESS or a validation/initialization error.

Structs

mk_bloom_paramsstruct

Bloom configuration (dual-filter pyramid).

Field	Type	Description
threshold	float	Soft-knee luminance threshold (default ~1.0).
knee	float	Soft-knee width around the threshold (default ~0.5).
mips	int	Pyramid level count (<=0 => default 6; clamped to resolution).

mk_post_grade_paramsstruct

Linear-LDR color grading and vignette configuration.

Field	Type	Description
lut	mk_texture_t	Optional cubic 3D LUT authored for linear LDR.
vignette	float	Radial vignette strength 0..1.

mk_post_tonemap_paramsstruct

Tonemap pass configuration.

Field	Type	Description
op	int	Operator: mk_tonemap_op.
exposure	float	Linear exposure multiplier applied before tonemap (<=0 => 1.0).
bloom	mk_texture_t	Optional bloom texture (mk_post_bloom result); MK_TEXTURE_INVALID = none.
bloom_intensity	float	Linear weight for the bloom add (e.g.

Typedefs

mk_bloom_paramstypedef

typedef struct mk_bloom_params mk_bloom_params

Bloom configuration (dual-filter pyramid).

mk_post_grade_paramstypedef

typedef struct mk_post_grade_params mk_post_grade_params

Linear-LDR color grading and vignette configuration.

mk_post_tonemap_paramstypedef

typedef struct mk_post_tonemap_params mk_post_tonemap_params

Tonemap pass configuration.