NDEVR
API Documentation
GraphicsManager

A common interface responsible for managing specific actions with a Gaphics engine, such as Vulkan or OpenGL. More...

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

Public Member Functions

 GraphicsManager (QTModelManager *manager)
 Constructs the graphics manager.
virtual ~GraphicsManager ()
 Destructor.
virtual void addGraphicsSession (DynamicPointer< GraphicsSession > session, bool add_cameras=true) override
 Adds a graphics session.
void addRequest (const ConstPointer< CaptureRequest > &request) override
 Adds a capture request.
virtual Buffer< DynamicPointer< GraphicsSession > > availableSessions () const override
 Returns all available graphics sessions.
virtual bool canServiceCaptureRequests () const override
 Checks whether the manager can service capture requests.
virtual const DynamicPointer< QCaptureManager > & captureManager ()
 Returns the capture manager.
virtual void clearAll () override
 Clears all graphics sessions and resources.
void executeRequest (const ConstPointer< CaptureRequest > &request) override
 Immediately executes a capture request.
virtual const DynamicPointer< GraphicsSession > & graphicsSession (const DynamicPointer< GraphicsDevice > &device) override
 Returns the graphics session for the given device.
virtual bool hasGraphicsSession (const DynamicPointer< GraphicsDevice > &device) override
 Checks whether a graphics session exists for the given device.
virtual void initCaptureManager ()
 Initializes the capture manager if not already created.
void removeRequest (const ConstPointer< CaptureRequest > &request) override
 Removes a capture request.
virtual bool requestHandleManagerUpdating () const override
 Checks whether this manager handles its own updating.
void updateActive (const DynamicPointer< GraphicsSession > &session, bool add_cameras=true) override
 Updates which session is currently active.
Public Member Functions inherited from GraphicsManagerBase
void captureManagerStateChangeSignal ()
 Emitted when the capture manager state changes.
void graphicsSessionChangeSignal ()
 Emitted when the set of graphics sessions changes.

Protected Attributes

DynamicPointer< GraphicsSessionm_active_session
 The currently active graphics session.
QTResourceListenerm_graphics_listener = nullptr
 Listener for graphics-related resource changes.
Dictionary< UUID, DynamicPointer< GraphicsSession > > m_graphics_sessions
 All registered sessions keyed by device UUID.
QTModelManagerm_manager
 The model manager.
DynamicPointer< QCaptureManagerm_render_view_manager
 The capture manager.

Detailed Description

A common interface responsible for managing specific actions with a Gaphics engine, such as Vulkan or OpenGL.


Definition at line 11 of file GraphicsManager.h.

Constructor & Destructor Documentation

◆ GraphicsManager()

GraphicsManager::GraphicsManager ( QTModelManager * manager)

Constructs the graphics manager.

Parameters
[in]managerThe model manager.

Member Function Documentation

◆ addGraphicsSession()

virtual void GraphicsManager::addGraphicsSession ( DynamicPointer< GraphicsSession > session,
bool add_cameras = true )
overridevirtual

Adds a graphics session.

Parameters
[in]sessionThe session to add.
[in]add_camerasWhether to register existing cameras.

Implements GraphicsManagerBase.

◆ addRequest()

void GraphicsManager::addRequest ( const ConstPointer< CaptureRequest > & request)
overridevirtual

Adds a capture request.

Parameters
[in]requestThe capture request.

Implements GraphicsManagerBase.

◆ availableSessions()

virtual Buffer< DynamicPointer< GraphicsSession > > GraphicsManager::availableSessions ( ) const
overridevirtual

Returns all available graphics sessions.

Returns
Buffer of sessions.

Implements GraphicsManagerBase.

◆ canServiceCaptureRequests()

virtual bool GraphicsManager::canServiceCaptureRequests ( ) const
overridevirtual

Checks whether the manager can service capture requests.

Returns
True if capture is available.

Implements GraphicsManagerBase.

◆ captureManager()

virtual const DynamicPointer< QCaptureManager > & GraphicsManager::captureManager ( )
virtual

Returns the capture manager.

Returns
Reference to the capture manager.

◆ executeRequest()

void GraphicsManager::executeRequest ( const ConstPointer< CaptureRequest > & request)
overridevirtual

Immediately executes a capture request.

Parameters
[in]requestThe capture request.

Implements GraphicsManagerBase.

◆ graphicsSession()

virtual const DynamicPointer< GraphicsSession > & GraphicsManager::graphicsSession ( const DynamicPointer< GraphicsDevice > & device)
overridevirtual

Returns the graphics session for the given device.

Parameters
[in]deviceThe graphics device.
Returns
Reference to the session.

Implements GraphicsManagerBase.

◆ hasGraphicsSession()

virtual bool GraphicsManager::hasGraphicsSession ( const DynamicPointer< GraphicsDevice > & device)
overridevirtual

Checks whether a graphics session exists for the given device.

Parameters
[in]deviceThe graphics device.
Returns
True if a session exists.

Implements GraphicsManagerBase.

◆ removeRequest()

void GraphicsManager::removeRequest ( const ConstPointer< CaptureRequest > & request)
overridevirtual

Removes a capture request.

Parameters
[in]requestThe capture request.

Implements GraphicsManagerBase.

◆ requestHandleManagerUpdating()

virtual bool GraphicsManager::requestHandleManagerUpdating ( ) const
overridevirtual

Checks whether this manager handles its own updating.

Returns
True if the manager performs its own update loop.

Implements GraphicsManagerBase.

◆ updateActive()

void GraphicsManager::updateActive ( const DynamicPointer< GraphicsSession > & session,
bool add_cameras = true )
overridevirtual

Updates which session is currently active.

Parameters
[in]sessionThe session to activate.
[in]add_camerasWhether to register existing cameras.

Implements GraphicsManagerBase.


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