Null RenderAPI render pass object. More...

#include <CeresEngine/RenderAPI/Null/NLRenderPass.hpp>

Inheritance diagram for CeresEngine::NLRenderPass:

Public Member Functions
	NLRenderPass (NLDevicePtr device, const GPURenderPassDescriptor &descriptor)

	~NLRenderPass () final

void	begin (GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget, const Color &clearColor=Color(0.0, 0.0, 0.0, 0.0)) final

void	end (GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget) final

Public Member Functions inherited from CeresEngine::GPURenderPass
	GPURenderPass (const GPURenderPass &)=delete
	Deleted copy constructor.

GPURenderPass &	operator= (const GPURenderPass &)=delete

	GPURenderPass (GPURenderPass &&)=delete
	Deleted move constructor.

GPURenderPass &	operator= (GPURenderPass &&)=delete

template<typename Func , typename... Args>
decltype(auto)	with (GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget, Func &&block, Args &&... args)
	Prepares the render pass for execution.

	TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
	Inherited constructors.

	TDeviceObject (const TDeviceObject &)=delete
	Inherited constructors.

	TDeviceObject (TDeviceObject &&)=delete
	Inherited constructors.

Public Member Functions inherited from CeresEngine::TDeviceObject< GPURenderPassDescriptor >
	TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
	Initializes a new RenderAPI device object instance.

	TDeviceObject (const TDeviceObject &)=delete

	TDeviceObject (TDeviceObject &&)=delete

	~TDeviceObject () override=default

TDeviceObject &	operator= (const TDeviceObject &)=delete

TDeviceObject &	operator= (TDeviceObject &&)=delete

Public Member Functions inherited from CeresEngine::GPUDeviceObject
	GPUDeviceObject (GPUDevice &device)

	~GPUDeviceObject () override

Public Member Functions inherited from CeresEngine::GPUObject
	GPUObject ()=default

virtual	~GPUObject ()=default

	GPUObject (const GPUObject &)=delete

GPUObject &	operator= (const GPUObject &)=delete

	GPUObject (GPUObject &&)=delete

GPUObject &	operator= (GPUObject &&)=delete

void	retain () noexcept
	Retains the object by increment it's reference count by one.

bool	release () noexcept
	Releases the object by decrementing it's reference count by one.

Private Attributes
const GPURenderPassDescriptor	mDescriptor
	A structure that describes the render pass and it's properties.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPURenderPassDescriptor >
using	Descriptor = GPURenderPassDescriptor
	An type-alias to the descriptor struct type.

Static Public Member Functions inherited from CeresEngine::NLObject< ChildTypeName, ParentType >
static RC< ChildTypeName >	cast (const RC< ParentType > &ptr)
	Casts a `RC` containing a `ParentType` pointer to a pointer to a pointer to a `ChildTypeName`.

static RC< ChildTypeName >	safeCast (const RC< ParentType > &ptr)
	Safely casts a `RC` containing a `ParentType` pointer to a pointer to a pointer to a `ChildTypeName`.

static ChildTypeName &	cast (ParentType &object)
	Casts a `object` of type `ParentType` to a object of type `ChildTypeName`.

static const ChildTypeName &	cast (const ParentType &object)
	Casts a `object` of type `ParentType` to a object of type `ChildTypeName`.

static ChildTypeName *	cast (ParentType *object)
	Casts a `object` of type `ParentType` to a object of type `ChildTypeName`.

static const ChildTypeName *	cast (const ParentType *object)
	Casts a `object` of type `ParentType` to a object of type `ChildTypeName`.

static ChildTypeName *	safeCast (ParentType *object)
	Casts a `object` of type `ParentType` to a object of type `ChildTypeName`.

static const ChildTypeName *	safeCast (const ParentType *object)
	Casts a `object` of type `ParentType` to a object of type `ChildTypeName`.

Public Attributes inherited from CeresEngine::TDeviceObject< GPURenderPassDescriptor >
const Descriptor &	descriptor
	A structure that describes the object and it's properties.

Public Attributes inherited from CeresEngine::GPUDeviceObject
GPUDevice &	device
	The owning device this object was created from.

Protected Member Functions inherited from CeresEngine::GPUObject
virtual void	destroy () noexcept
	A internal method called by the system when the object reference count reaches zero.

Protected Member Functions inherited from CeresEngine::NLDeviceObject< NLRenderPass, GPURenderPass >
	NLDeviceObject (NLDevicePtr device)
	Creates a new `NLDeviceObject` from the given `device`.

Protected Attributes inherited from CeresEngine::NLDeviceObject< NLRenderPass, GPURenderPass >
NLDevice &	deviceNL
	The owning `NLDevice` instance.

Detailed Description

Null RenderAPI render pass object.

Constructor & Destructor Documentation

◆ NLRenderPass()

CeresEngine::NLRenderPass::NLRenderPass	(	NLDevicePtr	device,
		const GPURenderPassDescriptor &	descriptor
	)

◆ ~NLRenderPass()

CeresEngine::NLRenderPass::~NLRenderPass ( )

final

Member Function Documentation

◆ begin()

void CeresEngine::NLRenderPass::begin	(	GPUCommandBuffer &	commandBuffer,
		GPURenderTarget &	renderTarget,
		const Color &	clearColor = `Color(0.0, 0.0, 0.0, 0.0)`
	)

finalvirtual

Implements CeresEngine::GPURenderPass.

◆ end()

void CeresEngine::NLRenderPass::end	(	GPUCommandBuffer &	commandBuffer,
		GPURenderTarget &	renderTarget
	)

finalvirtual

Implements CeresEngine::GPURenderPass.

Member Data Documentation

◆ mDescriptor

const GPURenderPassDescriptor CeresEngine::NLRenderPass::mDescriptor

private

A structure that describes the render pass and it's properties.

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/Null/NLRenderPass.hpp

Public Member Functions

Private Attributes

Additional Inherited Members