QGIS API Documentation 3.29.0-Master (694ebda27c)
Public Member Functions | List of all members
QgsShadowRenderingFrameGraph Class Reference

3 More...

#include <qgsshadowrenderingframegraph.h>

Inheritance diagram for QgsShadowRenderingFrameGraph:
Inheritance graph
[legend]

Public Member Functions

 QgsShadowRenderingFrameGraph (QSurface *surface, QSize s, Qt3DRender::QCamera *mainCamera, Qt3DCore::QEntity *root)
 Constructor. More...
 
QgsPreviewQuadaddTexturePreviewOverlay (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...
 
bool ambientOcclusionEnabled () const
 Returns whether Screen Space Ambient Occlusion is enabled. More...
 
Qt3DRender::QTexture2D * ambientOcclusionFactorMap ()
 Returns ambient occlusion factor values texture. More...
 
float ambientOcclusionIntensity () const
 Returns the ambient occlusion intensity. More...
 
float ambientOcclusionRadius () const
 Returns the ambient occlusion radius. More...
 
float ambientOcclusionThreshold () const
 Returns the ambient occlusion threshold. More...
 
Qt3DRender::QTexture2D * blurredAmbientOcclusionFactorMap ()
 Returns blurred ambient occlusion factor values texture. 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...
 
QgsPostprocessingEntitypostprocessingEntity ()
 Returns the postprocessing entity. 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 setAmbientOcclusionEnabled (bool enabled)
 Sets whether Screen Space Ambient Occlusion will be enabled. More...
 
void setAmbientOcclusionIntensity (float intensity)
 Sets the ambient occlusion intensity. More...
 
void setAmbientOcclusionRadius (float radius)
 Sets the ambient occlusion radius. More...
 
void setAmbientOcclusionThreshold (float threshold)
 Sets the ambient occlusion threshold. 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

3

Container class that holds different objects related to shadow rendering

Note
Not available in Python bindings
Since
QGIS 3.16

Definition at line 61 of file qgsshadowrenderingframegraph.h.

Constructor & Destructor Documentation

◆ QgsShadowRenderingFrameGraph()

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

Constructor.

Definition at line 511 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 583 of file qgsshadowrenderingframegraph.cpp.

◆ ambientOcclusionEnabled()

bool QgsShadowRenderingFrameGraph::ambientOcclusionEnabled ( ) const
inline

Returns whether Screen Space Ambient Occlusion is enabled.

Since
QGIS 3.28

Definition at line 151 of file qgsshadowrenderingframegraph.h.

◆ ambientOcclusionFactorMap()

Qt3DRender::QTexture2D * QgsShadowRenderingFrameGraph::ambientOcclusionFactorMap ( )
inline

Returns ambient occlusion factor values texture.

Since
QGIS 3.28

Definition at line 83 of file qgsshadowrenderingframegraph.h.

◆ ambientOcclusionIntensity()

float QgsShadowRenderingFrameGraph::ambientOcclusionIntensity ( ) const
inline

Returns the ambient occlusion intensity.

Since
QGIS 3.28

Definition at line 163 of file qgsshadowrenderingframegraph.h.

◆ ambientOcclusionRadius()

float QgsShadowRenderingFrameGraph::ambientOcclusionRadius ( ) const
inline

Returns the ambient occlusion radius.

Since
QGIS 3.28

Definition at line 175 of file qgsshadowrenderingframegraph.h.

◆ ambientOcclusionThreshold()

float QgsShadowRenderingFrameGraph::ambientOcclusionThreshold ( ) const
inline

Returns the ambient occlusion threshold.

Since
QGIS 3.28

Definition at line 187 of file qgsshadowrenderingframegraph.h.

◆ blurredAmbientOcclusionFactorMap()

Qt3DRender::QTexture2D * QgsShadowRenderingFrameGraph::blurredAmbientOcclusionFactorMap ( )
inline

Returns blurred ambient occlusion factor values texture.

Since
QGIS 3.28

Definition at line 89 of file qgsshadowrenderingframegraph.h.

◆ castShadowsLayer()

Qt3DRender::QLayer * QgsShadowRenderingFrameGraph::castShadowsLayer ( )
inline

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

Definition at line 94 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 117 of file qgsshadowrenderingframegraph.h.

◆ forwardRenderColorTexture()

Qt3DRender::QTexture2D * QgsShadowRenderingFrameGraph::forwardRenderColorTexture ( )
inline

Returns the color texture of the forward rendering pass.

Definition at line 73 of file qgsshadowrenderingframegraph.h.

◆ forwardRenderDepthTexture()

Qt3DRender::QTexture2D * QgsShadowRenderingFrameGraph::forwardRenderDepthTexture ( )
inline

Returns the depth texture of the forward rendering pass.

Definition at line 75 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 96 of file qgsshadowrenderingframegraph.h.

◆ frameGraphRoot()

Qt3DRender::QFrameGraphNode * QgsShadowRenderingFrameGraph::frameGraphRoot ( )
inline

Returns the root of the frame graph object.

Definition at line 70 of file qgsshadowrenderingframegraph.h.

◆ frustumCullingEnabled()

bool QgsShadowRenderingFrameGraph::frustumCullingEnabled ( ) const
inline

Returns whether frustum culling is enabled.

Definition at line 121 of file qgsshadowrenderingframegraph.h.

◆ lightCamera()

Qt3DRender::QCamera * QgsShadowRenderingFrameGraph::lightCamera ( )
inline

Returns the light camera.

Definition at line 107 of file qgsshadowrenderingframegraph.h.

◆ mainCamera()

Qt3DRender::QCamera * QgsShadowRenderingFrameGraph::mainCamera ( )
inline

Returns the main camera.

Definition at line 105 of file qgsshadowrenderingframegraph.h.

◆ postprocessingEntity()

QgsPostprocessingEntity * QgsShadowRenderingFrameGraph::postprocessingEntity ( )
inline

Returns the postprocessing entity.

Definition at line 109 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 92 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 114 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 214 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 111 of file qgsshadowrenderingframegraph.h.

◆ setAmbientOcclusionEnabled()

void QgsShadowRenderingFrameGraph::setAmbientOcclusionEnabled ( bool  enabled)

Sets whether Screen Space Ambient Occlusion will be enabled.

Since
QGIS 3.28

Definition at line 707 of file qgsshadowrenderingframegraph.cpp.

◆ setAmbientOcclusionIntensity()

void QgsShadowRenderingFrameGraph::setAmbientOcclusionIntensity ( float  intensity)

Sets the ambient occlusion intensity.

Since
QGIS 3.28

Definition at line 714 of file qgsshadowrenderingframegraph.cpp.

◆ setAmbientOcclusionRadius()

void QgsShadowRenderingFrameGraph::setAmbientOcclusionRadius ( float  radius)

Sets the ambient occlusion radius.

Since
QGIS 3.28

Definition at line 720 of file qgsshadowrenderingframegraph.cpp.

◆ setAmbientOcclusionThreshold()

void QgsShadowRenderingFrameGraph::setAmbientOcclusionThreshold ( float  threshold)

Sets the ambient occlusion threshold.

Since
QGIS 3.28

Definition at line 726 of file qgsshadowrenderingframegraph.cpp.

◆ setClearColor()

void QgsShadowRenderingFrameGraph::setClearColor ( const QColor &  clearColor)

Sets the clear color of the scene (background color)

Definition at line 679 of file qgsshadowrenderingframegraph.cpp.

◆ setDebugOverlayEnabled()

void QgsShadowRenderingFrameGraph::setDebugOverlayEnabled ( bool  enabled)

Sets whether debug overlay is enabled.

Since
QGIS 3.26

Definition at line 823 of file qgsshadowrenderingframegraph.cpp.

◆ setFrustumCullingEnabled()

void QgsShadowRenderingFrameGraph::setFrustumCullingEnabled ( bool  enabled)

Sets whether frustum culling is enabled.

Definition at line 732 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 815 of file qgsshadowrenderingframegraph.cpp.

◆ setShadowBias()

void QgsShadowRenderingFrameGraph::setShadowBias ( float  shadowBias)

Sets the shadow bias value.

Definition at line 694 of file qgsshadowrenderingframegraph.cpp.

◆ setShadowMapResolution()

void QgsShadowRenderingFrameGraph::setShadowMapResolution ( int  resolution)

Sets the resolution of the shadow map.

Definition at line 700 of file qgsshadowrenderingframegraph.cpp.

◆ setShadowRenderingEnabled()

void QgsShadowRenderingFrameGraph::setShadowRenderingEnabled ( bool  enabled)

Sets whether the shadow rendering is enabled.

Definition at line 684 of file qgsshadowrenderingframegraph.cpp.

◆ setSize()

void QgsShadowRenderingFrameGraph::setSize ( QSize  s)

Sets the size of the buffers used for rendering.

Definition at line 800 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 776 of file qgsshadowrenderingframegraph.cpp.

◆ setupDirectionalLight()

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

Sets shadow rendering to use a directional light.

Definition at line 652 of file qgsshadowrenderingframegraph.cpp.

◆ setupEyeDomeLighting()

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

Sets eye dome lighting shading related settings.

Definition at line 743 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 753 of file qgsshadowrenderingframegraph.cpp.

◆ shadowBias()

float QgsShadowRenderingFrameGraph::shadowBias ( ) const
inline

Returns the shadow bias value.

Definition at line 131 of file qgsshadowrenderingframegraph.h.

◆ shadowMapResolution()

int QgsShadowRenderingFrameGraph::shadowMapResolution ( ) const
inline

Returns the shadow map resolution.

Definition at line 136 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 77 of file qgsshadowrenderingframegraph.h.

◆ shadowRenderingEnabled()

bool QgsShadowRenderingFrameGraph::shadowRenderingEnabled ( ) const
inline

Returns whether shadow rendering is enabled.

Definition at line 126 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 102 of file qgsshadowrenderingframegraph.h.


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