NDEVR
API Documentation
GLESGraphicsDevice
Visualization » Graphics

Buffer for storing data in the OpenGL engine, usually for rendering. More...

Inheritance diagram for GLESGraphicsDevice:
[legend]
Collaboration diagram for GLESGraphicsDevice:
[legend]

Public Member Functions

 GLESGraphicsDevice ()
 Default constructor.
virtual ~GLESGraphicsDevice ()
 Destructor.
const GLCapabilities & capabilities () const
 Returns the hardware capabilities of this device.
QOpenGLContext * context ()
 Returns the Qt OpenGL context.
virtual UUID id () const override
 Returns the unique identifier for this graphics device.
virtual void init () override
 Initializes the graphics device.
virtual const void * initLockPtr () const override
 Returns a pointer used for initialization locking.
virtual bool isInitialized () const override
 Checks whether the device has been initialized.
virtual bool isReady () const override
 Checks whether the device is ready for rendering.
virtual bool isValid () const override
 Checks whether this device is valid.
bool makeCurrent (QSurface *surface)
 Makes the OpenGL context current for the given surface.
virtual uint04 maxSupportedSamples () const override
 Returns the maximum number of MSAA samples supported.
QSurfaceFormat surfaceFormat () const
 Returns the surface format used by this device.
virtual bool updateFromLookup () const override
 Checks whether this device updates from a lookup.
Public Member Functions inherited from GraphicsDevice
 GraphicsDevice ()
 Default constructor.
virtual ~GraphicsDevice ()
 Destructor.
virtual bool supportsMultiThreading () const
 Checks whether the device supports multi-threaded rendering.

Static Public Member Functions

static const DynamicPointer< GLESGraphicsDevice > & DefaultGLESDevice ()
 Returns the default shared GLES graphics device singleton.

Protected Member Functions

void initialize ()
 Performs one-time OpenGL initialization and queries device capabilities.

Protected Attributes

GLCapabilities m_capabilities
 Hardware capability limits.
QOpenGLContext * m_context = nullptr
 The Qt OpenGL context.
UUID m_id
 Unique identifier for this device.
bool m_is_init = false
 Whether the device has been initialized.
QOpenGLDebugLogger * m_logger = nullptr
 Optional OpenGL debug logger.
QSurface * m_surface = nullptr
 The current rendering surface.

Static Protected Attributes

static DynamicPointer< GraphicsDevice > s_default_graphics_device
 The singleton default graphics device.

Additional Inherited Members

Public Attributes inherited from GraphicsDevice
Resource< bool > can_service_capture_requests
 Whether the device can service image capture requests.
Static Public Attributes inherited from GraphicsDevice
static DynamicPointer< GraphicsDevice > s_default_graphics_device
 The application-wide default graphics device.

Detailed Description

Buffer for storing data in the OpenGL engine, usually for rendering.

Definition at line 30 of file GLESGraphicsDevice.h.

Member Function Documentation

◆ capabilities()

const GLCapabilities & GLESGraphicsDevice::capabilities ( ) const
inline

Returns the hardware capabilities of this device.

Returns
A const reference to the GLCapabilities.

Definition at line 91 of file GLESGraphicsDevice.h.

References m_capabilities.

◆ context()

QOpenGLContext * GLESGraphicsDevice::context ( )
inline

Returns the Qt OpenGL context.

Returns
A pointer to the QOpenGLContext.

Definition at line 48 of file GLESGraphicsDevice.h.

References m_context.

◆ DefaultGLESDevice()

const DynamicPointer< GLESGraphicsDevice > & GLESGraphicsDevice::DefaultGLESDevice ( )
static

Returns the default shared GLES graphics device singleton.

Returns
A const reference to the default device DynamicPointer.

Referenced by GLESGraphicsSession::DefaultSession().

◆ id()

virtual UUID GLESGraphicsDevice::id ( ) const
inlineoverridevirtual

Returns the unique identifier for this graphics device.

Returns
The device UUID.

Implements GraphicsDevice.

Definition at line 39 of file GLESGraphicsDevice.h.

References m_id.

◆ initLockPtr()

virtual const void * GLESGraphicsDevice::initLockPtr ( ) const
inlineoverridevirtual

Returns a pointer used for initialization locking.

Returns
A pointer to this device.

Implements GraphicsDevice.

Definition at line 85 of file GLESGraphicsDevice.h.

◆ isInitialized()

virtual bool GLESGraphicsDevice::isInitialized ( ) const
inlineoverridevirtual

Checks whether the device has been initialized.

Returns
Always true.

Implements GraphicsDevice.

Definition at line 73 of file GLESGraphicsDevice.h.

◆ isReady()

virtual bool GLESGraphicsDevice::isReady ( ) const
inlineoverridevirtual

Checks whether the device is ready for rendering.

Returns
True if initialized.

Reimplemented from GraphicsDevice.

Definition at line 66 of file GLESGraphicsDevice.h.

References m_is_init.

◆ isValid()

virtual bool GLESGraphicsDevice::isValid ( ) const
inlineoverridevirtual

Checks whether this device is valid.

Returns
Always true for GLES devices.

Implements GraphicsDevice.

Definition at line 42 of file GLESGraphicsDevice.h.

◆ makeCurrent()

bool GLESGraphicsDevice::makeCurrent ( QSurface * surface)

Makes the OpenGL context current for the given surface.

Parameters
[in]surfaceThe surface to make current.
Returns
True if the context was successfully made current.

◆ maxSupportedSamples()

virtual uint04 GLESGraphicsDevice::maxSupportedSamples ( ) const
inlineoverridevirtual

Returns the maximum number of MSAA samples supported.

Returns
Always 1 for GLES devices.

Implements GraphicsDevice.

Definition at line 54 of file GLESGraphicsDevice.h.

◆ surfaceFormat()

QSurfaceFormat GLESGraphicsDevice::surfaceFormat ( ) const

Returns the surface format used by this device.

Returns
The QSurfaceFormat.

◆ updateFromLookup()

virtual bool GLESGraphicsDevice::updateFromLookup ( ) const
inlineoverridevirtual

Checks whether this device updates from a lookup.

Returns
Always false.

Reimplemented from GraphicsDevice.

Definition at line 79 of file GLESGraphicsDevice.h.

The documentation for this class was generated from the following file: