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

#include <qgspostprocessingentity.h>

Inheritance diagram for QgsPostprocessingEntity:

[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	setBloomEnabled (bool enabled)
	Sets whether physically based bloom is enabled.
void	setBloomFactor (float factor)
	Sets the bloom factor, which controls the strength of the bloom effect.
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	setShadowLightIndex (int index)
	Sets the index of the directional light that is casting shadows.
void	setShadowRenderingEnabled (bool enabled)
	Sets whether shadow rendering is enabled.
void	setShowCascadingShadowSplits (bool enabled)
	Sets whether the splits between cascading shadow map boundaries should be shown.
void	updateBloomSettings (const QgsBloomSettings &settings)
	Sets bloom rendering to use a directional light.
void	updateColorGradingSettings (const QgsColorGradingSettings &settings)
	Updates settings for color grading.
void	updateEyeDomeSettings (const Qgs3DMapSettings &settings)
	Updates eye dome lighting settings from settings.
void	updateShadowSettings (const QgsShadowSettings &shadowSettings, const QgsVector3D &lightDir, int size, int globalLightIndex)
	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 49 of file qgspostprocessingentity.h.

Constructor & Destructor Documentation

◆ QgsPostprocessingEntity()

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

Constructor.

Definition at line 42 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 318 of file qgspostprocessingentity.cpp.

◆ setBloomEnabled()

void QgsPostprocessingEntity::setBloomEnabled ( bool enabled )

Sets whether physically based bloom is enabled.

Definition at line 323 of file qgspostprocessingentity.cpp.

◆ setBloomFactor()

void QgsPostprocessingEntity::setBloomFactor ( float factor )

Sets the bloom factor, which controls the strength of the bloom effect.

The default factor is 0.05.

Definition at line 328 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 313 of file qgspostprocessingentity.cpp.

◆ setEyeDomeLightingEnabled()

void QgsPostprocessingEntity::setEyeDomeLightingEnabled ( bool enabled )

Sets whether eye dome lighting is enabled.

Definition at line 303 of file qgspostprocessingentity.cpp.

◆ setEyeDomeLightingStrength()

void QgsPostprocessingEntity::setEyeDomeLightingStrength ( double strength )

Sets the eye dome lighting strength.

Definition at line 308 of file qgspostprocessingentity.cpp.

◆ setShadowBias()

void QgsPostprocessingEntity::setShadowBias ( float shadowBias )

Sets the shadow bias value.

Definition at line 292 of file qgspostprocessingentity.cpp.

◆ setShadowLightIndex()

void QgsPostprocessingEntity::setShadowLightIndex ( int index )

Sets the index of the directional light that is casting shadows.

Definition at line 287 of file qgspostprocessingentity.cpp.

◆ setShadowRenderingEnabled()

void QgsPostprocessingEntity::setShadowRenderingEnabled ( bool enabled )

Sets whether shadow rendering is enabled.

Definition at line 267 of file qgspostprocessingentity.cpp.

◆ setShowCascadingShadowSplits()

void QgsPostprocessingEntity::setShowCascadingShadowSplits ( bool enabled )

Sets whether the splits between cascading shadow map boundaries should be shown.

Warning: For testing purposes only!

Definition at line 272 of file qgspostprocessingentity.cpp.

◆ updateBloomSettings()

void QgsPostprocessingEntity::updateBloomSettings ( const QgsBloomSettings & settings )

Sets bloom rendering to use a directional light.

Since: QGIS 4.2

Definition at line 138 of file qgspostprocessingentity.cpp.

◆ updateColorGradingSettings()

void QgsPostprocessingEntity::updateColorGradingSettings ( const QgsColorGradingSettings & settings )

Updates settings for color grading.

Since: QGIS 4.2

Definition at line 333 of file qgspostprocessingentity.cpp.

◆ updateEyeDomeSettings()

void QgsPostprocessingEntity::updateEyeDomeSettings ( const Qgs3DMapSettings & settings )

Updates eye dome lighting settings from settings.

Since: QGIS 4.2

Definition at line 297 of file qgspostprocessingentity.cpp.

◆ updateShadowSettings()

void QgsPostprocessingEntity::updateShadowSettings	(	const QgsShadowSettings &	shadowSettings,
		const QgsVector3D &	lightDir,
		int	size,
		int	globalLightIndex )

Sets shadow rendering to use a directional light.

Since: QGIS 4.2

Definition at line 143 of file qgspostprocessingentity.cpp.

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

/build/qgis-4.1.0+git20260608+26185ffb827+99sid/src/3d/framegraph/qgspostprocessingentity.h
/build/qgis-4.1.0+git20260608+26185ffb827+99sid/src/3d/framegraph/qgspostprocessingentity.cpp

Public Member Functions

Additional Inherited Members