CeresEngine::RenderGraph2::RenderGraphImage Class Reference

A RenderGraph resource that represents a GPU image. More...

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

Inheritance diagram for CeresEngine::RenderGraph2::RenderGraphImage:

Public Member Functions
	RenderGraphImage (RenderGraph &graph, const RenderGraphImageDescriptor &descriptor)
	Creates a new RenderGraphImage instance.
const RenderGraphImageDescriptor	getDescriptor () const noexcept
	A structure that describes how the RenderGraphImage should create a GPUImage based on it's inputs.
const GPUImagePtr	getImage () const noexcept
	A pointer to the instantiated GPU image.
void	setImage (const GPUImagePtr image)
	A pointer to the instantiated GPU image.
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
RenderGraphImageDescriptor	mDescriptor
	A structure that describes how the RenderGraphImage should create a GPUImage based on it's inputs.
GPUImagePtr	mImage
	A pointer to the instantiated GPU image.
Protected Attributes inherited from CeresEngine::RenderGraph2::RenderGraphResource
RenderGraph &	mGraph

Detailed Description

A RenderGraph resource that represents a GPU image.

Constructor & Destructor Documentation

RenderGraphImage()

CeresEngine::RenderGraph2::RenderGraphImage::RenderGraphImage ( RenderGraph &  graph, const RenderGraphImageDescriptor &  descriptor  )

inlineexplicit

Creates a new RenderGraphImage instance.

Parameters

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

Member Function Documentation

getDescriptor()

const RenderGraphImageDescriptor CeresEngine::RenderGraph2::RenderGraphImage::getDescriptor ( ) const

inlinenoexcept

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

getImage()

const GPUImagePtr CeresEngine::RenderGraph2::RenderGraphImage::getImage ( ) const

inlinenoexcept

A pointer to the instantiated GPU image.

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

getType()

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

inlinefinalvirtualnoexcept

Implements CeresEngine::RenderGraph2::RenderGraphResource.

setImage()

void CeresEngine::RenderGraph2::RenderGraphImage::setImage

(

const GPUImagePtr

image

)

A pointer to the instantiated GPU image.

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

Member Data Documentation

mDescriptor

RenderGraphImageDescriptor CeresEngine::RenderGraph2::RenderGraphImage::mDescriptor

protected

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

mImage

GPUImagePtr CeresEngine::RenderGraph2::RenderGraphImage::mImage

protected

A pointer to the instantiated GPU image.

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

---

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

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