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... | |
Effect pass configuration.
|
default |
Declare EffectPass as movable but not copyable.
|
default |
|
default |
EffectRenderState* kanzi::NodeEffectRenderer2D::EffectPass::effectRenderState |
Effect render state to use for intermediate or final blit pass.
vector<Input> kanzi::NodeEffectRenderer2D::EffectPass::inputs |
Input configuration (must match with EffectPass::effectRenderState->inputs).
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.
Vector2 kanzi::NodeEffectRenderer2D::EffectPass::minimumRenderTargetSize |
Minimum render target resolution required by the output of this effect pass.
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.
Sampler::Filter kanzi::NodeEffectRenderer2D::EffectPass::filterMode |
Sampling mode for the framebuffer.
The default is linear sampling.
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.
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).