Cogs.Core
Public Member Functions | List of all members
Cogs::RenderTargetsNull Class Reference
Inheritance diagram for Cogs::RenderTargetsNull:
Cogs::IRenderTargets

Public Member Functions

virtual void annotate (RenderTargetHandle, const StringView &) override
 Associate a name with an object for use in graphics debugging.
 
virtual void annotate (DepthStencilHandle, const StringView &) override
 Associate a name with an object for use in graphics debugging.
 
virtual RenderTargetHandle createRenderTarget (const RenderTargetViewDescription *, const size_t) override
 Create a render target using the given view descriptions.
 
virtual void releaseRenderTarget (RenderTargetHandle renderTargetHandle) override
 Release the render target with the given renderTargetHandle.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle) override
 Creates a depth/stencil target to back the render target with the given handle.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle, const TextureHandle) override
 Creates a depth/stencil target to back the render target with the given handle.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle, const DepthStencilViewDescription &) override
 Creates a depth stencil view using the given description.
 
virtual void releaseDepthStencilTarget (DepthStencilHandle depthStencilHandle) override
 Release the depth target with the given depthStencilHandle.
 
virtual DepthStencilStateHandle loadDepthStencilState (const DepthStencilState &depthStencilState) override
 Load a depth stencil state object.
 
virtual void releaseDepthStencilState (DepthStencilStateHandle depthStencilStateHandle) override
 Release the depth stencil state with the given handle.
 
virtual RasterizerStateHandle loadRasterizerState (const RasterizerState &rasterizerState) override
 Load a rasterizer state object.
 
virtual void releaseRasterizerState (RasterizerStateHandle rasterizerStateHandle) override
 Release the rasterizer state with the given handle.
 
virtual BlendStateHandle loadBlendState (const BlendState &blendState) override
 Load a blend state object.
 
virtual BlendStateHandle loadBlendState (const BlendState &, const BlendState &) override
 Load a blend state object with separate blending for alpha channel.
 
virtual BlendStateHandle loadBlendState (const BlendState &, const BlendState &, const uint32_t) override
 
virtual BlendStateHandle loadBlendState (const BlendState *, const BlendState *, const uint32_t, const uint32_t) override
 
virtual void releaseBlendState (BlendStateHandle blendStateHandle) override
 Release the blend state with the given handle.
 
virtual void releaseResources () override
 Release all allocated render target resources.
 
- Public Member Functions inherited from Cogs::IRenderTargets
virtual void annotate (RenderTargetHandle handle, const StringView &name)
 Associate a name with an object for use in graphics debugging.
 
virtual void annotate (DepthStencilHandle handle, const StringView &name)
 Associate a name with an object for use in graphics debugging.
 
virtual RenderTargetHandle createRenderTarget (TextureHandle textureHandle)
 Create a render target using the given texture to render into.
 
virtual RenderTargetHandle createRenderTarget (TextureHandle *textureHandles, const size_t numTextureHandles)
 Create a multi render target (MRT) with using the given textures to render into.
 
virtual RenderTargetHandle createRenderTarget (const RenderTargetViewDescription *renderTargetViews, const size_t numViews)=0
 Create a render target using the given view descriptions.
 
virtual RenderTargetHandle createRenderTarget (const RenderTargetViewDescription *, const size_t, const MultiViewDescription &)
 
virtual void releaseRenderTarget (RenderTargetHandle renderTargetHandle)=0
 Release the render target with the given renderTargetHandle.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle handle)=0
 Creates a depth/stencil target to back the render target with the given handle.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle handle, const TextureHandle textureHandle)=0
 Creates a depth/stencil target to back the render target with the given handle.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle handle, const DepthStencilViewDescription &depthStencilView)=0
 Creates a depth stencil view using the given description.
 
virtual DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle, const DepthStencilViewDescription &, const MultiViewDescription &)
 
virtual void releaseDepthStencilTarget (DepthStencilHandle depthStencilHandle)=0
 Release the depth target with the given depthStencilHandle.
 
virtual DepthStencilStateHandle loadDepthStencilState (const DepthStencilState &depthStencilState)=0
 Load a depth stencil state object.
 
virtual void releaseDepthStencilState (DepthStencilStateHandle handle)=0
 Release the depth stencil state with the given handle.
 
virtual RasterizerStateHandle loadRasterizerState (const RasterizerState &rasterizerState)=0
 Load a rasterizer state object.
 
