kanzi::NodeEffectRenderer2D::EffectPass Struct Reference

Effect pass configuration. More...

#include <kanzi/core.ui/node/node_effect_renderer2d.hpp>

Classes
struct	Input
	Effect pass input configuration. More...

Public Member Functions
	EffectPass ()=default
	Declare EffectPass as movable but not copyable. More...
	EffectPass (EffectPass &&)=default
EffectPass &	operator= (EffectPass &&)=default

Public Attributes
optional< ColorRGBA >	clearColor
	Optional color to which you want to clear the target. More...
EffectRenderState *	effectRenderState
	Effect render state to use for intermediate or final blit pass. More...
Sampler::Filter	filterMode
	Sampling mode for the framebuffer. More...
optional< GraphicsFormat >	format
	Optional graphics format for the render target. More...
vector< Input >	inputs
	Input configuration (must match with EffectPass::effectRenderState->inputs). More...
Vector2	minimumRenderTargetSize
	Minimum render target resolution required by the output of this effect pass. More...
RectangleFloat	renderRectangle
	Render rectangle relative to requested render target. More...
TextureSharedPtr	renderTarget
	Current render target. More...

Detailed Description

Effect pass configuration.

Constructor & Destructor Documentation

EffectPass() [1/2]

kanzi::NodeEffectRenderer2D::EffectPass::EffectPass ( )

default

Declare EffectPass as movable but not copyable.

EffectPass() [2/2]

kanzi::NodeEffectRenderer2D::EffectPass::EffectPass ( EffectPass &&  )

default

Member Function Documentation

operator=()

EffectPass& kanzi::NodeEffectRenderer2D::EffectPass::operator= ( EffectPass &&  )

default

Member Data Documentation

effectRenderState

EffectRenderState* kanzi::NodeEffectRenderer2D::EffectPass::effectRenderState

Effect render state to use for intermediate or final blit pass.

inputs

vector<Input> kanzi::NodeEffectRenderer2D::EffectPass::inputs

Input configuration (must match with EffectPass::effectRenderState->inputs).

renderRectangle

RectangleFloat kanzi::NodeEffectRenderer2D::EffectPass::renderRectangle

Render rectangle relative to requested render target.

The size for the first pass must be equal to the beginEffect() requiredSize, but can contain an offset.

minimumRenderTargetSize

Vector2 kanzi::NodeEffectRenderer2D::EffectPass::minimumRenderTargetSize

Minimum render target resolution required by the output of this effect pass.

format

optional<GraphicsFormat> kanzi::NodeEffectRenderer2D::EffectPass::format

Optional graphics format for the render target.

If you do not set the format, Kanzi determines the format automatically.

Since

Kanzi 3.9.6

filterMode

Sampler::Filter kanzi::NodeEffectRenderer2D::EffectPass::filterMode

Sampling mode for the framebuffer.

The default is linear sampling.

Since

Kanzi 3.9.6

clearColor

optional<ColorRGBA> kanzi::NodeEffectRenderer2D::EffectPass::clearColor

Optional color to which you want to clear the target.

If set to nullopt, Kanzi does not clear the render target.

Since

Kanzi 3.9.6

renderTarget

TextureSharedPtr kanzi::NodeEffectRenderer2D::EffectPass::renderTarget

Current render target.

Set by corresponding beginInitialEffectPass and blitIntermediateEffectPass calls and cleared by the last render pass using this render target as the input (see EffectPass::Input::releaseRenderTarget).

---

The documentation for this struct was generated from the following file:

• kanzi/core.ui/node/node_effect_renderer2d.hpp