Header menu logo Mibo

PipelineConfig Module

Functions and values

Function or value Description

defaults

Full Usage: defaults

Returns: PipelineConfig

Default pipeline configuration: No shadows, no post-process, no default lighting.

Returns: PipelineConfig

withDefaultLighting lighting pc

Full Usage: withDefaultLighting lighting pc

Parameters:
Returns: PipelineConfig

Provides a fallback lighting configuration. This lighting state is used for any frame where the view function does not explicitly submit a 'SetLighting' command.

lighting : LightingState
pc : PipelineConfig
Returns: PipelineConfig

withLightingBinder binder pc

Full Usage: withLightingBinder binder pc

Parameters:
Returns: PipelineConfig

[Advanced] Overrides the internal logic for binding lighting data to shaders. Use this only if you are using completely custom shaders and need to manually map Mibo's lighting structures to your effect parameters.

binder : Effect -> Camera -> LightingState -> unit
pc : PipelineConfig
Returns: PipelineConfig

withPostProcess cfg pc

Full Usage: withPostProcess cfg pc

Parameters:
Returns: PipelineConfig

Enables and configures the post-processing pipeline phase.

cfg : PostProcessConfig
pc : PipelineConfig
Returns: PipelineConfig

withPreRenderCallback cb pc

Full Usage: withPreRenderCallback cb pc

Parameters:
Returns: PipelineConfig

[Advanced] Registers a callback to execute before the main render pass. Useful for global effect updates, compute shader dispatch, or custom depth pre-passes.

cb : GraphicsDevice -> Camera -> LightingState -> unit
pc : PipelineConfig
Returns: PipelineConfig

withShader shaderBase assetName pc

Full Usage: withShader shaderBase assetName pc

Parameters:
Returns: PipelineConfig

Registers a custom shader asset to override a default internal shader (e.g., replacing 'PBRForward' with your own implementation).

shaderBase : ShaderBase
assetName : string
pc : PipelineConfig
Returns: PipelineConfig

withShadows cfg pc

Full Usage: withShadows cfg pc

Parameters:
Returns: PipelineConfig

Enables and configures the shadow rendering subsystem. Without this, no shadows will be rendered regardless of light settings.

cfg : ShadowConfig
pc : PipelineConfig
Returns: PipelineConfig

withTileSize size pc

Full Usage: withTileSize size pc

Parameters:
Returns: PipelineConfig

Tunable performance setting for CPU Tiled Forward culling. 16: Tighter culling, higher CPU cost. Good for many small local lights. 32: Balanced default. 64: Faster CPU, looser culling. Good for fewer, larger lights.

size : int
pc : PipelineConfig
Returns: PipelineConfig

Type something to start searching.