Cogs.Core
Public Member Functions | Private Attributes | List of all members
Cogs::GraphicsDeviceNull Class Reference
Inheritance diagram for Cogs::GraphicsDeviceNull:
Cogs::IGraphicsDevice

Public Member Functions

 GraphicsDeviceNull (RenderingAllocatorInfo *=nullptr)
 
virtual bool initialize () override
 Initializes the graphics device with the settings previous set through calling setSettings.
 
virtual void setSize (int, int) override
 Set the size of the main drawing buffer used by the graphics device in pixels.
 
virtual bool getSize (int &, int &) const override
 Retrieve the size previously set by setSize.
 
virtual void releaseResources () override
 Release all resources allocated.
 
virtual void waitForCommandSync () override
 Wait for any GPU commands on the current device to finish before returning.
 
virtual void beginFrame () override
 Signal the beginning of a new frame to the graphics device.
 
virtual void endFrame (uint32_t=0, uint32_t=PresentFlags::None) override
 Signal the end of a frame to the graphics device.
 
virtual std::string getIdentifier () const override
 Get the graphics device identifier.
 
virtual GraphicsDeviceType getType () const override
 Get the type of the graphics device.
 
virtual IContextgetImmediateContext () override
 Get a pointer to the immediate context used to issue commands to the graphics device.
 
virtual IBuffersgetBuffers () override
 Get a pointer to the buffer management interface.
 
virtual ITexturesgetTextures () override
 Get a pointer to the texture management interface.
 
virtual IRenderTargetsgetRenderTargets () override
 Get a pointer to the render target management interface.
 
virtual IEffectsgetEffects () override
 Get a pointer to the effect management interface.
 
virtual IPipelineStatesgetPipelineStates () override
 Get a pointer to the pipeline state management interface.
 
virtual ICapabilitiesgetCapabilities () override
 Get a pointer to the capability management interface used to query the graphics device capability flags.
 
virtual ISyncObjectsgetSyncObjects () override
 Get a pointer to the sync object management interface.
 
virtual ISwapChaingetDefaultSwapChain () override
 Get a pointer to the default swap chain for this graphics device.
 
virtual void * getNativeDevice () override
 
- Public Member Functions inherited from Cogs::IGraphicsDevice
virtual ~IGraphicsDevice ()=default
 Destructor.
 
virtual bool initializeThread ()
 Initialize the graphics device for operation on the current thread.
 
virtual SharedGraphicsContextcreateSharedContext ()
 Create a shared graphics context that can be used to activate another thread for rendering.
 
virtual void activateSharedContext (SharedGraphicsContext *)
 Activates the given shared context on the calling thread.
 
virtual void releaseSharedContext (SharedGraphicsContext *)
 Releases the given shared context.
 
virtual bool initialize ()=0
 Initializes the graphics device with the settings previous set through calling setSettings.
 
virtual bool isInitializationFinished ()
 Check if async initialization is finished.
 
virtual ResourceStatistics getResourceStatistics ()
 
virtual std::string getIdentifier () const
 Get the graphics device identifier.
 
virtual GraphicsDeviceType getType () const
 Get the type of the graphics device.
 
virtual void setSize (int width, int height)=0
 Set the size of the main drawing buffer used by the graphics device in pixels.
 
virtual bool getSize (int &width, int &height) const =0
 Retrieve the size previously set by setSize.
 
virtual void beginFrame ()=0
 Signal the beginning of a new frame to the graphics device.
 
virtual void endFrame (uint32_t syncInterval=0, uint32_t presentFlags=PresentFlags::None)=0
 Signal the end of a frame to the graphics device.
 
virtual void waitForCommandSync ()
 Wait for any GPU commands on the current device to finish before returning.
 
virtual void releaseResources ()=0
 Release all resources allocated.
 
virtual ISwapChaincreateSwapChain (struct WindowData *)
 Create a new swap chain for the specified window.
 
virtual void deleteSwapChain (ISwapChain *)
 Deletes the specified swap chain.
 
virtual IContextgetImmediateContext ()=0
 Get a pointer to the immediate context used to issue commands to the graphics device.
 
virtual IBuffersgetBuffers ()=0
 Get a pointer to the buffer management interface.
 
virtual ITexturesgetTextures ()=0
 Get a pointer to the texture management interface.
 
virtual IRenderTargetsgetRenderTargets ()=0
 Get a pointer to the render target management interface.
 
virtual IEffectsgetEffects ()=0
 Get a pointer to the effect management interface.
 
virtual IPipelineStatesgetPipelineStates ()=0
 Get a pointer to the pipeline state management interface.
 
virtual ICapabilitiesgetCapabilities ()=0
 Get a pointer to the capability management interface used to query the graphics device capability flags.
 
