Container class that holds different objects related to shadow rendering. More...

#include <qgsshadowrenderingframegraph.h>

Inheritance diagram for QgsShadowRenderingFrameGraph:

Public Member Functions
	QgsShadowRenderingFrameGraph (QSurface surface, QSize s, Qt3DRender::QCamera mainCamera, Qt3DCore::QEntity *root)
	Constructor. More...

QgsPreviewQuad *	addTexturePreviewOverlay (Qt3DRender::QTexture2D texture, const QPointF &centerNDC, const QSizeF &size, QVector< Qt3DRender::QParameter > additionalShaderParameters=QVector< Qt3DRender::QParameter * >())
	Adds an preview entity that shows a texture in real time for debugging purposes. More...

Qt3DRender::QLayer *	castShadowsLayer ()
	Returns a layer object used to indicate that an entity will cast shadows. More...

Qt3DRender::QRenderCapture *	depthRenderCapture ()
	Returns the render capture object used to take an image of the depth buffer of the scene. More...

Qt3DRender::QTexture2D *	forwardRenderColorTexture ()
	Returns the color texture of the forward rendering pass. More...

Qt3DRender::QTexture2D *	forwardRenderDepthTexture ()
	Returns the depth texture of the forward rendering pass. More...

Qt3DRender::QLayer *	forwardRenderLayer ()
	Returns a layer object used to indicate that an entity will be rendered during the forward rendering pass. More...

Qt3DRender::QFrameGraphNode *	frameGraphRoot ()
	Returns the root of the frame graph object. More...

bool	frustumCullingEnabled () const
	Returns whether frustum culling is enabled. More...

Qt3DRender::QCamera *	lightCamera ()
	Returns the light camera. More...

Qt3DRender::QCamera *	mainCamera ()
	Returns the main camera. More...

QgsPostprocessingEntity *	postprocessingEntity ()
	Returns the postprocessing entity. More...

Qt3DRender::QLayer *	postprocessingPassLayer ()
	Returns a layer object used to indicate that an entity is to be rendered during the post processing rendering pass. More...

Qt3DRender::QLayer *	previewLayer ()
	Returns a layer object used to indicate that an entity is to be rendered during the preview textures rendering pass. More...

Qt3DRender::QRenderCapture *	renderCapture ()
	Returns the render capture object used to take an image of the scene. More...

bool	renderCaptureEnabled () const
	Returns whether it will be possible to render to an image. More...

Qt3DCore::QEntity *	rootEntity ()
	Returns the root entity of the entities related to the frame graph (like the post processing entity and preview entity) More...

void	setClearColor (const QColor &clearColor)
	Sets the clear color of the scene (background color) More...

void	setDebugOverlayEnabled (bool enabled)
	Sets whether debug overlay is enabled. More...

void	setFrustumCullingEnabled (bool enabled)
	Sets whether frustum culling is enabled. More...

void	setRenderCaptureEnabled (bool enabled)
	Sets whether it will be possible to render to an image. More...

void	setShadowBias (float shadowBias)
	Sets the shadow bias value. More...

void	setShadowMapResolution (int resolution)
	Sets the resolution of the shadow map. More...

void	setShadowRenderingEnabled (bool enabled)
	Sets whether the shadow rendering is enabled. More...

void	setSize (QSize s)
	Sets the size of the buffers used for rendering. More...

void	setupDepthMapDebugging (bool enabled, Qt::Corner corner, double size)
	Sets the depth map debugging view port. More...

void	setupDirectionalLight (const QgsDirectionalLightSettings &light, float maximumShadowRenderingDistance)
	Sets shadow rendering to use a directional light. More...

void	setupEyeDomeLighting (bool enabled, double strength, int distance)
	Sets eye dome lighting shading related settings. More...

void	setupShadowMapDebugging (bool enabled, Qt::Corner corner, double size)
	Sets the shadow map debugging view port. More...

