NDEVR
API Documentation
GraphicsDeviceabstract

A physical or virtual device used with the NDEVR Rendering Engine. More...

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

Public Member Functions

 GraphicsDevice ()
 Default constructor.
virtual ~GraphicsDevice ()
 Destructor.
virtual UUID id () const =0
 Returns the unique identifier for this device.
virtual void init ()=0
 Initializes the graphics device.
virtual const void * initLockPtr () const =0
 Returns a pointer used for synchronizing device initialization.
virtual bool isInitialized () const =0
 Checks whether the device has been initialized.
virtual bool isReady () const
 Checks whether the device is ready for rendering.
virtual bool isValid () const =0
 Checks whether this device is valid and usable.
virtual uint04 maxSupportedSamples () const =0
 Returns the maximum number of multisample samples supported.
virtual bool supportsMultiThreading () const
 Checks whether the device supports multi-threaded rendering.
virtual bool updateFromLookup () const
 Checks whether the device should update from the design lookup.

Public Attributes

Resource< bool > can_service_capture_requests
 Whether the device can service image capture requests.

Static Public Attributes

static DynamicPointer< GraphicsDevices_default_graphics_device
 The application-wide default graphics device.

Detailed Description

A physical or virtual device used with the NDEVR Rendering Engine.


A device contains System specific limitations for rendering. Only one device is used for all rendering operations.

See also
GraphicsPipeline, GraphicsSession, VulkanDevice, GLESGraphicsDevice

Definition at line 14 of file GraphicsDevice.h.

Member Function Documentation

◆ id()

virtual UUID GraphicsDevice::id ( ) const
pure virtual

Returns the unique identifier for this device.

Returns
The device UUID.

Implemented in GLESGraphicsDevice, and VulkanDevice.

◆ initLockPtr()

virtual const void * GraphicsDevice::initLockPtr ( ) const
pure virtual

Returns a pointer used for synchronizing device initialization.

Returns
A pointer to the init lock.

Implemented in GLESGraphicsDevice, and VulkanDevice.

◆ isInitialized()

virtual bool GraphicsDevice::isInitialized ( ) const
pure virtual

Checks whether the device has been initialized.

Returns
True if initialized.

Implemented in GLESGraphicsDevice, and VulkanDevice.

◆ isReady()

virtual bool GraphicsDevice::isReady ( ) const
inlinevirtual

Checks whether the device is ready for rendering.

Returns
True if ready.

Reimplemented in GLESGraphicsDevice.

Definition at line 45 of file GraphicsDevice.h.

◆ isValid()

virtual bool GraphicsDevice::isValid ( ) const
pure virtual

Checks whether this device is valid and usable.

Returns
True if valid.

Implemented in GLESGraphicsDevice, and VulkanDevice.

◆ maxSupportedSamples()

virtual uint04 GraphicsDevice::maxSupportedSamples ( ) const
pure virtual

Returns the maximum number of multisample samples supported.

Returns
The max sample count.

Implemented in GLESGraphicsDevice, and VulkanDevice.

◆ supportsMultiThreading()

virtual bool GraphicsDevice::supportsMultiThreading ( ) const
inlinevirtual

Checks whether the device supports multi-threaded rendering.

Returns
True if multi-threading is supported.

Reimplemented in VulkanDevice.

Definition at line 39 of file GraphicsDevice.h.

◆ updateFromLookup()

virtual bool GraphicsDevice::updateFromLookup ( ) const
inlinevirtual

Checks whether the device should update from the design lookup.

Returns
True if lookup-based updating is enabled.

Reimplemented in GLESGraphicsDevice.

Definition at line 48 of file GraphicsDevice.h.


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