virtual ISwapChaingetDefaultSwapChain ()=0
 Get a pointer to the default swap chain for this graphics device.
 
virtual ISyncObjectsgetSyncObjects ()=0
 Get a pointer to the sync object management interface.
 
virtual void * getNativeDevice ()
 
virtual bool setSettings (const GraphicsDeviceSettings &newSettings)
 Updates the settings associated with this device.
 
const GraphicsDeviceSettingsgetSettings () const
 

Private Attributes

ContextNull context
 
BuffersNull buffers
 
EffectsNull effects
 
TexturesNull textures
 
RenderTargetsNull renderTargets
 
CapabilitiesNull capabilities
 
SyncObjectsCommon syncObjects
 

Additional Inherited Members

- Static Public Member Functions inherited from Cogs::IGraphicsDevice
static void fillGraphicsSettings (struct WindowData *windowData, int requestedSampleCount)
 Set platform specific graphics settings used for window creation e.g.: XVisualInfo on Linux.
 
- Protected Attributes inherited from Cogs::IGraphicsDevice
GraphicsDeviceSettings settings
 
std::vector< ISwapChain * > swapChains
 

Detailed Description

Definition at line 15 of file GraphicsDeviceNull.h.

Constructor & Destructor Documentation

◆ GraphicsDeviceNull()

Cogs::GraphicsDeviceNull::GraphicsDeviceNull ( RenderingAllocatorInfo = nullptr)
inline

Definition at line 17 of file GraphicsDeviceNull.h.

Member Function Documentation

◆ beginFrame()

virtual void Cogs::GraphicsDeviceNull::beginFrame ( )
inlineoverridevirtual

Signal the beginning of a new frame to the graphics device.

Implements Cogs::IGraphicsDevice.

Definition at line 32 of file GraphicsDeviceNull.h.

◆ endFrame()

virtual void Cogs::GraphicsDeviceNull::endFrame ( uint32_t  syncInterval = 0,
uint32_t  presentFlags = PresentFlags::None 
)
inlineoverridevirtual

Signal the end of a frame to the graphics device.

When the graphics device itself is responsible for managing the device context (e.g in D3D11), and the PresentFlags::NoSwap flag is not set, this will swap the back buffer to make the result of previous drawing visible.

Parameters
syncIntervalSynchronization interval.
  • 0 - No synchronization, presentation occurs immediately.
  • 1 - Synchronize presentation after 1 vertical blank.
presentFlagsA combination of PresentFlags controlling the presentation of the rendered frame.
See also
PresentFlags

Implements Cogs::IGraphicsDevice.

Definition at line 33 of file GraphicsDeviceNull.h.

◆ getBuffers()

virtual IBuffers * Cogs::GraphicsDeviceNull::getBuffers ( )
inlineoverridevirtual

Get a pointer to the buffer management interface.

Returns
A pointer to the buffer management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 38 of file GraphicsDeviceNull.h.

◆ getCapabilities()

virtual ICapabilities * Cogs::GraphicsDeviceNull::getCapabilities ( )
inlineoverridevirtual

Get a pointer to the capability management interface used to query the graphics device capability flags.

Returns
A pointer to the capability management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 43 of file GraphicsDeviceNull.h.

◆ getDefaultSwapChain()

virtual ISwapChain * Cogs::GraphicsDeviceNull::getDefaultSwapChain ( )
inlineoverridevirtual

Get a pointer to the default swap chain for this graphics device.

Returns
A pointer to the default swap chain.

Implements Cogs::IGraphicsDevice.

Definition at line 45 of file GraphicsDeviceNull.h.

◆ getEffects()

virtual IEffects * Cogs::GraphicsDeviceNull::getEffects ( )
inlineoverridevirtual

Get a pointer to the effect management interface.

Returns
A pointer to the effect management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 41 of file GraphicsDeviceNull.h.

◆ getIdentifier()

virtual std::string Cogs::GraphicsDeviceNull::getIdentifier ( ) const
inlineoverridevirtual

Get the graphics device identifier.

Returns
A string containing the name of the currently initialized graphics device.

Reimplemented from Cogs::IGraphicsDevice.

Definition at line 35 of file GraphicsDeviceNull.h.

◆ getImmediateContext()

virtual IContext * Cogs::GraphicsDeviceNull::getImmediateContext ( )
inlineoverridevirtual

Get a pointer to the immediate context used to issue commands to the graphics device.

Returns
A pointer to the context interface.

Implements Cogs::IGraphicsDevice.

Definition at line 37 of file GraphicsDeviceNull.h.

◆ getNativeDevice()