float	shadowBias () const
	Returns the shadow bias value. More...

int	shadowMapResolution () const
	Returns the shadow map resolution. More...

Qt3DRender::QTexture2D *	shadowMapTexture ()
	Returns the shadow map (a depth texture for the shadow rendering pass) More...

bool	shadowRenderingEnabled () const
	Returns whether shadow rendering is enabled. More...

Qt3DRender::QLayer *	transparentObjectLayer ()
	Returns a layer object used to indicate that the object is transparent. More...

Detailed Description

Container class that holds different objects related to shadow rendering.

3

Note: Not available in Python bindings

Since: QGIS 3.16

Definition at line 59 of file qgsshadowrenderingframegraph.h.

Constructor & Destructor Documentation

◆ QgsShadowRenderingFrameGraph()

QgsShadowRenderingFrameGraph::QgsShadowRenderingFrameGraph	(	QSurface *	surface,
		QSize	s,
		Qt3DRender::QCamera *	mainCamera,
		Qt3DCore::QEntity *	root
	)

Constructor.

Definition at line 399 of file qgsshadowrenderingframegraph.cpp.

Member Function Documentation

◆ addTexturePreviewOverlay()

QgsPreviewQuad * QgsShadowRenderingFrameGraph::addTexturePreviewOverlay	(	Qt3DRender::QTexture2D *	texture,
		const QPointF &	centerNDC,
		const QSizeF &	size,
		QVector< Qt3DRender::QParameter * >	additionalShaderParameters = `QVector<Qt3DRender::QParameter *>()`
	)

Adds an preview entity that shows a texture in real time for debugging purposes.

Definition at line 469 of file qgsshadowrenderingframegraph.cpp.

◆ castShadowsLayer()

Qt3DRender::QLayer* QgsShadowRenderingFrameGraph::castShadowsLayer ( )

inline

Returns a layer object used to indicate that an entity will cast shadows.

Definition at line 82 of file qgsshadowrenderingframegraph.h.

◆ depthRenderCapture()

Qt3DRender::QRenderCapture* QgsShadowRenderingFrameGraph::depthRenderCapture ( )

inline

Returns the render capture object used to take an image of the depth buffer of the scene.

Definition at line 105 of file qgsshadowrenderingframegraph.h.

◆ forwardRenderColorTexture()

Qt3DRender::QTexture2D* QgsShadowRenderingFrameGraph::forwardRenderColorTexture ( )

inline

Returns the color texture of the forward rendering pass.

Definition at line 71 of file qgsshadowrenderingframegraph.h.

◆ forwardRenderDepthTexture()

Qt3DRender::QTexture2D* QgsShadowRenderingFrameGraph::forwardRenderDepthTexture ( )

inline

Returns the depth texture of the forward rendering pass.

Definition at line 73 of file qgsshadowrenderingframegraph.h.

◆ forwardRenderLayer()

Qt3DRender::QLayer* QgsShadowRenderingFrameGraph::forwardRenderLayer ( )

inline

Returns a layer object used to indicate that an entity will be rendered during the forward rendering pass.

Definition at line 84 of file qgsshadowrenderingframegraph.h.

◆ frameGraphRoot()

Qt3DRender::QFrameGraphNode* QgsShadowRenderingFrameGraph::frameGraphRoot ( )

inline

Returns the root of the frame graph object.

Definition at line 68 of file qgsshadowrenderingframegraph.h.

◆ frustumCullingEnabled()

bool QgsShadowRenderingFrameGraph::frustumCullingEnabled ( ) const

inline

Returns whether frustum culling is enabled.

Definition at line 109 of file qgsshadowrenderingframegraph.h.

◆ lightCamera()

Qt3DRender::QCamera* QgsShadowRenderingFrameGraph::lightCamera ( )

inline

Returns the light camera.

Definition at line 95 of file qgsshadowrenderingframegraph.h.

◆ mainCamera()

