CeresEngine::GPURenderPass::Scope Class Reference

A helper class that begins a scoped render target binding. More...

#include <CeresEngine/RenderAPI/GPURenderPass.hpp>

Public Member Functions
template<typename... Args>
	Scope (GPUCommandBuffer &commandBuffer, GPURenderPass &renderPass, GPURenderTarget &renderTarget, Args &&... args)
	Creates a new scope and calls begin() on the pipeline.
template<typename... Args>
	Scope (const GPUCommandBufferPtr &commandBuffer, GPURenderPass &renderPass, GPURenderTarget &renderTarget, Args &&... args)
template<typename... Args>
	Scope (const GPUCommandBufferPtr &commandBuffer, const GPURenderPassPtr &renderPass, GPURenderTarget &renderTarget, Args &&... args)
template<typename... Args>
	Scope (const GPUCommandBufferPtr &commandBuffer, GPURenderPass &renderPass, const GPURenderTargetPtr &renderTarget, Args &&... args)
template<typename... Args>
	Scope (GPUCommandBuffer &commandBuffer, const GPURenderPassPtr &renderPass, GPURenderTarget &renderTarget, Args &&... args)
template<typename... Args>
	Scope (GPUCommandBuffer &commandBuffer, const GPURenderPassPtr &renderPass, const GPURenderTargetPtr &renderTarget, Args &&... args)
template<typename... Args>
	Scope (GPUCommandBuffer &commandBuffer, GPURenderPass &renderPass, const GPURenderTargetPtr &renderTarget, Args &&... args)
template<typename... Args>
	Scope (const GPUCommandBufferPtr &commandBuffer, const GPURenderPassPtr &renderPass, const GPURenderTargetPtr &renderTarget, Args &&... args)
	~Scope () noexcept
	Unbound the pipeline from the command buffer.
void	reset ()
	Unbound the pipeline from the command buffer.

Private Attributes
GPUCommandBuffer *	mCommandBuffer = nullptr
	The command buffer to which commands are being recorded on.
GPURenderPass *	mRenderPass = nullptr
	The render pass to be bound within the scope.
GPURenderTarget *	mRenderTarget = nullptr
	The render target to be bound within the scope of the render pass.

Detailed Description

A helper class that begins a scoped render target binding.

Constructor & Destructor Documentation

Scope() [1/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( GPUCommandBuffer &  commandBuffer, GPURenderPass &  renderPass, GPURenderTarget &  renderTarget, Args &&...  args  )

inlineexplicit

Creates a new scope and calls begin() on the pipeline.

Parameters

commandBuffer	The command line to bind the pipeline to.
graphicsPipeline	The pipeline to be bound.

Scope() [2/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( const GPUCommandBufferPtr &  commandBuffer, GPURenderPass &  renderPass, GPURenderTarget &  renderTarget, Args &&...  args  )

inlineexplicit

Scope() [3/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( const GPUCommandBufferPtr &  commandBuffer, const GPURenderPassPtr &  renderPass, GPURenderTarget &  renderTarget, Args &&...  args  )

inlineexplicit

Scope() [4/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( const GPUCommandBufferPtr &  commandBuffer, GPURenderPass &  renderPass, const GPURenderTargetPtr &  renderTarget, Args &&...  args  )

inlineexplicit

Scope() [5/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( GPUCommandBuffer &  commandBuffer, const GPURenderPassPtr &  renderPass, GPURenderTarget &  renderTarget, Args &&...  args  )

inlineexplicit

Scope() [6/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( GPUCommandBuffer &  commandBuffer, const GPURenderPassPtr &  renderPass, const GPURenderTargetPtr &  renderTarget, Args &&...  args  )

inlineexplicit

Scope() [7/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( GPUCommandBuffer &  commandBuffer, GPURenderPass &  renderPass, const GPURenderTargetPtr &  renderTarget, Args &&...  args  )

inlineexplicit

Scope() [8/8]

template<typename... Args>

CeresEngine::GPURenderPass::Scope::Scope ( const GPUCommandBufferPtr &  commandBuffer, const GPURenderPassPtr &  renderPass, const GPURenderTargetPtr &  renderTarget, Args &&...  args  )

inlineexplicit

~Scope()

CeresEngine::GPURenderPass::Scope::~Scope ( )

inlinenoexcept

Unbound the pipeline from the command buffer.

Member Function Documentation

reset()

void CeresEngine::GPURenderPass::Scope::reset ( )

inline

Unbound the pipeline from the command buffer.

Member Data Documentation

mCommandBuffer

GPUCommandBuffer* CeresEngine::GPURenderPass::Scope::mCommandBuffer = nullptr

private

The command buffer to which commands are being recorded on.

mRenderPass

GPURenderPass* CeresEngine::GPURenderPass::Scope::mRenderPass = nullptr

private

The render pass to be bound within the scope.

mRenderTarget

GPURenderTarget* CeresEngine::GPURenderPass::Scope::mRenderTarget = nullptr

private

The render target to be bound within the scope of the render pass.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPURenderPass.hpp