QgsForwardRenderView Class Reference

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

#include <qgsforwardrenderview.h>

Inheritance diagram for QgsForwardRenderView:

Public Member Functions
	QgsForwardRenderView (const QString &viewName, Qt3DRender::QCamera *mainCamera)
	Constructor with 3D scene camera.
void	addClipPlanes (int nrClipPlanes)
	Setups nrClipPlanes clip planes in the forward pass to enable OpenGL clipping.
Qt3DRender::QTexture2D *	colorTexture () const
	Returns forward color texture.
Qt3DRender::QTexture2D *	depthTexture () const
	Returns forward depth texture.
bool	isFrustumCullingEnabled () const
	Returns whether frustum culling is enabled.
void	removeClipPlanes ()
	Disables OpenGL clipping.
Qt3DRender::QLayer *	renderLayer ()
	Returns a layer object used to indicate that the object is transparent.
Qt3DRender::QRenderTargetSelector *	renderTargetSelector ()
	Returns current render target selector.
void	setClearColor (const QColor &clearColor)
	Sets the clear color of the scene (background color)
void	setDebugOverlayEnabled (bool enabled)
	Sets whether debug overlay is enabled.
void	setFrustumCullingEnabled (bool enabled)
	Sets whether frustum culling is enabled.
Qt3DRender::QLayer *	transparentObjectLayer ()
	Returns a layer object used to indicate that the object is transparent.
virtual void	updateWindowResize (int width, int height) override
	Called when 3D window is resized.
Public Member Functions inherited from QgsAbstractRenderView
	QgsAbstractRenderView (const QgsAbstractRenderView &other)=delete
	Disabled copy constructor.
	QgsAbstractRenderView (const QString &viewName)
	Constructor for QgsAbstractRenderView with the specified parent object.
virtual	~QgsAbstractRenderView ()
	Default destructor.
virtual bool	isEnabled () const
	Returns true if render view is enabled.
QgsAbstractRenderView &	operator= (const QgsAbstractRenderView &other)=delete
	Disabled operator=.
virtual void	setEnabled (bool enable)
	Enable or disable via enable the render view sub tree.
QPointer< Qt3DRender::QFrameGraphNode >	topGraphNode () const
	Returns the top node of this render view branch. Will be used to register the render view.

Additional Inherited Members
Protected Attributes inherited from QgsAbstractRenderView
Qt3DRender::QSubtreeEnabler *	mRendererEnabler = nullptr
QPointer< Qt3DRender::QFrameGraphNode >	mRoot
QString	mViewName

Detailed Description

Container class that holds different objects related to forward rendering.

Note

Not available in Python bindings

Since

QGIS 3.44

Definition at line 47 of file qgsforwardrenderview.h.

Constructor & Destructor Documentation

QgsForwardRenderView()

QgsForwardRenderView::QgsForwardRenderView	(	const QString &	viewName,
		Qt3DRender::QCamera *	mainCamera
	)

Constructor with 3D scene camera.

Definition at line 44 of file qgsforwardrenderview.cpp.

Member Function Documentation

addClipPlanes()

void QgsForwardRenderView::addClipPlanes

(

int

nrClipPlanes

)

Setups nrClipPlanes clip planes in the forward pass to enable OpenGL clipping.

If nrClipPlanes is equal to 0, the clipping is disabled.

See also

removeClipPlanes()

Since

QGIS 3.40

Definition at line 279 of file qgsforwardrenderview.cpp.

colorTexture()

Qt3DRender::QTexture2D * QgsForwardRenderView::colorTexture

(

)

const

Returns forward color texture.

Definition at line 263 of file qgsforwardrenderview.cpp.

depthTexture()

Qt3DRender::QTexture2D * QgsForwardRenderView::depthTexture

(

)

const

Returns forward depth texture.

Definition at line 258 of file qgsforwardrenderview.cpp.

isFrustumCullingEnabled()

bool QgsForwardRenderView::isFrustumCullingEnabled ( ) const

inline

Returns whether frustum culling is enabled.

Definition at line 63 of file qgsforwardrenderview.h.

removeClipPlanes()

void QgsForwardRenderView::removeClipPlanes

(

)

Disables OpenGL clipping.

See also

addClipPlanes()

Since

QGIS 3.40

Definition at line 268 of file qgsforwardrenderview.cpp.

renderLayer()

Qt3DRender::QLayer * QgsForwardRenderView::renderLayer ( )

inline

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

Definition at line 54 of file qgsforwardrenderview.h.

renderTargetSelector()

Qt3DRender::QRenderTargetSelector * QgsForwardRenderView::renderTargetSelector ( )

inline

Returns current render target selector.

Definition at line 71 of file qgsforwardrenderview.h.

setClearColor()

void QgsForwardRenderView::setClearColor

(

const QColor &

clearColor

)

Sets the clear color of the scene (background color)

Definition at line 238 of file qgsforwardrenderview.cpp.

setDebugOverlayEnabled()

void QgsForwardRenderView::setDebugOverlayEnabled

(

bool

enabled

)

Sets whether debug overlay is enabled.

Definition at line 253 of file qgsforwardrenderview.cpp.

setFrustumCullingEnabled()

void QgsForwardRenderView::setFrustumCullingEnabled

(

bool

enabled

)

Sets whether frustum culling is enabled.

Definition at line 244 of file qgsforwardrenderview.cpp.

transparentObjectLayer()

Qt3DRender::QLayer * QgsForwardRenderView::transparentObjectLayer ( )

inline

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

Definition at line 57 of file qgsforwardrenderview.h.

updateWindowResize()

void QgsForwardRenderView::updateWindowResize ( int  width, int  height  )

overridevirtual

Called when 3D window is resized.

Render views may update their textures accordingly. Default implementation does nothing.

Reimplemented from QgsAbstractRenderView.

Definition at line 231 of file qgsforwardrenderview.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/framegraph/qgsforwardrenderview.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/framegraph/qgsforwardrenderview.cpp