QGIS API Documentation 3.43.0-Master (c67cf405802)
Public Member Functions | List of all members
QgsPostprocessingEntity Class Reference

An entity that is responsible for applying post processing effects. More...

#include <qgspostprocessingentity.h>

Inheritance diagram for QgsPostprocessingEntity:
Inheritance graph
[legend]

Public Member Functions

 QgsPostprocessingEntity (QgsFrameGraph *frameGraph, Qt3DRender::QLayer *layer, QNode *parent=nullptr)
 Constructor.
 
void setAmbientOcclusionEnabled (bool enabled)
 Sets whether screen space ambient occlusion is enabled.
 
void setEyeDomeLightingDistance (int distance)
 Sets the eye dome lighting distance (contributes to the contrast of the image)
 
void setEyeDomeLightingEnabled (bool enabled)
 Sets whether eye dome lighting is enabled.
 
void setEyeDomeLightingStrength (double strength)
 Sets the eye dome lighting strength.
 
void setShadowBias (float shadowBias)
 Sets the shadow bias value.
 
void setShadowRenderingEnabled (bool enabled)
 Sets whether shadow rendering is enabled.
 
void setupDirectionalLight (QVector3D position, QVector3D direction)
 Sets up a directional light that is used to render shadows.
 
void setupShadowRenderingExtent (float minX, float maxX, float minY, float maxY)
 Sets the parts of the scene where objects cast shadows.
 
void updateShadowSettings (const QgsDirectionalLightSettings &light, float maximumShadowRenderingDistance)
 Sets shadow rendering to use a directional light.
 
- Public Member Functions inherited from QgsRenderPassQuad
 QgsRenderPassQuad (Qt3DRender::QLayer *layer, QNode *parent=nullptr)
 Constructor.
 

Additional Inherited Members

- Protected Attributes inherited from QgsRenderPassQuad
Qt3DRender::QMaterial * mMaterial = nullptr
 
Qt3DRender::QShaderProgram * mShader = nullptr
 

Detailed Description

An entity that is responsible for applying post processing effects.

Note
Not available in Python bindings
Since
QGIS 3.16

Definition at line 35 of file qgspostprocessingentity.h.

Constructor & Destructor Documentation

◆ QgsPostprocessingEntity()

QgsPostprocessingEntity::QgsPostprocessingEntity ( QgsFrameGraph frameGraph,
Qt3DRender::QLayer *  layer,
QNode *  parent = nullptr 
)

Constructor.

Definition at line 50 of file qgspostprocessingentity.cpp.

Member Function Documentation

◆ setAmbientOcclusionEnabled()

void QgsPostprocessingEntity::setAmbientOcclusionEnabled ( bool  enabled)

Sets whether screen space ambient occlusion is enabled.

Since
QGIS 3.28

Definition at line 203 of file qgspostprocessingentity.cpp.

◆ setEyeDomeLightingDistance()

void QgsPostprocessingEntity::setEyeDomeLightingDistance ( int  distance)

Sets the eye dome lighting distance (contributes to the contrast of the image)

Definition at line 198 of file qgspostprocessingentity.cpp.

◆ setEyeDomeLightingEnabled()

void QgsPostprocessingEntity::setEyeDomeLightingEnabled ( bool  enabled)

Sets whether eye dome lighting is enabled.

Definition at line 188 of file qgspostprocessingentity.cpp.

◆ setEyeDomeLightingStrength()

void QgsPostprocessingEntity::setEyeDomeLightingStrength ( double  strength)

Sets the eye dome lighting strength.

Definition at line 193 of file qgspostprocessingentity.cpp.

◆ setShadowBias()

void QgsPostprocessingEntity::setShadowBias ( float  shadowBias)

Sets the shadow bias value.

Definition at line 183 of file qgspostprocessingentity.cpp.

◆ setShadowRenderingEnabled()

void QgsPostprocessingEntity::setShadowRenderingEnabled ( bool  enabled)

Sets whether shadow rendering is enabled.

Definition at line 178 of file qgspostprocessingentity.cpp.

◆ setupDirectionalLight()

void QgsPostprocessingEntity::setupDirectionalLight ( QVector3D  position,
QVector3D  direction 
)

Sets up a directional light that is used to render shadows.

Definition at line 145 of file qgspostprocessingentity.cpp.

◆ setupShadowRenderingExtent()

void QgsPostprocessingEntity::setupShadowRenderingExtent ( float  minX,
float  maxX,
float  minY,
float  maxY 
)

Sets the parts of the scene where objects cast shadows.

Definition at line 137 of file qgspostprocessingentity.cpp.

◆ updateShadowSettings()

void QgsPostprocessingEntity::updateShadowSettings ( const QgsDirectionalLightSettings light,
float  maximumShadowRenderingDistance 
)

Sets shadow rendering to use a directional light.

Since
QGIS 3.44

Definition at line 151 of file qgspostprocessingentity.cpp.


The documentation for this class was generated from the following files: