lighting.h

#include <modkit/lighting.h>14 functions · 2 structs · 4 enums · 6 typedefs · 3 macros

Frame-level lighting environment (separate from materials).

Materials own no lights. Lighting is a persistent, transactionally replaced list snapshotted at frame begin. A default directional headlight remains active until the application explicitly mutates the direct-light list.

Functions

`mk_light_distance_attenuation`function

float mk_light_distance_attenuation(float distance, float range)

CPU mirrors of the shader's glTF punctual attenuation rules.

Parameter	Type	Description
`distance`	`float`	Value for distance.
`range`	`float`	Value for range.

Returns The resulting value.

`mk_light_spot_attenuation`function

float mk_light_spot_attenuation(float actual_cosine, float inner_cone_angle, float outer_cone_angle)

Perform the light spot attenuation operation.

Parameter	Type	Description
`actual_cosine`	`float`	Value for actual cosine.
`inner_cone_angle`	`float`	Value for inner cone angle.
`outer_cone_angle`	`float`	Value for outer cone angle.

Returns The resulting value.

`mk_lighting_apply`function

void mk_lighting_apply(struct mk_draw_desc *out)

Apply lighting.

Parameter	Type	Description
`out`	`struct mk_draw_desc *`	Value for out.

`mk_lighting_frame_begin`function

void mk_lighting_frame_begin(void)

Begin lighting frame.

`mk_lighting_get_stats`function

void mk_lighting_get_stats(mk_lighting_stats *out)

Copy current lighting statistics.

Parameter	Type	Description
`out`	`mk_lighting_stats *`	Value for out.

`mk_lighting_system_init`function

void mk_lighting_system_init(void)

Initialize the lighting system.

`mk_lighting_system_shutdown`function

void mk_lighting_system_shutdown(void)

Perform the lighting system shutdown operation.

`mk_lights_effective_forward_capacity`function

uint32_t mk_lights_effective_forward_capacity(void)

Effective bounded-forward capacity for this build/backend profile.

Returns The resulting value.

`mk_lights_set`function

bool mk_lights_set(const mk_light_desc *lights, uint16_t count)

Transactionally replace the persistent direct-light list.

This function is thread-safe; the new generation becomes visible at the next frame begin. Passing NULL, 0 explicitly disables direct lighting.

Parameter	Type	Description
`lights`	`const mk_light_desc *`	Value for lights.
`count`	`uint16_t`	Number of entries.

Returns True when the operation succeeds.

`mk_set_ambient`function

void mk_set_ambient(uint32_t ambient)

Set just the ambient term (0xRRGGBBAA, alpha ignored).

Parameter	Type	Description
`ambient`	`uint32_t`	Value for ambient.

`mk_set_clearcoat_enabled`function

void mk_set_clearcoat_enabled(bool enabled)

Frame-global toggle for the PBR clearcoat lobe (KHR_materials_clearcoat).

Default on; disabling zeroes the effective clearcoat factor in-shader for ALL materials,

Parameter	Type	Description
`enabled`	`bool`	Whether the feature is enabled. so you can A/B the coating without editing assets. A viewer/debug aid.

`mk_set_debug_view`function

void mk_set_debug_view(int channel)

Frame-global debug visualization channel (0 = off / normal shading).

The PBR shader interprets the value to render a single surface input (base color, normal, metallic, roughness, AO, the IBL terms, etc.) instead of the lit result a glTF-viewer-style inspector. Channel IDs are in pbr.h

Parameter	Type	Description
`channel`	`int`	Value for channel. (mk_pbr_debug_channel). Materials that don't implement debug ignore it.

`mk_set_light`function

void mk_set_light(mk_vec3 dir, uint32_t color, uint32_t ambient)

Set the directional light.

dir is the direction the light travels (e.g. pointing down/forward). color/ambient are packed 0xRRGGBBAA (the modkit color

Parameter	Type	Description
`dir`	`mk_vec3`	Value for dir.
`color`	`uint32_t`	Value for color.
`ambient`	`uint32_t`	Value for ambient. convention); the alpha byte is ignored, so white is 0xFFFFFFFF.

`mk_set_sheen_enabled`function

void mk_set_sheen_enabled(bool enabled)

Frame-global toggle for KHR_materials_sheen.

Parameter	Type	Description
`enabled`	`bool`	Whether the feature is enabled.

Structs

`mk_light_desc`struct

World-space punctual light.

A range of zero means infinite/omitted.

Field	Type	Description
`type`	`mk_light_type`	The type.
`flags`	`uint32_t`	The flags.
`color`	`float`	The color.
`intensity`	`float`	The intensity.
`position`	`float`	The position.
`range`	`float`	The range.
`direction`	`float`	The direction.
`inner_cone_angle`	`float`	The inner cone angle.
`outer_cone_angle`	`float`	The outer cone angle.
`priority`	`int32_t`	The priority.

`mk_lighting_stats`struct

Data for lighting stats.