virtual void * Cogs::GraphicsDeviceNull::getNativeDevice ( )
inlineoverridevirtual

Reimplemented from Cogs::IGraphicsDevice.

Definition at line 47 of file GraphicsDeviceNull.h.

◆ getPipelineStates()

virtual IPipelineStates * Cogs::GraphicsDeviceNull::getPipelineStates ( )
inlineoverridevirtual

Get a pointer to the pipeline state management interface.

Returns
A pointer to the pipeline state management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 42 of file GraphicsDeviceNull.h.

◆ getRenderTargets()

virtual IRenderTargets * Cogs::GraphicsDeviceNull::getRenderTargets ( )
inlineoverridevirtual

Get a pointer to the render target management interface.

Returns
A pointer to the render target management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 40 of file GraphicsDeviceNull.h.

◆ getSize()

virtual bool Cogs::GraphicsDeviceNull::getSize ( int &  width,
int &  height 
) const
inlineoverridevirtual

Retrieve the size previously set by setSize.

Implements Cogs::IGraphicsDevice.

Definition at line 28 of file GraphicsDeviceNull.h.

◆ getSyncObjects()

virtual ISyncObjects * Cogs::GraphicsDeviceNull::getSyncObjects ( )
inlineoverridevirtual

Get a pointer to the sync object management interface.

Returns
A pointer to the sync object management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 44 of file GraphicsDeviceNull.h.

◆ getTextures()

virtual ITextures * Cogs::GraphicsDeviceNull::getTextures ( )
inlineoverridevirtual

Get a pointer to the texture management interface.

Returns
A pointer to the texture management interface.

Implements Cogs::IGraphicsDevice.

Definition at line 39 of file GraphicsDeviceNull.h.

◆ getType()

virtual GraphicsDeviceType Cogs::GraphicsDeviceNull::getType ( ) const
inlineoverridevirtual

Get the type of the graphics device.

Returns
The identifier of the graphics device.

Reimplemented from Cogs::IGraphicsDevice.

Definition at line 36 of file GraphicsDeviceNull.h.

References Cogs::Null.

◆ initialize()

virtual bool Cogs::GraphicsDeviceNull::initialize ( )
inlineoverridevirtual

Initializes the graphics device with the settings previous set through calling setSettings.

Implements Cogs::IGraphicsDevice.

Definition at line 21 of file GraphicsDeviceNull.h.

References Cogs::GraphicsDeviceSettings::ioHandler, and Cogs::EffectsCommon::setIOHandler().

◆ releaseResources()

virtual void Cogs::GraphicsDeviceNull::releaseResources ( )
inlineoverridevirtual

Release all resources allocated.

Implements Cogs::IGraphicsDevice.

Definition at line 30 of file GraphicsDeviceNull.h.

◆ setSize()

virtual void Cogs::GraphicsDeviceNull::setSize ( int  width,
int  height 
)
inlineoverridevirtual

Set the size of the main drawing buffer used by the graphics device in pixels.

Parameters
widthWidth of the drawing buffer in pixels.
heightHeight of the drawing buffer in pixels.

Implements Cogs::IGraphicsDevice.

Definition at line 27 of file GraphicsDeviceNull.h.

◆ waitForCommandSync()

virtual void Cogs::GraphicsDeviceNull::waitForCommandSync ( )
inlineoverridevirtual

Wait for any GPU commands on the current device to finish before returning.

After this command returns, any commands issued to the graphics device should be finished, and results from these ready to use.

Reimplemented from Cogs::IGraphicsDevice.

Definition at line 31 of file GraphicsDeviceNull.h.

Member Data Documentation

◆ buffers

BuffersNull Cogs::GraphicsDeviceNull::buffers
private

Definition at line 51 of file GraphicsDeviceNull.h.

◆ capabilities

CapabilitiesNull Cogs::GraphicsDeviceNull::capabilities
private

Definition at line 55 of file GraphicsDeviceNull.h.

◆ context

ContextNull Cogs::GraphicsDeviceNull::context
private

Definition at line 50 of file GraphicsDeviceNull.h.

◆ effects

EffectsNull Cogs::GraphicsDeviceNull::effects
private

Definition at line 52 of file GraphicsDeviceNull.h.

◆ renderTargets

RenderTargetsNull Cogs::GraphicsDeviceNull::renderTargets
private

Definition at line 54 of file GraphicsDeviceNull.h.

◆ syncObjects

SyncObjectsCommon Cogs::GraphicsDeviceNull::syncObjects
private

Definition at line 56 of file GraphicsDeviceNull.h.

◆ textures

TexturesNull Cogs::GraphicsDeviceNull::textures
private

Definition at line 53 of file GraphicsDeviceNull.h.


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