Skip to content

Kuesa::Qt3D::AbstractPostProcessingEffect

Module: Kuesa Qt 3D API

AbstractPostProcessingEffect is the abstract base class for Kuesa post processing effects. More...

#include <Kuesa/Qt3D/api/fx/abstractpostprocessingeffect.h>

Inherits from Qt3DCore::QNode

Inherited by Kuesa::Qt3D::BloomEffect, Kuesa::Qt3D::DepthOfFieldEffect, Kuesa::Qt3D::GaussianBlurEffect, Kuesa::Qt3D::OpacityMask, Kuesa::Qt3D::ThresholdEffect, Kuesa::Qt3D::ToneMappingAndGammaCorrectionEffect

Public Types

Name
enum Type { Custom = 0}
using QSharedPointer< Qt3DRender::QFrameGraphNode > FrameGraphNodePtr

Public Functions

Name
~AbstractPostProcessingEffect()
virtual FrameGraphNodePtr frameGraphSubTree() const =0
Type type() const
virtual void setInputTexture(Qt3DRender::QAbstractTexture * texture) =0
virtual void setDepthTexture(Qt3DRender::QAbstractTexture * texture)
virtual void setCamera(Qt3DCore::QEntity * camera)
virtual void setWindowSize(const QSize & sceneSize)
virtual QVector< Qt3DRender::QLayer * > layers() const =0

Protected Functions

Name
AbstractPostProcessingEffect(Qt3DCore::QNode * parent =nullptr, Type type =Custom)

Protected Attributes

Name
const Type m_type

Detailed Description

1
class Kuesa::Qt3D::AbstractPostProcessingEffect;

AbstractPostProcessingEffect is the abstract base class for Kuesa post processing effects.

Since: Kuesa 2.0

Public Types Documentation

enum Type

Enumerator Value Description
Custom 0

using FrameGraphNodePtr

1
using Kuesa::Qt3D::AbstractPostProcessingEffect::FrameGraphNodePtr =  QSharedPointer<Qt3DRender::QFrameGraphNode>;

Public Functions Documentation

function ~AbstractPostProcessingEffect

1
~AbstractPostProcessingEffect()

function frameGraphSubTree

1
virtual FrameGraphNodePtr frameGraphSubTree() const =0

Note: The lifetime of the returned subtree is assumed to be managed by the shared pointer. Any caller reparenting the subtree to add to a

Reimplemented by: Kuesa::Qt3D::BloomEffect::frameGraphSubTree, Kuesa::Qt3D::DepthOfFieldEffect::frameGraphSubTree, Kuesa::Qt3D::GaussianBlurEffect::frameGraphSubTree, Kuesa::Qt3D::OpacityMask::frameGraphSubTree, Kuesa::Qt3D::ThresholdEffect::frameGraphSubTree, Kuesa::Qt3D::ToneMappingAndGammaCorrectionEffect::frameGraphSubTree

Returns a FrameGraph subtree corresponding to the effect's implementation.

function type

1
Type type() const

Returns the post processing effect's type.

function setInputTexture

1
2
3
virtual void setInputTexture(
    Qt3DRender::QAbstractTexture * texture
) =0

Reimplemented by: Kuesa::Qt3D::BloomEffect::setInputTexture, Kuesa::Qt3D::DepthOfFieldEffect::setInputTexture, Kuesa::Qt3D::GaussianBlurEffect::setInputTexture, Kuesa::Qt3D::OpacityMask::setInputTexture, Kuesa::Qt3D::ThresholdEffect::setInputTexture, Kuesa::Qt3D::ToneMappingAndGammaCorrectionEffect::setInputTexture

Sets the input texture to texture for this effect. The texture contain the rendered scene that the effect will be applied to. This is set automatically by the ForwardRenderer when the effect is added.

function setDepthTexture

1
2
3
virtual void setDepthTexture(
    Qt3DRender::QAbstractTexture * texture
)

Reimplemented by: Kuesa::Qt3D::DepthOfFieldEffect::setDepthTexture

Sets the depth texture to texture for this effect. The texture contain the depth of the rendered scene that the effect will be applied to. This is set automatically by the ForwardRenderer when the effect is added.

function setCamera

1
2
3
virtual void setCamera(
    Qt3DCore::QEntity * camera
)

Reimplemented by: Kuesa::Qt3D::DepthOfFieldEffect::setCamera

Sets the camera entity to camera for this effect. This is set automatically by the ForwardRenderer when the effect is added.

function setWindowSize

1
2
3
virtual void setWindowSize(
    const QSize & sceneSize
)

Reimplemented by: Kuesa::Qt3D::BloomEffect::setWindowSize, Kuesa::Qt3D::DepthOfFieldEffect::setWindowSize, Kuesa::Qt3D::GaussianBlurEffect::setWindowSize

Sets the sceneSize of the rendered scene (in pixels) that the effect will be applied to. This is necessary for effects to render correctly.

function layers

1
virtual QVector< Qt3DRender::QLayer * > layers() const =0

Reimplemented by: Kuesa::Qt3D::BloomEffect::layers, Kuesa::Qt3D::DepthOfFieldEffect::layers, Kuesa::Qt3D::GaussianBlurEffect::layers, Kuesa::Qt3D::OpacityMask::layers, Kuesa::Qt3D::ThresholdEffect::layers, Kuesa::Qt3D::ToneMappingAndGammaCorrectionEffect::layers

Return the layers provided by this effect. This will generally be the layer of a

Protected Functions Documentation

function AbstractPostProcessingEffect

1
2
3
4
explicit AbstractPostProcessingEffect(
    Qt3DCore::QNode * parent =nullptr,
    Type type =Custom
)

Protected Attributes Documentation

variable m_type

1
const Type m_type;

Updated on 2023-07-03 at 11:02:12 +0000