virtual void releaseRasterizerState (RasterizerStateHandle handle)=0
 Release the rasterizer state with the given handle.
 
virtual BlendStateHandle loadBlendState (const BlendState &blendState)=0
 Load a blend state object.
 
virtual BlendStateHandle loadBlendState (const BlendState &blendStateColor, const BlendState &blendStateAlpha)
 Load a blend state object with separate blending for alpha channel.
 
virtual BlendStateHandle loadBlendState (const BlendState &blendStateColor, const BlendState &blendStateAlpha, const uint32_t flags)
 
virtual BlendStateHandle loadBlendState (const BlendState *blendStateColor, const BlendState *blendStateAlpha, const uint32_t numBlendStates, const uint32_t flags)
 
virtual void releaseBlendState (BlendStateHandle handle)=0
 Release the blend state with the given handle.
 
virtual void releaseResources ()=0
 Release all allocated render target resources.
 

Detailed Description

Definition at line 6 of file RenderTargetsNull.h.

Member Function Documentation

◆ annotate() [1/2]

virtual void Cogs::RenderTargetsNull::annotate ( DepthStencilHandle  handle,
const StringView name 
)
inlineoverridevirtual

Associate a name with an object for use in graphics debugging.

Reimplemented from Cogs::IRenderTargets.

Definition at line 9 of file RenderTargetsNull.h.

◆ annotate() [2/2]

virtual void Cogs::RenderTargetsNull::annotate ( RenderTargetHandle  handle,
const StringView name 
)
inlineoverridevirtual

Associate a name with an object for use in graphics debugging.

Reimplemented from Cogs::IRenderTargets.

Definition at line 8 of file RenderTargetsNull.h.

◆ createDepthStencilTarget() [1/3]

virtual DepthStencilHandle Cogs::RenderTargetsNull::createDepthStencilTarget ( const  handle)
inlineoverridevirtual

Creates a depth/stencil target to back the render target with the given handle.

The dimensions of the render target are matched and a suitable depth format for the graphics device is chosen.

Parameters
handleValid handle to a render target to create depth target backing for.
Returns
Handle to the newly created depth target, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 19 of file RenderTargetsNull.h.

◆ createDepthStencilTarget() [2/3]

virtual DepthStencilHandle Cogs::RenderTargetsNull::createDepthStencilTarget ( const  handle,
const DepthStencilViewDescription depthStencilView 
)
inlineoverridevirtual

Creates a depth stencil view using the given description.

Parameters
handleValid handle to a render target to create depth target backing for.
depthStencilViewDepth stencil view description.
Returns
Handle to the newly created depth stencil target, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 27 of file RenderTargetsNull.h.

◆ createDepthStencilTarget() [3/3]

virtual DepthStencilHandle Cogs::RenderTargetsNull::createDepthStencilTarget ( const  handle,
const  textureHandle 
)
inlineoverridevirtual

Creates a depth/stencil target to back the render target with the given handle.

The texture with the given textureHandle is used as backing for the depth target. The texture must be of a format that supports depth values, and be flagged for use as a depth texture.

Parameters
handleValid handle to a render target to create depth target backing for.
textureHandleValid handle to a texture to use as backing to render depth values to.
Returns
Handle to the newly created depth stencil target, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 23 of file RenderTargetsNull.h.

◆ createRenderTarget()

virtual RenderTargetHandle Cogs::RenderTargetsNull::createRenderTarget ( const RenderTargetViewDescription renderTargetViews,
const  numViews 
)
inlineoverridevirtual

Create a render target using the given view descriptions.

Parameters
renderTargetViewsPointer to an array of render target view descriptions.
numViewsNumber of views in the array pointed to by renderTargetViews.
Returns
Handle to a render target, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 11 of file RenderTargetsNull.h.

◆ loadBlendState() [1/4]

virtual BlendStateHandle Cogs::RenderTargetsNull::loadBlendState ( const BlendState blendStateColor,
const BlendState blendStateAlpha 
)
inlineoverridevirtual

Load a blend state object with separate blending for alpha channel.

Parameters
blendStateColorBlend state object for the color channels to load.
blendStateAlphaBlend state object for the alpha channel to load.
Returns
Handle to the newly loaded blend state object, InvalidHandle if the operation failed.

Reimplemented from Cogs::IRenderTargets.

