QBlitFramebuffer#
FrameGraph node to transfer a rectangle of pixel values from one region of a render target to another. More…
Synopsis#
Properties#
Functions#
def
destination()def
destinationAttachmentPoint()def
destinationRect()def
interpolationMethod()def
setDestination(destination)def
setDestinationAttachmentPoint(destinationAttachmentPoint)def
setDestinationRect(destinationRect)def
setInterpolationMethod(interpolationMethod)def
setSource(source)def
setSourceAttachmentPoint(sourceAttachmentPoint)def
setSourceRect(sourceRect)def
source()def
sourceAttachmentPoint()def
sourceRect()
Signals#
def
destinationChanged()def
destinationRectChanged()def
interpolationMethodChanged()def
sourceAttachmentPointChanged()def
sourceChanged()def
sourceRectChanged()
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#
This node inserts a glBlitFrameBuffer or an equivalent into the command stream. This provides a more efficient method for copying rectangles between textures or surface backbuffers wrapped by QRenderTarget than drawing textured quads. It also supports scaling with the specified interpolation method.
Note
In practice the QBlitFramebuffer node will often be used in combination with QNoDraw since a blit should not involve issuing draw calls for any entities.
- class PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer([parent=None])#
- Parameters:
parent –
PySide6.Qt3DCore.Qt3DCore.QNode
Constructs a new QBlitFramebuffer with the given 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.QBlitFramebuffer.destination: PySide6.Qt3DRender.Qt3DRender.QRenderTarget#
Specifies the destination render target. When not set, the destination is assumed to be the default framebuffer (i.e. the backbuffer of the current surface), if there is one.
Note
the source and destination must not refer to the same render target.
- Access functions:
destination()setDestination(destination)Signal
destinationChanged()
- property PᅟySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationAttachmentPoint: AttachmentPoint#
Specifies the target attachment point.
- Access functions:
setDestinationAttachmentPoint(destinationAttachmentPoint)Signal
destinationAttachmentPointChanged()
- property PᅟySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationRect: PySide6.QtCore.QRectF#
Specifies the destination rectangle. The coordinates are assumed to follow the normal Qt coordinate system, meaning Y runs from top to bottom.
- Access functions:
setDestinationRect(destinationRect)Signal
destinationRectChanged()
- property PᅟySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.interpolationMethod: InterpolationMethod#
- Access functions:
setInterpolationMethod(interpolationMethod)Signal
interpolationMethodChanged()
- property PᅟySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.source: PySide6.Qt3DRender.Qt3DRender.QRenderTarget#
Specifies the source render target. When not set, the source is assumed to be the default framebuffer (i.e. the backbuffer of the current surface), if there is one.
Note
the source and destination must not refer to the same render target.
- Access functions:
source()setSource(source)Signal
sourceChanged()
- property PᅟySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceAttachmentPoint: AttachmentPoint#
Specifies the source attachment point.
- Access functions:
setSourceAttachmentPoint(sourceAttachmentPoint)Signal
sourceAttachmentPointChanged()
- property PᅟySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceRect: PySide6.QtCore.QRectF#
Specifies the source rectangle. The coordinates are assumed to follow the normal Qt coordinate system, meaning Y runs from top to bottom.
- Access functions:
sourceRect()setSourceRect(sourceRect)Signal
sourceRectChanged()
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.InterpolationMethod#
Specifies the interpolation applied if the image is stretched.
Constant
Description
Qt3DRender.QBlitFramebuffer.Nearest
Nearest-neighbor interpolation.
Qt3DRender.QBlitFramebuffer.Linear
Linear interpolation.
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destination()#
- Return type:
Returns the destination render target.
See also
Getter of property destination .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationAttachmentPoint()#
- Return type:
Returns the destination attachment point.
See also
Getter of property destinationAttachmentPoint .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationAttachmentPointChanged()#
Notification signal of property destinationAttachmentPoint .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationChanged()#
Notification signal of property destination .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationRect()#
- Return type:
Returns the destination rectangle.
See also
Getter of property destinationRect .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.destinationRectChanged()#
Notification signal of property destinationRect .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.interpolationMethod()#
- Return type:
Returns the interpolation method.
See also
Getter of property interpolationMethod .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.interpolationMethodChanged()#
Notification signal of property interpolationMethod .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setDestination(destination)#
- Parameters:
destination –
PySide6.Qt3DRender.Qt3DRender.QRenderTarget
Sets the destination render target. The default value is nullptr, in which case the destination is assumed to be be the default framebuffer (i.e. the backbuffer of the current surface), if there is one.
Note
the source and destination must not refer to the same render target.
Note
As with other nodes, destination gets automatically parented to the QBlitFramebuffer instance when no parent has been set. The lifetime is also tracked, meaning the destination reverts to nullptr in case the currently set destination is destroyed.
See also
Setter of property destination .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setDestinationAttachmentPoint(destinationAttachmentPoint)#
- Parameters:
destinationAttachmentPoint –
AttachmentPoint
Sets the destinationAttachmentPoint. Defaults to Qt3DRender::QRenderTargetOutput::AttachmentPoint::Color0.
See also
Setter of property destinationAttachmentPoint .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setDestinationRect(destinationRect)#
- Parameters:
destinationRect –
PySide6.QtCore.QRectF
Sets the destination rectangle to outputRect. The coordinates are assumed to follow the normal Qt coordinate system, meaning Y runs from top to bottom.
See also
Setter of property destinationRect .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setInterpolationMethod(interpolationMethod)#
- Parameters:
interpolationMethod –
InterpolationMethod
Sets the interpolationMethod that is applied if the image is stretched. Defaults to Linear.
See also
Setter of property interpolationMethod .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setSource(source)#
- Parameters:
Sets the source render target. The default value is nullptr, in which case the source is assumed to be be the default framebuffer (i.e. the backbuffer of the current surface), if there is one.
Note
the source and destination must not refer to the same render target.
Note
As with other nodes, source gets automatically parented to the QBlitFramebuffer instance when no parent has been set. The lifetime is also tracked, meaning the source reverts to nullptr in case the currently set source is destroyed.
See also
Setter of property source .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setSourceAttachmentPoint(sourceAttachmentPoint)#
- Parameters:
sourceAttachmentPoint –
AttachmentPoint
Sets the sourceAttachmentPoint. Defaults to Qt3DRender::QRenderTargetOutput::AttachmentPoint::Color0.
See also
Setter of property sourceAttachmentPoint .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.setSourceRect(sourceRect)#
- Parameters:
sourceRect –
PySide6.QtCore.QRectF
Sets the source rectangle to inputRect. The coordinates are assumed to follow the normal Qt coordinate system, meaning Y runs from top to bottom.
See also
Setter of property sourceRect .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.source()#
- Return type:
Returns the source render target.
See also
Getter of property source .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceAttachmentPoint()#
- Return type:
Returns the source attachment point.
See also
Getter of property sourceAttachmentPoint .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceAttachmentPointChanged()#
Notification signal of property sourceAttachmentPoint .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceChanged()#
Notification signal of property source .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceRect()#
- Return type:
Returns the source rectangle.
See also
Getter of property sourceRect .
- PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer.sourceRectChanged()#
Notification signal of property sourceRect .