CeresEngine::NLCommandQueue Class Reference

Null RenderAPI command queue object. More...

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

Inheritance diagram for CeresEngine::NLCommandQueue:

Public Member Functions
	NLCommandQueue (NLDevicePtr device)
	~NLCommandQueue () final
GPUCommandBufferPtr	createCommandBuffer (const GPUCommandBufferDescriptor &descriptor) final
Async	submit (GPUCommandBuffer &commandBuffer) final
void	wait () final
Public Member Functions inherited from CeresEngine::GPUCommandQueue
	GPUCommandQueue (const GPUCommandQueue &)=delete
	Deleted copy constructor.
GPUCommandQueue &	operator= (const GPUCommandQueue &)=delete
	GPUCommandQueue (GPUCommandQueue &&)=delete
	Deleted move constructor.
GPUCommandQueue &	operator= (GPUCommandQueue &&)=delete
	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< GPUCommandQueueDescriptor >
	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 GPUCommandQueueDescriptor	mDescriptor
	The CommandQueue descriptor structure.
NLCommandBufferPtr	mCommandBuffer
	The pending Null command buffer.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUCommandQueueDescriptor >
using	Descriptor = GPUCommandQueueDescriptor
	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< GPUCommandQueueDescriptor >
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< NLCommandQueue, GPUCommandQueue >
	NLDeviceObject (NLDevicePtr device)
	Creates a new NLDeviceObject from the given device.
Protected Attributes inherited from CeresEngine::NLDeviceObject< NLCommandQueue, GPUCommandQueue >
NLDevice &	deviceNL
	The owning NLDevice instance.

Detailed Description

Null RenderAPI command queue object.

Constructor & Destructor Documentation

NLCommandQueue()

CeresEngine::NLCommandQueue::NLCommandQueue ( NLDevicePtr  device )

explicit

~NLCommandQueue()

CeresEngine::NLCommandQueue::~NLCommandQueue ( )

final

Member Function Documentation

createCommandBuffer()

GPUCommandBufferPtr CeresEngine::NLCommandQueue::createCommandBuffer ( const GPUCommandBufferDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUCommandQueue.

submit()

Async CeresEngine::NLCommandQueue::submit ( GPUCommandBuffer &  commandBuffer )

finalvirtual

Implements CeresEngine::GPUCommandQueue.

wait()

void CeresEngine::NLCommandQueue::wait ( )

finalvirtual

Implements CeresEngine::GPUCommandQueue.

Member Data Documentation

mCommandBuffer

NLCommandBufferPtr CeresEngine::NLCommandQueue::mCommandBuffer

private

The pending Null command buffer.

mDescriptor

const GPUCommandQueueDescriptor CeresEngine::NLCommandQueue::mDescriptor

private

The CommandQueue descriptor structure.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/Null/NLCommandQueue.hpp