Kanzi Framework  3.9.0
Kanzi Engine API
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
 
EffectPassoperator= (EffectPass &&)=default
 

Public Attributes

EffectRenderStateeffectRenderState
 Effect render state to use for intermediate or final blit pass. More...
 
vector< Inputinputs
 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...
 
bool requiresClear
 Whether this effect pass requires render target clear. 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.

◆ minimumRenderTargetSize

Vector2 kanzi::NodeEffectRenderer2D::EffectPass::minimumRenderTargetSize

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

◆ requiresClear

bool kanzi::NodeEffectRenderer2D::EffectPass::requiresClear

Whether this effect pass requires render target clear.

◆ 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: