QRenderSurfaceSelector Class

class Qt3DRender::QRenderSurfaceSelector

Provides a way of specifying the render surface. More...

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

• List of all members, including inherited members

Properties

• externalRenderTargetSize : QSize
• surface : QObject*
• surfacePixelRatio : float

Public Functions

	QRenderSurfaceSelector(Qt3DCore::QNode *parent = nullptr)
QSize	externalRenderTargetSize() const
QObject *	surface() const
float	surfacePixelRatio() const

Public Slots

void	setExternalRenderTargetSize(const QSize &size)
void	setSurface(QObject *surfaceObject)
void	setSurfacePixelRatio(float ratio)

Signals

void	externalRenderTargetSizeChanged(const QSize &size)
void	surfaceChanged(QObject *surface)
void	surfacePixelRatioChanged(float ratio)

Detailed Description

The Qt3DRender::QRenderSurfaceSelector can be used to select the surface, where Qt3D renders the content. The surface can either be window surface or offscreen surface. The externalRenderTargetSize is used to specify the actual size of the surface when offscreen surface is used.

When DPI scaling is used by the system, the logical surface size, which is used by mouse events, and the actual 'physical' size of the surface can differ. The surfacePixelRatio is the factor to convert the logical size to the physical size.

See also QWindow, QOffscreenSurface, and QSurface.

Member Function Documentation

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

Constructs QRenderSurfaceSelector with given parent.

[slot] void QRenderSurfaceSelector::setExternalRenderTargetSize(const QSize &size)

Sets render target size if different than underlying surface size. Tells picking the correct size.

Note: Setter function for property externalRenderTargetSize.

See also externalRenderTargetSize().

[slot] void QRenderSurfaceSelector::setSurface(QObject *surfaceObject)

Sets surfaceObject.

Note: Setter function for property surface.

See also surface().