Qt3DRender::QCamera* QgsShadowRenderingFrameGraph::mainCamera ( )

inline

Returns the main camera.

Definition at line 93 of file qgsshadowrenderingframegraph.h.

◆ postprocessingEntity()

QgsPostprocessingEntity* QgsShadowRenderingFrameGraph::postprocessingEntity ( )

inline

Returns the postprocessing entity.

Definition at line 97 of file qgsshadowrenderingframegraph.h.

◆ postprocessingPassLayer()

Qt3DRender::QLayer* QgsShadowRenderingFrameGraph::postprocessingPassLayer ( )

inline

Returns a layer object used to indicate that an entity is to be rendered during the post processing rendering pass.

Definition at line 78 of file qgsshadowrenderingframegraph.h.

◆ previewLayer()

Qt3DRender::QLayer* QgsShadowRenderingFrameGraph::previewLayer ( )

inline

Returns a layer object used to indicate that an entity is to be rendered during the preview textures rendering pass.

Definition at line 80 of file qgsshadowrenderingframegraph.h.

◆ renderCapture()

Qt3DRender::QRenderCapture* QgsShadowRenderingFrameGraph::renderCapture ( )

inline

Returns the render capture object used to take an image of the scene.

Definition at line 102 of file qgsshadowrenderingframegraph.h.

◆ renderCaptureEnabled()

bool QgsShadowRenderingFrameGraph::renderCaptureEnabled ( ) const

inline

Returns whether it will be possible to render to an image.

Since: QGIS 3.18

Definition at line 153 of file qgsshadowrenderingframegraph.h.

◆ rootEntity()

Qt3DCore::QEntity* QgsShadowRenderingFrameGraph::rootEntity ( )

inline

Returns the root entity of the entities related to the frame graph (like the post processing entity and preview entity)

Definition at line 99 of file qgsshadowrenderingframegraph.h.

◆ setClearColor()

void QgsShadowRenderingFrameGraph::setClearColor ( const QColor & clearColor )

Sets the clear color of the scene (background color)

Definition at line 565 of file qgsshadowrenderingframegraph.cpp.

◆ setDebugOverlayEnabled()

void QgsShadowRenderingFrameGraph::setDebugOverlayEnabled ( bool enabled )

Sets whether debug overlay is enabled.

Since: QGIS 3.26

Definition at line 681 of file qgsshadowrenderingframegraph.cpp.

◆ setFrustumCullingEnabled()

void QgsShadowRenderingFrameGraph::setFrustumCullingEnabled ( bool enabled )

Sets whether frustum culling is enabled.

Definition at line 593 of file qgsshadowrenderingframegraph.cpp.

◆ setRenderCaptureEnabled()

void QgsShadowRenderingFrameGraph::setRenderCaptureEnabled ( bool enabled )

Sets whether it will be possible to render to an image.

Since: QGIS 3.18

Definition at line 673 of file qgsshadowrenderingframegraph.cpp.

◆ setShadowBias()

void QgsShadowRenderingFrameGraph::setShadowBias ( float shadowBias )

Sets the shadow bias value.

Definition at line 580 of file qgsshadowrenderingframegraph.cpp.

◆ setShadowMapResolution()

void QgsShadowRenderingFrameGraph::setShadowMapResolution ( int resolution )

Sets the resolution of the shadow map.

Definition at line 586 of file qgsshadowrenderingframegraph.cpp.

◆ setShadowRenderingEnabled()

void QgsShadowRenderingFrameGraph::setShadowRenderingEnabled ( bool enabled )

Sets whether the shadow rendering is enabled.

Definition at line 570 of file qgsshadowrenderingframegraph.cpp.

◆ setSize()

void QgsShadowRenderingFrameGraph::setSize ( QSize s )

Sets the size of the buffers used for rendering.

Definition at line 661 of file qgsshadowrenderingframegraph.cpp.

◆ setupDepthMapDebugging()

