class QClearBuffers

Class to clear buffers. More…

Synopsis

Properties

• buffersᅟ

• clearColorᅟ

• clearDepthValueᅟ

• clearStencilValueᅟ

• colorBufferᅟ

Methods

• def __init__()

• def buffers()

• def clearColor()

• def clearDepthValue()

• def clearStencilValue()

• def colorBuffer()

Slots

• def setBuffers()

• def setClearColor()

• def setClearDepthValue()

• def setClearStencilValue()

• def setColorBuffer()

Signals

• def buffersChanged()

• def clearColorChanged()

• def clearDepthValueChanged()

• def clearStencilValueChanged()

• def colorBufferChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

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

class BufferType

(inherits enum.Flag) This enum type describes types of buffer to be cleared.

Constant	Description
Qt3DRender.QClearBuffers.None	No buffers will be cleared
Qt3DRender.QClearBuffers.ColorBuffer	Clear color buffers
Qt3DRender.QClearBuffers.DepthBuffer	Clear depth buffer
Qt3DRender.QClearBuffers.StencilBuffer	Clear stencil buffer
Qt3DRender.QClearBuffers.DepthStencilBuffer	Clear depth and stencil buffers
Qt3DRender.QClearBuffers.ColorDepthBuffer	Clear color and depth buffers
Qt3DRender.QClearBuffers.ColorDepthStencilBuffer	Clear color, depth and stencil buffers
Qt3DRender.QClearBuffers.AllBuffers	Clear all buffers

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property buffersᅟ: Qt3DRender.QClearBuffers.BufferType

Specifies the buffer type to be used.

Access functions:

• buffers()

• setBuffers()

• Signal buffersChanged()

property clearColorᅟ: QColor

Specifies the clear color to be used.

Access functions:

• clearColor()

• setClearColor()

• Signal clearColorChanged()

property clearDepthValueᅟ: float

Specifies the clear depth value to be used.

Access functions:

• clearDepthValue()

• setClearDepthValue()

• Signal clearDepthValueChanged()

property clearStencilValueᅟ: int

Specifies the stencil value to be used.

Access functions:

• clearStencilValue()

• setClearStencilValue()

• Signal clearStencilValueChanged()

property colorBufferᅟ: QRenderTargetOutput

Specifies a specific color buffer to clear. If set to NULL (default), and ColorBuffer flag is set, all color buffers will be cleared.

Access functions:

• colorBuffer()

• setColorBuffer()

• Signal colorBufferChanged()

__init__([parent=None])

Parameters:

parent – QNode

The constructor creates an instance with the specified parent.

buffers()

Return type:

BufferType

See also

setBuffers()

Getter of property buffersᅟ .

buffersChanged(buffers)

Parameters:

buffers – BufferType

Notification signal of property buffersᅟ .

clearColor()

Return type:

QColor

See also

setClearColor()

Getter of property clearColorᅟ .

clearColorChanged(color)

Parameters:

color – QColor

Notification signal of property clearColorᅟ .

clearDepthValue()

Return type:

float

See also

setClearDepthValue()

Getter of property clearDepthValueᅟ .

clearDepthValueChanged(clearDepthValue)

Parameters:

clearDepthValue – float

Notification signal of property clearDepthValueᅟ .

clearStencilValue()

Return type:

int

See also

setClearStencilValue()

Getter of property clearStencilValueᅟ .

clearStencilValueChanged(clearStencilValue)

Parameters:

clearStencilValue – int

Notification signal of property clearStencilValueᅟ .

colorBuffer()

Return type:

QRenderTargetOutput

See also

setColorBuffer()

Getter of property colorBufferᅟ .

colorBufferChanged(buffer)

Parameters:

buffer – QRenderTargetOutput

Notification signal of property colorBufferᅟ .

setBuffers(buffers)

Parameters:

buffers – BufferType

See also

buffers()

Setter of property buffersᅟ .

setClearColor(color)

Parameters:

color – QColor

See also

clearColor()

Setter of property clearColorᅟ .

setClearDepthValue(clearDepthValue)

Parameters:

clearDepthValue – float

See also

clearDepthValue()

Setter of property clearDepthValueᅟ .

setClearStencilValue(clearStencilValue)

Parameters:

clearStencilValue – int

See also

clearStencilValue()

Setter of property clearStencilValueᅟ .

setColorBuffer(buffer)

Parameters:

buffer – QRenderTargetOutput

See also

colorBuffer()

Setter of property colorBufferᅟ .