PySide6.Qt3DRender.Qt3DRender.QBlitFramebuffer

class QBlitFramebuffer

FrameGraph node to transfer a rectangle of pixel values from one region of a render target to another.

Details

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.

Synopsis

Properties

• destinationᅟ

• destinationAttachmentPointᅟ

• destinationRectᅟ

• interpolationMethodᅟ

• sourceᅟ

• sourceAttachmentPointᅟ

• sourceRectᅟ

Methods

• def __init__()

• def destination()

• def destinationAttachmentPoint()

• def destinationRect()

• def interpolationMethod()

• def setDestination()

• def setDestinationAttachmentPoint()

• def setDestinationRect()

• def setInterpolationMethod()

• def setSource()

• def setSourceAttachmentPoint()

• def setSourceRect()

• def source()

• def sourceAttachmentPoint()

• def sourceRect()

Signals

• def destinationAttachmentPointChanged()

• 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

class InterpolationMethod

Specifies the interpolation applied if the image is stretched.

Constant	Description
Qt3DRender.QBlitFramebuffer.Nearest	Nearest-neighbor interpolation.
Qt3DRender.QBlitFramebuffer.Linear	Linear interpolation.

Note

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

property destinationᅟ: 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()

• Signal destinationChanged()

property destinationAttachmentPointᅟ: Qt3DRender.QRenderTargetOutput.AttachmentPoint

Specifies the target attachment point.

Access functions:

• destinationAttachmentPoint()

• setDestinationAttachmentPoint()

• Signal destinationAttachmentPointChanged()

property destinationRectᅟ: 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:

• destinationRect()

• setDestinationRect()

• Signal destinationRectChanged()

property interpolationMethodᅟ: Qt3DRender.QBlitFramebuffer.InterpolationMethod

Access functions:

• interpolationMethod()

• setInterpolationMethod()

• Signal interpolationMethodChanged()

property sourceᅟ: 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()

• Signal sourceChanged()

property sourceAttachmentPointᅟ: Qt3DRender.QRenderTargetOutput.AttachmentPoint

Specifies the source attachment point.

Access functions:

• sourceAttachmentPoint()

• setSourceAttachmentPoint()

• Signal sourceAttachmentPointChanged()

property sourceRectᅟ: 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()

• Signal sourceRectChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new QBlitFramebuffer with the given parent.

destination()

Return type:

QRenderTarget

Returns the destination render target.

See also

setDestination()

Getter of property destinationᅟ .

destinationAttachmentPoint()

Return type:

AttachmentPoint

Returns the destination attachment point.

See also

setDestinationAttachmentPoint()

Getter of property destinationAttachmentPointᅟ .

destinationAttachmentPointChanged()

Notification signal of property destinationAttachmentPointᅟ .

destinationChanged()

Notification signal of property destinationᅟ .

destinationRect()

Return type:

QRectF

Returns the destination rectangle.

See also

setDestinationRect()

Getter of property destinationRectᅟ .

destinationRectChanged()

Notification signal of property destinationRectᅟ .

interpolationMethod()

Return type:

InterpolationMethod

Returns the interpolation method.

See also

setInterpolationMethod()

Getter of property interpolationMethodᅟ .

interpolationMethodChanged()

Notification signal of property interpolationMethodᅟ .

setDestination(destination)

Parameters:

destination – 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

destination()

Setter of property destinationᅟ .

setDestinationAttachmentPoint(destinationAttachmentPoint)

Parameters:

destinationAttachmentPoint – AttachmentPoint

Sets the destinationAttachmentPoint. Defaults to Qt3DRender::QRenderTargetOutput::AttachmentPoint::Color0.

See also

destinationAttachmentPoint()

Setter of property destinationAttachmentPointᅟ .

setDestinationRect(destinationRect)

Parameters:

destinationRect – 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

destinationRect()

Setter of property destinationRectᅟ .

setInterpolationMethod(interpolationMethod)

Parameters:

interpolationMethod – InterpolationMethod

Sets the interpolationMethod that is applied if the image is stretched. Defaults to Linear.

See also

interpolationMethod()

Setter of property interpolationMethodᅟ .

setSource(source)

Parameters:

source – QRenderTarget

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

source()

Setter of property sourceᅟ .

setSourceAttachmentPoint(sourceAttachmentPoint)

Parameters:

sourceAttachmentPoint – AttachmentPoint

Sets the sourceAttachmentPoint. Defaults to Qt3DRender::QRenderTargetOutput::AttachmentPoint::Color0.

See also

sourceAttachmentPoint()

Setter of property sourceAttachmentPointᅟ .

setSourceRect(sourceRect)

Parameters:

sourceRect – 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

sourceRect()

Setter of property sourceRectᅟ .

source()

Return type:

QRenderTarget

Returns the source render target.

See also

setSource()

Getter of property sourceᅟ .

sourceAttachmentPoint()

Return type:

AttachmentPoint

Returns the source attachment point.

See also

setSourceAttachmentPoint()

Getter of property sourceAttachmentPointᅟ .

sourceAttachmentPointChanged()

Notification signal of property sourceAttachmentPointᅟ .

sourceChanged()

Notification signal of property sourceᅟ .

sourceRect()

Return type:

QRectF

Returns the source rectangle.

See also

setSourceRect()

Getter of property sourceRectᅟ .

sourceRectChanged()

Notification signal of property sourceRectᅟ .