Field	Type	Description
`staged_generation`	`uint64_t`	The staged generation.
`frame_generation`	`uint64_t`	The frame generation.
`shadow_light_generation`	`uint64_t`	The shadow light generation.
`submitted_lights`	`uint32_t`	The submitted lights.
`enabled_lights`	`uint32_t`	The enabled lights.
`effective_forward_capacity`	`uint32_t`	The effective forward capacity.
`forward_selected`	`uint32_t`	The forward selected.
`forward_truncated`	`uint32_t`	The forward truncated.
`shadow_requested`	`uint32_t`	The shadow requested.
`shadow_rendered`	`uint32_t`	The shadow rendered.
`shadow_downscaled`	`uint32_t`	The shadow downscaled.
`shadow_dropped`	`uint32_t`	The shadow dropped.
`shadow_stale_key`	`uint32_t`	The shadow stale key.
`shadow_sampler_limited`	`uint32_t`	The shadow sampler limited.
`shadow_missing_distance`	`uint32_t`	The shadow missing distance.
`cluster_overflow_clusters`	`uint32_t`	The cluster overflow clusters.
`cluster_dropped_indices`	`uint32_t`	The cluster dropped indices.
`legacy_pbr_downgrades`	`uint32_t`	The legacy PBR downgrades.
`path`	`mk_lighting_path`	The path.
`fallback_reason`	`mk_lighting_fallback_reason`	The fallback reason.
`shadow_depth_mode`	`uint8_t`	The shadow depth mode.
`implicit_default_headlight`	`bool`	The implicit default headlight.
`shadow_reused`	`bool`	The shadow reused.

Enums

`mk_light_flags`enum

Values for light flags.

Value	Description
`MK_LIGHT_ENABLED`	Selects enabled.
`MK_LIGHT_CAST_SHADOWS`	Selects cast shadows.

`mk_light_type`enum

Values for light type.

Value	Description
`MK_LIGHT_DIRECTIONAL`	Selects directional.
`MK_LIGHT_POINT`	Selects point.
`MK_LIGHT_SPOT`	Selects spot.

`mk_lighting_fallback_reason`enum

Values for lighting fallback reason.

Value	Description
`MK_LIGHTING_FALLBACK_NONE`	Selects none.
`MK_LIGHTING_FALLBACK_UNSUPPORTED`	Selects unsupported.
`MK_LIGHTING_FALLBACK_ALLOCATION`	Selects allocation.
`MK_LIGHTING_FALLBACK_SHADER`	Selects shader.
`MK_LIGHTING_FALLBACK_CAMERA`	Selects camera.
`MK_LIGHTING_FALLBACK_DISPATCH`	Selects dispatch.
`MK_LIGHTING_FALLBACK_CAPACITY`	Selects capacity.

`mk_lighting_path`enum

Values for lighting path.

Value	Description
`MK_LIGHTING_PATH_FORWARD`	Selects forward.
`MK_LIGHTING_PATH_CLUSTERED`	Selects clustered.

Typedefs

`mk_light_desc`typedef

typedef struct mk_light_desc mk_light_desc

World-space punctual light.

A range of zero means infinite/omitted.

`mk_light_flags`typedef

typedef enum mk_light_flags mk_light_flags

Values for light flags.

`mk_light_type`typedef

typedef enum mk_light_type mk_light_type

Values for light type.

`mk_lighting_fallback_reason`typedef

typedef enum mk_lighting_fallback_reason mk_lighting_fallback_reason

Values for lighting fallback reason.

`mk_lighting_path`typedef

typedef enum mk_lighting_path mk_lighting_path

Values for lighting path.

`mk_lighting_stats`typedef

typedef struct mk_lighting_stats mk_lighting_stats

Data for lighting stats.

Macros

`MODKIT_GL21_FORWARD_LIGHTS`define

MODKIT_GL21_FORWARD_LIGHTS

Constant for modkit gl21 forward lights.

`MODKIT_MAX_FORWARD_LIGHTS`define

MODKIT_MAX_FORWARD_LIGHTS

Maximum supported modkit forward lights.

`MODKIT_MAX_LIGHTS`define

MODKIT_MAX_LIGHTS

Maximum supported modkit lights.

lighting.h

Functions

mk_light_distance_attenuationfunction

mk_light_spot_attenuationfunction

mk_lighting_applyfunction

mk_lighting_frame_beginfunction

mk_lighting_get_statsfunction

mk_lighting_system_initfunction

mk_lighting_system_shutdownfunction

mk_lights_effective_forward_capacityfunction

mk_lights_setfunction

mk_set_ambientfunction

mk_set_clearcoat_enabledfunction

mk_set_debug_viewfunction

mk_set_lightfunction

mk_set_sheen_enabledfunction

Structs

mk_light_descstruct

mk_lighting_statsstruct

Enums

mk_light_flagsenum

mk_light_typeenum

mk_lighting_fallback_reasonenum

mk_lighting_pathenum

Typedefs

mk_light_desctypedef

mk_light_flagstypedef

mk_light_typetypedef

mk_lighting_fallback_reasontypedef

mk_lighting_pathtypedef

mk_lighting_statstypedef

Macros

MODKIT_GL21_FORWARD_LIGHTSdefine

MODKIT_MAX_FORWARD_LIGHTSdefine

MODKIT_MAX_LIGHTSdefine

`mk_light_distance_attenuation`function

`mk_light_spot_attenuation`function

`mk_lighting_apply`function

`mk_lighting_frame_begin`function

`mk_lighting_get_stats`function

`mk_lighting_system_init`function

`mk_lighting_system_shutdown`function

`mk_lights_effective_forward_capacity`function

`mk_lights_set`function

`mk_set_ambient`function

`mk_set_clearcoat_enabled`function

`mk_set_debug_view`function

`mk_set_light`function

`mk_set_sheen_enabled`function

`mk_light_desc`struct

`mk_lighting_stats`struct

`mk_light_flags`enum

`mk_light_type`enum

`mk_lighting_fallback_reason`enum

`mk_lighting_path`enum

`mk_light_desc`typedef

`mk_light_flags`typedef

`mk_light_type`typedef

`mk_lighting_fallback_reason`typedef

`mk_lighting_path`typedef

`mk_lighting_stats`typedef

`MODKIT_GL21_FORWARD_LIGHTS`define

`MODKIT_MAX_FORWARD_LIGHTS`define

`MODKIT_MAX_LIGHTS`define