CeresEngine::RenderGraph2::RenderGraphBuffer Class Reference

#include <CeresEngine/Renderer/RenderGraph2/RenderGraphBuffer.hpp>

Inheritance diagram for CeresEngine::RenderGraph2::RenderGraphBuffer:

Public Member Functions
	RenderGraphBuffer (RenderGraph &graph, const RenderGraphBufferDescriptor &descriptor)
	Creates a new RenderGraphBuffer instance.
const RenderGraphBufferDescriptor &	getDescriptor () const noexcept
	A structure that describes how the RenderGraphBuffer should create a GPUBuffer based on it's inputs.
const GPUBufferPtr &	getBuffer () const noexcept
	A pointer to the instantiated GPU buffer.
void	setBuffer (const GPUBufferPtr &buffer)
	A pointer to the instantiated GPU buffer.
RenderGraphResourceType	getType () const noexcept final
Public Member Functions inherited from CeresEngine::RenderGraph2::RenderGraphResource
	RenderGraphResource (RenderGraph &graph)
virtual	~RenderGraphResource () noexcept=default
Public Member Functions inherited from CeresEngine::RefCounted< RenderGraphResource >
	RefCounted (Args &&... args)
	Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
void	retain () noexcept
	Retains the object by increment it's reference count by one.
bool	release () noexcept
	Relases the object by decrementing it's reference count by one.

Protected Attributes
RenderGraphBufferDescriptor	mDescriptor
	A structure that describes how the RenderGraphBuffer should create a GPUBuffer based on it's inputs.
GPUBufferPtr	mBuffer
	A pointer to the instantiated GPU buffer.
Protected Attributes inherited from CeresEngine::RenderGraph2::RenderGraphResource
RenderGraph &	mGraph

Constructor & Destructor Documentation

RenderGraphBuffer()

CeresEngine::RenderGraph2::RenderGraphBuffer::RenderGraphBuffer ( RenderGraph &  graph, const RenderGraphBufferDescriptor &  descriptor  )

inlineexplicit

Creates a new RenderGraphBuffer instance.

Parameters

graph	The graph that owns this resource.
descriptor	The buffer descriptor.

Member Function Documentation

getBuffer()

const GPUBufferPtr & CeresEngine::RenderGraph2::RenderGraphBuffer::getBuffer ( ) const

inlinenoexcept

A pointer to the instantiated GPU buffer.

Usually only defined during the execution of a render graph task.

getDescriptor()

const RenderGraphBufferDescriptor & CeresEngine::RenderGraph2::RenderGraphBuffer::getDescriptor ( ) const

inlinenoexcept

A structure that describes how the RenderGraphBuffer should create a GPUBuffer based on it's inputs.

getType()

RenderGraphResourceType CeresEngine::RenderGraph2::RenderGraphBuffer::getType ( ) const

inlinefinalvirtualnoexcept

Implements CeresEngine::RenderGraph2::RenderGraphResource.

setBuffer()

void CeresEngine::RenderGraph2::RenderGraphBuffer::setBuffer

(

const GPUBufferPtr &

buffer

)

A pointer to the instantiated GPU buffer.

Usually only defined during the execution of a render graph task.

Member Data Documentation

mBuffer

GPUBufferPtr CeresEngine::RenderGraph2::RenderGraphBuffer::mBuffer

protected

A pointer to the instantiated GPU buffer.

Usually only defined during the execution of a render graph task.

mDescriptor

RenderGraphBufferDescriptor CeresEngine::RenderGraph2::RenderGraphBuffer::mDescriptor

protected

A structure that describes how the RenderGraphBuffer should create a GPUBuffer based on it's inputs.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Renderer/RenderGraph2/RenderGraphBuffer.hpp