QClearBuffers Class

class Qt3DRender::QClearBuffers

Class to clear buffers. More...

Header:	#include <QClearBuffers>
CMake:	find_package(Qt6 COMPONENTS 3drender REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::3drender)
qmake:	QT += 3drender
Since:	Qt 5.7
Instantiated By:	ClearBuffers
Inherits:	Qt3DRender::QFrameGraphNode

• List of all members, including inherited members

Public Types

enum	BufferType { None, ColorBuffer, DepthBuffer, StencilBuffer, DepthStencilBuffer, …, AllBuffers }
flags	BufferTypeFlags

Properties

buffers : BufferType clearColor : QColor clearDepthValue : float

clearStencilValue : int colorBuffer : Qt3DRender::QRenderTargetOutput*

Public Functions

	QClearBuffers(Qt3DCore::QNode *parent = nullptr)
Qt3DRender::QClearBuffers::BufferType	buffers() const
QColor	clearColor() const
float	clearDepthValue() const
int	clearStencilValue() const
Qt3DRender::QRenderTargetOutput *	colorBuffer() const

Public Slots

void	setBuffers(Qt3DRender::QClearBuffers::BufferType buffers)
void	setClearColor(const QColor &color)
void	setClearDepthValue(float clearDepthValue)
void	setClearStencilValue(int clearStencilValue)
void	setColorBuffer(Qt3DRender::QRenderTargetOutput *buffer)

Signals

void	buffersChanged(Qt3DRender::QClearBuffers::BufferType buffers)
void	clearColorChanged(const QColor &color)
void	clearDepthValueChanged(float clearDepthValue)
void	clearStencilValueChanged(int clearStencilValue)
void	colorBufferChanged(Qt3DRender::QRenderTargetOutput *buffer)

Detailed Description

A Qt3DRender::QClearBuffers FrameGraph node enables clearing of the specific render target buffers with specific values.

Member Type Documentation

enum QClearBuffers::BufferTypeflags QClearBuffers::BufferTypeFlags

This enum type describes types of buffer to be cleared.

Constant	Value	Description
Qt3DRender::QClearBuffers::None	0	No buffers will be cleared
Qt3DRender::QClearBuffers::ColorBuffer	(1 << 0)	Clear color buffers
Qt3DRender::QClearBuffers::DepthBuffer	(1 << 1)	Clear depth buffer
Qt3DRender::QClearBuffers::StencilBuffer	(1 << 2)	Clear stencil buffer
Qt3DRender::QClearBuffers::DepthStencilBuffer	DepthBuffer | StencilBuffer	Clear depth and stencil buffers
Qt3DRender::QClearBuffers::ColorDepthBuffer	ColorBuffer | DepthBuffer	Clear color and depth buffers
Qt3DRender::QClearBuffers::ColorDepthStencilBuffer	ColorBuffer | DepthStencilBuffer	Clear color, depth and stencil buffers
Qt3DRender::QClearBuffers::AllBuffers	0xFFFFFFFF	Clear all buffers

The BufferTypeFlags type is a typedef for QFlags<BufferType>. It stores an OR combination of BufferType values.

Member Function Documentation

QClearBuffers::QClearBuffers(Qt3DCore::QNode *parent = nullptr)

The constructor creates an instance with the specified parent.