Cogs.Core
Public Member Functions | Public Attributes | List of all members
Cogs::RenderTargetsGL20 Struct Reference
Inheritance diagram for Cogs::RenderTargetsGL20:
Cogs::IRenderTargets

Public Member Functions

void initialize (TexturesGL20 *textures)
 
RenderTargetHandle createRenderTarget (const RenderTargetViewDescription *renderTargetViews, const size_t numViews) override
 Create a render target using the given view descriptions.
 
void releaseRenderTarget (RenderTargetHandle renderTargetHandle) override
 Release the render target with the given renderTargetHandle.
 
DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle handle) override
 Creates a depth/stencil target to back the render target with the given handle.
 
DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle handle, const TextureHandle textureHandle) override
 Creates a depth/stencil target to back the render target with the given handle.
 
DepthStencilHandle createDepthStencilTarget (const RenderTargetHandle handle, const DepthStencilViewDescription &depthStencilView) override
 Creates a depth stencil view using the given description.
 
void releaseDepthStencilTarget (DepthStencilHandle depthStencilHandle) override
 Release the depth target with the given depthStencilHandle.
 
DepthStencilStateHandle loadDepthStencilState (const DepthStencilState &depthStencilState) override
 Load a depth stencil state object.
 
void releaseDepthStencilState (DepthStencilStateHandle handle) override
 Release the depth stencil state with the given handle.
 
RasterizerStateHandle loadRasterizerState (const RasterizerState &rasterizerState) override
 Load a rasterizer state object.
 
void releaseRasterizerState (RasterizerStateHandle handle) override
 Release the rasterizer state with the given handle.
 
BlendStateHandle loadBlendState (const BlendState &blendState) override
 Load a blend state object.
 
BlendStateHandle loadBlendState (const BlendState &blendStateColor, const BlendState &blendStateAlpha) override
 Load a blend state object with separate blending for alpha channel.
 
void releaseBlendState (BlendStateHandle handle) override
 Release the blend state with the given handle.
 
void releaseResources () override
 Release all allocated render target resources.
 
void annotate (RenderTargetHandle handle, const StringView &name) override
 Associate a name with an object for use in graphics debugging.
 
void annotate (DepthStencilHandle handle, const StringView &name) override
 Associate a name with an object for use in graphics debugging.
 
- 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.
 

Public Attributes

ResourceMap< BlendStateHandle, BlendStateGL20blendStates
 
ResourceMap< RasterizerStateHandle, RasterizerStaterasterizerStates
 
ResourceMap< DepthStencilStateHandle, DepthStencilStatedepthStencilStates
 
ResourceMap< RenderTargetHandle, RenderTargetGL20renderTargets
 
ResourceMap< DepthStencilHandle, DepthStencilTargetGL20depthStencils
 
TexturesGL20textures
 

Detailed Description

Definition at line 37 of file RenderTargetsGL20.h.

Constructor & Destructor Documentation

◆ ~RenderTargetsGL20()

Cogs::RenderTargetsGL20::~RenderTargetsGL20 ( )

Definition at line 46 of file RenderTargetsGL20.cpp.

Member Function Documentation

◆ annotate() [1/2]

void Cogs::RenderTargetsGL20::annotate ( DepthStencilHandle  handle,
const StringView name 
)
overridevirtual

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

Reimplemented from Cogs::IRenderTargets.

Definition at line 291 of file RenderTargetsGL20.cpp.

References Cogs::StringView::data(), Cogs::StringView::empty(), and Cogs::StringView::size().

◆ annotate() [2/2]

void Cogs::RenderTargetsGL20::annotate ( RenderTargetHandle  handle,
const StringView name 
)
overridevirtual

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

Reimplemented from Cogs::IRenderTargets.

Definition at line 279 of file RenderTargetsGL20.cpp.

References Cogs::StringView::data(), Cogs::StringView::empty(), and Cogs::StringView::size().

◆ createDepthStencilTarget() [1/3]

Cogs::DepthStencilHandle Cogs::RenderTargetsGL20::createDepthStencilTarget ( const RenderTargetHandle  handle)
overridevirtual

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 105 of file RenderTargetsGL20.cpp.

References Cogs::Handle_t< DepthStencilTag >::InvalidHandle, and Cogs::Handle_t< TextureTag >::NoHandle.

Referenced by Cogs::SwapChainGL20::recreateOffscreenBuffers().

◆ createDepthStencilTarget() [2/3]

Cogs::DepthStencilHandle Cogs::RenderTargetsGL20::createDepthStencilTarget ( const RenderTargetHandle  handle,
const DepthStencilViewDescription depthStencilView 
)
overridevirtual

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 163 of file RenderTargetsGL20.cpp.

References Cogs::Handle_t< DepthStencilTag >::InvalidHandle, Cogs::DepthStencilViewDescription::layerIndex, Cogs::DepthStencilViewDescription::levelIndex, and Cogs::DepthStencilViewDescription::texture.

◆ createDepthStencilTarget() [3/3]

Cogs::DepthStencilHandle Cogs::RenderTargetsGL20::createDepthStencilTarget ( const RenderTargetHandle  handle,
const TextureHandle  textureHandle 
)
overridevirtual

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 137 of file RenderTargetsGL20.cpp.

References Cogs::Handle_t< DepthStencilTag >::InvalidHandle.