Definition at line 55 of file RenderTargetsNull.h.

◆ loadBlendState() [2/4]

virtual BlendStateHandle Cogs::RenderTargetsNull::loadBlendState ( const BlendState ,
const BlendState ,
const uint32_t   
)
inlineoverridevirtual

Reimplemented from Cogs::IRenderTargets.

Definition at line 59 of file RenderTargetsNull.h.

◆ loadBlendState() [3/4]

virtual BlendStateHandle Cogs::RenderTargetsNull::loadBlendState ( const BlendState blendState)
inlineoverridevirtual

Load a blend state object.

Parameters
blendStateBlend state object to load.
Returns
Handle to the newly loaded blend state object, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 51 of file RenderTargetsNull.h.

◆ loadBlendState() [4/4]

virtual BlendStateHandle Cogs::RenderTargetsNull::loadBlendState ( const BlendState ,
const BlendState ,
const uint32_t  ,
const uint32_t   
)
inlineoverridevirtual

Reimplemented from Cogs::IRenderTargets.

Definition at line 63 of file RenderTargetsNull.h.

◆ loadDepthStencilState()

virtual DepthStencilStateHandle Cogs::RenderTargetsNull::loadDepthStencilState ( const DepthStencilState depthStencilState)
inlineoverridevirtual

Load a depth stencil state object.

Parameters
depthStencilStateDepth stencil state object to load.
Returns
Handle to the newly loaded depth stencil state object, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 35 of file RenderTargetsNull.h.

◆ loadRasterizerState()

virtual RasterizerStateHandle Cogs::RenderTargetsNull::loadRasterizerState ( const RasterizerState rasterizerState)
inlineoverridevirtual

Load a rasterizer state object.

Parameters
rasterizerStateRasterizer state object to load.
Returns
Handle to the newly loaded rasterizer state object, InvalidHandle if the operation failed.

Implements Cogs::IRenderTargets.

Definition at line 43 of file RenderTargetsNull.h.

◆ releaseBlendState()

virtual void Cogs::RenderTargetsNull::releaseBlendState ( BlendStateHandle  handle)
inlineoverridevirtual

Release the blend state with the given handle.

Parameters
handleValid handle to a blend state object.

Implements Cogs::IRenderTargets.

Definition at line 67 of file RenderTargetsNull.h.

References Cogs::Handle_t< Type, Convertible >::handle.

◆ releaseDepthStencilState()

virtual void Cogs::RenderTargetsNull::releaseDepthStencilState ( DepthStencilStateHandle  handle)
inlineoverridevirtual

Release the depth stencil state with the given handle.

Parameters
handleValid handle to a depth stencil state object.

Implements Cogs::IRenderTargets.

Definition at line 39 of file RenderTargetsNull.h.

References Cogs::Handle_t< Type, Convertible >::handle.

◆ releaseDepthStencilTarget()

virtual void Cogs::RenderTargetsNull::releaseDepthStencilTarget ( DepthStencilHandle  depthStencilHandle)
inlineoverridevirtual

Release the depth target with the given depthStencilHandle.

Parameters
depthStencilHandleValid handle to a previously created depth/stencil target.

Implements Cogs::IRenderTargets.

Definition at line 31 of file RenderTargetsNull.h.

References Cogs::Handle_t< Type, Convertible >::handle.

◆ releaseRasterizerState()

virtual void Cogs::RenderTargetsNull::releaseRasterizerState ( RasterizerStateHandle  handle)
inlineoverridevirtual

Release the rasterizer state with the given handle.

Parameters
handleValid handle to a rasterizer state object.

Implements Cogs::IRenderTargets.

Definition at line 47 of file RenderTargetsNull.h.

References Cogs::Handle_t< Type, Convertible >::handle.

◆ releaseRenderTarget()

virtual void Cogs::RenderTargetsNull::releaseRenderTarget ( RenderTargetHandle  renderTargetHandle)
inlineoverridevirtual

Release the render target with the given renderTargetHandle.

Parameters
renderTargetHandleValid handle to a previously created render target.

Implements Cogs::IRenderTargets.

Definition at line 15 of file RenderTargetsNull.h.

References Cogs::Handle_t< Type, Convertible >::handle.

◆ releaseResources()

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

Release all allocated render target resources.

Implements Cogs::IRenderTargets.

Definition at line 71 of file RenderTargetsNull.h.


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