QGIS API Documentation 4.1.0-Master (26185ffb827)
Loading...
Searching...
No Matches
QgsPostprocessingRenderView Class Reference

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

#include <qgspostprocessingrenderview.h>

Inheritance diagram for QgsPostprocessingRenderView:

Public Member Functions

 QgsPostprocessingRenderView (const QString &viewName, QgsFrameGraph *frameGraph, QSize size, Qt3DCore::QEntity *rootSceneEntity)
 Default constructor.
QgsPostprocessingEntityentity () const
 Returns the QT3D entity used to do the rendering.
QgsOverlayTextureRenderViewoverlayTextureRenderView () const
 Returns overlay texture render view.
Qt3DRender::QRenderCapture * renderCapture () const
 Returns the render capture object used to take an image of the postprocessing buffer of the scene.
void setOffScreenRenderCaptureEnabled (bool enabled)
 Sets whether it will be possible to render to an image.
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.
QgsAbstractRenderViewoperator= (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 postprocessing rendering.

Note
Not available in Python bindings

The postprocessing pass apply post-processing effects (EDL, SSAO).

Since
QGIS 4.2

Definition at line 53 of file qgspostprocessingrenderview.h.

Constructor & Destructor Documentation

◆ QgsPostprocessingRenderView()

QgsPostprocessingRenderView::QgsPostprocessingRenderView ( const QString & viewName,
QgsFrameGraph * frameGraph,
QSize size,
Qt3DCore::QEntity * rootSceneEntity )

Default constructor.

Definition at line 37 of file qgspostprocessingrenderview.cpp.

Member Function Documentation

◆ entity()

QgsPostprocessingEntity * QgsPostprocessingRenderView::entity ( ) const

Returns the QT3D entity used to do the rendering.

Definition at line 170 of file qgspostprocessingrenderview.cpp.

◆ overlayTextureRenderView()

QgsOverlayTextureRenderView * QgsPostprocessingRenderView::overlayTextureRenderView ( ) const
inline

Returns overlay texture render view.

Definition at line 73 of file qgspostprocessingrenderview.h.

◆ renderCapture()

Qt3DRender::QRenderCapture * QgsPostprocessingRenderView::renderCapture ( ) const

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

Definition at line 165 of file qgspostprocessingrenderview.cpp.

◆ setOffScreenRenderCaptureEnabled()

void QgsPostprocessingRenderView::setOffScreenRenderCaptureEnabled ( bool enabled)

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

Definition at line 65 of file qgspostprocessingrenderview.cpp.

◆ updateWindowResize()

void QgsPostprocessingRenderView::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 58 of file qgspostprocessingrenderview.cpp.


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