void QgsShadowRenderingFrameGraph::setupDepthMapDebugging	(	bool	enabled,
		Qt::Corner	corner,
		double	size
	)

Sets the depth map debugging view port.

Definition at line 637 of file qgsshadowrenderingframegraph.cpp.

◆ setupDirectionalLight()

void QgsShadowRenderingFrameGraph::setupDirectionalLight	(	const QgsDirectionalLightSettings &	light,
		float	maximumShadowRenderingDistance
	)

Sets shadow rendering to use a directional light.

Definition at line 538 of file qgsshadowrenderingframegraph.cpp.

◆ setupEyeDomeLighting()

void QgsShadowRenderingFrameGraph::setupEyeDomeLighting	(	bool	enabled,
		double	strength,
		int	distance
	)

Sets eye dome lighting shading related settings.

Definition at line 604 of file qgsshadowrenderingframegraph.cpp.

◆ setupShadowMapDebugging()

void QgsShadowRenderingFrameGraph::setupShadowMapDebugging	(	bool	enabled,
		Qt::Corner	corner,
		double	size
	)

Sets the shadow map debugging view port.

Definition at line 614 of file qgsshadowrenderingframegraph.cpp.

◆ shadowBias()

float QgsShadowRenderingFrameGraph::shadowBias ( ) const

inline

Returns the shadow bias value.

Definition at line 119 of file qgsshadowrenderingframegraph.h.

◆ shadowMapResolution()

int QgsShadowRenderingFrameGraph::shadowMapResolution ( ) const

inline

Returns the shadow map resolution.

Definition at line 124 of file qgsshadowrenderingframegraph.h.

◆ shadowMapTexture()

Qt3DRender::QTexture2D* QgsShadowRenderingFrameGraph::shadowMapTexture ( )

inline

Returns the shadow map (a depth texture for the shadow rendering pass)

Definition at line 75 of file qgsshadowrenderingframegraph.h.

◆ shadowRenderingEnabled()

bool QgsShadowRenderingFrameGraph::shadowRenderingEnabled ( ) const

inline

Returns whether shadow rendering is enabled.

Definition at line 114 of file qgsshadowrenderingframegraph.h.

◆ transparentObjectLayer()

Qt3DRender::QLayer* QgsShadowRenderingFrameGraph::transparentObjectLayer ( )

inline

Returns a layer object used to indicate that the object is transparent.

Since: QGIS 3.26

Definition at line 90 of file qgsshadowrenderingframegraph.h.

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

/build/qgis-3.26.3+32focal/src/3d/qgsshadowrenderingframegraph.h
/build/qgis-3.26.3+32focal/src/3d/qgsshadowrenderingframegraph.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsShadowRenderingFrameGraph()

Member Function Documentation

◆ addTexturePreviewOverlay()

◆ castShadowsLayer()

◆ depthRenderCapture()

◆ forwardRenderColorTexture()

◆ forwardRenderDepthTexture()

◆ forwardRenderLayer()

◆ frameGraphRoot()

◆ frustumCullingEnabled()

◆ lightCamera()

◆ mainCamera()

◆ postprocessingEntity()

◆ postprocessingPassLayer()

◆ previewLayer()

◆ renderCapture()

◆ renderCaptureEnabled()

◆ rootEntity()

◆ setClearColor()

◆ setDebugOverlayEnabled()

◆ setFrustumCullingEnabled()

◆ setRenderCaptureEnabled()

◆ setShadowBias()

◆ setShadowMapResolution()

◆ setShadowRenderingEnabled()

◆ setSize()

◆ setupDepthMapDebugging()

◆ setupDirectionalLight()

◆ setupEyeDomeLighting()

◆ setupShadowMapDebugging()

◆ shadowBias()

◆ shadowMapResolution()

◆ shadowMapTexture()

◆ shadowRenderingEnabled()

◆ transparentObjectLayer()