The QOpenGLPaintDevice class enables painting to an OpenGL context using QPainter. More...

#include <qopenglpaintdevice.h>

Inheritance diagram for QOpenGLPaintDevice:

Collaboration diagram for QOpenGLPaintDevice:

Public Member Functions
	QOpenGLPaintDevice ()
	Constructs a QOpenGLPaintDevice.

	QOpenGLPaintDevice (const QSize &size)
	Constructs a QOpenGLPaintDevice with the given size.

	QOpenGLPaintDevice (int width, int height)
	Constructs a QOpenGLPaintDevice with the given width and height.

	~QOpenGLPaintDevice ()
	Destroys the QOpenGLPaintDevice.

int	devType () const override

QPaintEngine *	paintEngine () const override
	\reimp

QOpenGLContext *	context () const
	Returns the OpenGL context associated with the paint device.

QSize	size () const
	Returns the pixel size of the paint device.

void	setSize (const QSize &size)
	Sets the pixel size of the paint device to size.

void	setDevicePixelRatio (qreal devicePixelRatio)
	Sets the device pixel ratio for the paint device to devicePixelRatio.

qreal	dotsPerMeterX () const
	Returns the number of pixels per meter horizontally.

qreal	dotsPerMeterY () const
	Returns the number of pixels per meter vertically.

void	setDotsPerMeterX (qreal)
	Sets the number of pixels per meter horizontally to dpmx.

void	setDotsPerMeterY (qreal)
	Sets the number of pixels per meter vertically to dpmy.

void	setPaintFlipped (bool flipped)
	Sets whether painting should be flipped around the Y-axis or not to flipped.

bool	paintFlipped () const
	Returns `true` if painting is flipped around the Y-axis.

virtual void	ensureActiveTarget ()
	This virtual method is provided as a callback to allow re-binding a target frame buffer object or context when different QOpenGLPaintDevice instances are issuing draw calls alternately.

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
	QOpenGLPaintDevice (QOpenGLPaintDevicePrivate &dd)

int	metric (QPaintDevice::PaintDeviceMetric metric) const override
	\reimp

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

virtual void	initPainter (QPainter *painter) const

virtual QPaintDevice *	redirected (QPoint *offset) const

virtual QPainter *	sharedPainter () const

Protected Attributes
QScopedPointer< QOpenGLPaintDevicePrivate >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Additional Inherited Members
Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Detailed Description

The QOpenGLPaintDevice class enables painting to an OpenGL context using QPainter.

Since: 5.0 \inmodule QtOpenGL

The QOpenGLPaintDevice uses the current QOpenGL context to render QPainter draw commands. The context is captured upon construction. It requires support for OpenGL (ES) 2.0 or higher.

Definition at line 19 of file qopenglpaintdevice.h.

Constructor & Destructor Documentation

◆ QOpenGLPaintDevice() [1/4]

QOpenGLPaintDevice::QOpenGLPaintDevice ( )

Constructs a QOpenGLPaintDevice.

The QOpenGLPaintDevice is only valid for the current context.

See also: QOpenGLContext::currentContext()

Definition at line 79 of file qopenglpaintdevice.cpp.

◆ QOpenGLPaintDevice() [2/4]

QOpenGLPaintDevice::QOpenGLPaintDevice ( const QSize & size )

explicit

Constructs a QOpenGLPaintDevice with the given size.

The QOpenGLPaintDevice is only valid for the current context.

See also: QOpenGLContext::currentContext()

Definition at line 91 of file qopenglpaintdevice.cpp.

◆ QOpenGLPaintDevice() [3/4]

QOpenGLPaintDevice::QOpenGLPaintDevice	(	int	width,
		int	height )

Constructs a QOpenGLPaintDevice with the given width and height.

The QOpenGLPaintDevice is only valid for the current context.

See also: QOpenGLContext::currentContext()

Definition at line 103 of file qopenglpaintdevice.cpp.

◆ ~QOpenGLPaintDevice()

QOpenGLPaintDevice::~QOpenGLPaintDevice ( )

Destroys the QOpenGLPaintDevice.

Definition at line 120 of file qopenglpaintdevice.cpp.

References d_ptr, and QOpenGLPaintDevicePrivate::engine.

◆ QOpenGLPaintDevice() [4/4]

QOpenGLPaintDevice::QOpenGLPaintDevice ( QOpenGLPaintDevicePrivate & dd )

protected

Definition at line 111 of file qopenglpaintdevice.cpp.

Member Function Documentation

◆ context()

QOpenGLContext * QOpenGLPaintDevice::context ( ) const

Returns the OpenGL context associated with the paint device.

Definition at line 184 of file qopenglpaintdevice.cpp.

References QOpenGLPaintDevicePrivate::ctx, and d_ptr.

Referenced by QOpenGL2PaintEngineExPrivate::fill().

Here is the caller graph for this function:

◆ devType()

int QOpenGLPaintDevice::devType ( ) const

inlineoverridevirtual

\reimp

Reimplemented from QPaintDevice.

Definition at line 28 of file qopenglpaintdevice.h.

References QInternal::OpenGL.

◆ dotsPerMeterX()

qreal QOpenGLPaintDevice::dotsPerMeterX ( ) const

Returns the number of pixels per meter horizontally.

See also: setDotsPerMeterX()

Definition at line 263 of file qopenglpaintdevice.cpp.

References d_ptr, and QOpenGLPaintDevicePrivate::dpmx.

◆ dotsPerMeterY()

qreal QOpenGLPaintDevice::dotsPerMeterY ( ) const

Returns the number of pixels per meter vertically.

See also: setDotsPerMeterY()

Definition at line 274 of file qopenglpaintdevice.cpp.

References d_ptr, and QOpenGLPaintDevicePrivate::dpmy.

◆ ensureActiveTarget()

void QOpenGLPaintDevice::ensureActiveTarget ( )

virtual

This virtual method is provided as a callback to allow re-binding a target frame buffer object or context when different QOpenGLPaintDevice instances are issuing draw calls alternately.

\l{QPainter::beginNativePainting()}{beginNativePainting()} will also trigger this method.

The default implementation does nothing.

Reimplemented in QOpenGLWindowPaintDevice, and QOpenGLWidgetPaintDevice.

Definition at line 332 of file qopenglpaintdevice.cpp.

Referenced by QOpenGL2PaintEngineEx::begin().

Here is the caller graph for this function: