UiPostEffectPass

Single shader pass configuration within a post-processing pipeline.

Overview

UiPostEffectPass specifies the render state for one shader invocation in a chain. It pairs a ShaderHandle with uniform variables (UiPostEffectUniforms), optional secondary sampler textures (TextureHandle), and blend mode (UiPostEffectBlendMode).

Standard inputs (SourceTexture, SourceSize, SourceFlipY) are injected automatically by the rendering backend.

Configuring a Pass with Uniforms and Textures

UiPostEffectPass pass = UiPostEffectPass.shader("mymod:overlay")
    .blendMode(UiPostEffectBlendMode.ALPHA_BLEND)
    .texture("NoiseTexture", noiseTexHandle)
    .uniforms(u -> u.floatValue("intensity", 0.75f));

API

UiPostEffectPass::blendMode()

blendMode()

Returns the blend mode of this pass.

Returns UiPostEffectBlendMode: Resulting UiPostEffectBlendMode..

UiPostEffectPass::blendMode(UiPostEffectBlendMode)

blendMode(UiPostEffectBlendMode)

Returns a copy of this pass with updated blend mode.

Parameter	Type	Description
blendMode	UiPostEffectBlendMode	UiPostEffectBlendMode.

Returns UiPostEffectPass: Resulting UiPostEffectPass..

UiPostEffectPass::copy()

copy()

Returns an independent copy of this pass.

Returns UiPostEffectPass: Resulting UiPostEffectPass..

UiPostEffectPass::shader()

shader()

Returns a copy of the shader handle.

Returns ShaderHandle: Resulting ShaderHandle..

UiPostEffectPass::shader(ShaderHandle)

shader(ShaderHandle)

Creates a pass from a ShaderHandle instance.

Parameter	Type	Description
shader	ShaderHandle	ShaderHandle instance.

Returns UiPostEffectPass: Resulting UiPostEffectPass..

UiPostEffectPass::shader(String)

shader(String)

Creates a pass from a shader resource identifier.

Parameter	Type	Description
shaderId	String	Shader resource ID.

Returns UiPostEffectPass: Resulting UiPostEffectPass..

UiPostEffectPass::shaderId()

shaderId()

Returns the stable shader identifier.

Returns String: Resulting String..

UiPostEffectPass::texture(String, TextureHandle)

texture(String, TextureHandle)

Returns a copy of this pass with an additional sampler texture.

Parameter	Type	Description
uniformName	String	Sampler uniform name.
texture	TextureHandle	TextureHandle instance.

Returns UiPostEffectPass: Resulting UiPostEffectPass..

UiPostEffectPass::textures()

textures()

Returns additional sampler textures keyed by uniform name.

Returns Map: Resulting Map..

UiPostEffectPass::uniforms()

uniforms()

Returns a copy of the pass uniforms.

Returns UiPostEffectUniforms: Resulting UiPostEffectUniforms..

UiPostEffectPass::uniforms(Consumer)

uniforms(Consumer)

Returns a copy of this pass with uniforms configured via callback.

Parameter	Type	Description
config	Consumer	Configuration consumer.

Returns UiPostEffectPass: Resulting UiPostEffectPass..

UiPostEffectPass::uniforms(UiPostEffectUniforms)

uniforms(UiPostEffectUniforms)

Returns a copy of this pass with updated uniforms.

Parameter	Type	Description
uniforms	UiPostEffectUniforms	New uniforms instance.

Returns UiPostEffectPass: Resulting UiPostEffectPass..