QClearBuffers#

Class to clear buffers. More…

Synopsis#

Properties#

buffers
clearColor
clearDepthValue
clearStencilValue
colorBuffer

Functions#

def buffers ()
def clearColor ()
def clearDepthValue ()
def clearStencilValue ()
def colorBuffer ()

Slots#

def setBuffers (buffers)
def setClearColor (color)
def setClearDepthValue (clearDepthValue)
def setClearStencilValue (clearStencilValue)
def setColorBuffer (buffer)

Signals#

def buffersChanged (buffers)
def clearColorChanged (color)
def clearDepthValueChanged (clearDepthValue)
def clearStencilValueChanged (clearStencilValue)
def colorBufferChanged (buffer)

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 PySide6.Qt3DRender.Qt3DRender.QClearBuffers([parent=None])#

Parameters:: parent – PySide6.Qt3DCore.Qt3DCore.QNode

The constructor creates an instance with the specified parent.

Note

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

property PᅟySide6.Qt3DRender.Qt3DRender.QClearBuffers.buffers: BufferType#

Specifies the buffer type to be used.

Access functions:

buffers ()
setBuffers (buffers)
Signal buffersChanged (buffers)

property PᅟySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearColor: PySide6.QtGui.QColor#

Specifies the clear color to be used.

Access functions:

clearColor ()
setClearColor (color)
Signal clearColorChanged (color)

property PᅟySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearDepthValue: float#

Specifies the clear depth value to be used.

Access functions:

clearDepthValue ()
setClearDepthValue (clearDepthValue)
Signal clearDepthValueChanged (clearDepthValue)

property PᅟySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearStencilValue: int#

Specifies the stencil value to be used.

Access functions:

clearStencilValue ()
setClearStencilValue (clearStencilValue)
Signal clearStencilValueChanged (clearStencilValue)

property PᅟySide6.Qt3DRender.Qt3DRender.QClearBuffers.colorBuffer: PySide6.Qt3DRender.Qt3DRender.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 (buffer)
Signal colorBufferChanged (buffer)

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.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

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

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.buffers()#

Return type:: BufferType

See also

setBuffers()

Getter of property buffers .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.buffersChanged(buffers)#

Parameters:: buffers – BufferType

Notification signal of property buffers .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearColor()#

Return type:: PySide6.QtGui.QColor

See also

setClearColor()

Getter of property clearColor .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearColorChanged(color)#

Parameters:: color – PySide6.QtGui.QColor

Notification signal of property clearColor .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearDepthValue()#

Return type:: float

See also

setClearDepthValue()

Getter of property clearDepthValue .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearDepthValueChanged(clearDepthValue)#

Parameters:: clearDepthValue – float

Notification signal of property clearDepthValue .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearStencilValue()#

Return type:: int

See also

setClearStencilValue()

Getter of property clearStencilValue .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.clearStencilValueChanged(clearStencilValue)#

Parameters:: clearStencilValue – int

Notification signal of property clearStencilValue .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.colorBuffer()#

Return type:: PySide6.Qt3DRender.Qt3DRender.QRenderTargetOutput

See also

setColorBuffer()

Getter of property colorBuffer .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.colorBufferChanged(buffer)#

Parameters:: buffer – PySide6.Qt3DRender.Qt3DRender.QRenderTargetOutput

Notification signal of property colorBuffer .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.setBuffers(buffers)#

Parameters:: buffers – BufferType

See also

buffers()

Setter of property buffers .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.setClearColor(color)#

Parameters:: color – PySide6.QtGui.QColor

See also

clearColor()

Setter of property clearColor .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.setClearDepthValue(clearDepthValue)#

Parameters:: clearDepthValue – float

See also

clearDepthValue()

Setter of property clearDepthValue .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.setClearStencilValue(clearStencilValue)#

Parameters:: clearStencilValue – int

See also

clearStencilValue()

Setter of property clearStencilValue .

PySide6.Qt3DRender.Qt3DRender.QClearBuffers.setColorBuffer(buffer)#

Parameters:: buffer – PySide6.Qt3DRender.Qt3DRender.QRenderTargetOutput

See also

colorBuffer()

Setter of property colorBuffer .