◆ createRenderTarget()

Cogs::RenderTargetHandle Cogs::RenderTargetsGL20::createRenderTarget ( const RenderTargetViewDescription renderTargetViews,
const size_t  numViews 
)
overridevirtual

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 56 of file RenderTargetsGL20.cpp.

References Cogs::Handle_t< RenderTargetTag >::InvalidHandle, Cogs::RenderTargetViewDescription::layerIndex, Cogs::RenderTargetViewDescription::levelIndex, and Cogs::RenderTargetViewDescription::texture.

Referenced by Cogs::SwapChainGL20::recreateOffscreenBuffers().

◆ initialize()

void Cogs::RenderTargetsGL20::initialize ( TexturesGL20 textures)
inline

Definition at line 39 of file RenderTargetsGL20.h.

◆ loadBlendState() [1/2]

Cogs::BlendStateHandle Cogs::RenderTargetsGL20::loadBlendState ( const BlendState blendState)
overridevirtual

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 235 of file RenderTargetsGL20.cpp.

◆ loadBlendState() [2/2]

Cogs::BlendStateHandle Cogs::RenderTargetsGL20::loadBlendState ( const BlendState blendStateColor,
const BlendState blendStateAlpha 
)
overridevirtual

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 240 of file RenderTargetsGL20.cpp.

◆ loadDepthStencilState()

Cogs::DepthStencilStateHandle Cogs::RenderTargetsGL20::loadDepthStencilState ( const DepthStencilState depthStencilState)
overridevirtual

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 215 of file RenderTargetsGL20.cpp.

◆ loadRasterizerState()

Cogs::RasterizerStateHandle Cogs::RenderTargetsGL20::loadRasterizerState ( const RasterizerState rasterizerState)
overridevirtual

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 225 of file RenderTargetsGL20.cpp.

◆ releaseBlendState()

void Cogs::RenderTargetsGL20::releaseBlendState ( BlendStateHandle  handle)
overridevirtual

Release the blend state with the given handle.

Parameters
handleValid handle to a blend state object.

Implements Cogs::IRenderTargets.

Definition at line 249 of file RenderTargetsGL20.cpp.

◆ releaseDepthStencilState()

void Cogs::RenderTargetsGL20::releaseDepthStencilState ( DepthStencilStateHandle  handle)
overridevirtual

Release the depth stencil state with the given handle.

Parameters
handleValid handle to a depth stencil state object.

Implements Cogs::IRenderTargets.

Definition at line 220 of file RenderTargetsGL20.cpp.

◆ releaseDepthStencilTarget()

void Cogs::RenderTargetsGL20::releaseDepthStencilTarget ( DepthStencilHandle  depthStencilHandle)
overridevirtual

Release the depth target with the given depthStencilHandle.

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

Implements Cogs::IRenderTargets.

Definition at line 204 of file RenderTargetsGL20.cpp.

Referenced by Cogs::SwapChainGL20::recreateOffscreenBuffers().

◆ releaseRasterizerState()

void Cogs::RenderTargetsGL20::releaseRasterizerState ( RasterizerStateHandle  handle)
overridevirtual

Release the rasterizer state with the given handle.

Parameters
handleValid handle to a rasterizer state object.

Implements Cogs::IRenderTargets.

Definition at line 230 of file RenderTargetsGL20.cpp.

◆ releaseRenderTarget()

void Cogs::RenderTargetsGL20::releaseRenderTarget ( RenderTargetHandle  renderTargetHandle)
overridevirtual

Release the render target with the given renderTargetHandle.

Parameters
renderTargetHandleValid handle to a previously created render target.

Implements Cogs::IRenderTargets.

Definition at line 96 of file RenderTargetsGL20.cpp.

Referenced by Cogs::SwapChainGL20::recreateOffscreenBuffers().

◆ releaseResources()

void Cogs::RenderTargetsGL20::releaseResources ( )
overridevirtual

Release all allocated render target resources.

Implements Cogs::IRenderTargets.

Definition at line 254 of file RenderTargetsGL20.cpp.

Member Data Documentation

◆ blendStates

ResourceMap<BlendStateHandle, BlendStateGL20> Cogs::RenderTargetsGL20::blendStates

Definition at line 70 of file RenderTargetsGL20.h.

◆ depthStencils

ResourceMap<DepthStencilHandle, DepthStencilTargetGL20> Cogs::RenderTargetsGL20::depthStencils

Definition at line 75 of file RenderTargetsGL20.h.

◆ depthStencilStates

ResourceMap<DepthStencilStateHandle, DepthStencilState> Cogs::RenderTargetsGL20::depthStencilStates

Definition at line 72 of file RenderTargetsGL20.h.

◆ rasterizerStates

ResourceMap<RasterizerStateHandle, RasterizerState> Cogs::RenderTargetsGL20::rasterizerStates

Definition at line 71 of file RenderTargetsGL20.h.

◆ renderTargets

ResourceMap<RenderTargetHandle, RenderTargetGL20> Cogs::RenderTargetsGL20::renderTargets

Definition at line 74 of file RenderTargetsGL20.h.

◆ textures

TexturesGL20* Cogs::RenderTargetsGL20::textures

Definition at line 77 of file RenderTargetsGL20.h.


The documentation for this struct was generated from the following files: