CeresEngine::NLSwapchain Class Reference

Null RenderAPI swapchain object. More...

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

Inheritance diagram for CeresEngine::NLSwapchain:

Public Member Functions
	NLSwapchain (NLDevicePtr device, const GPUSwapchainDescriptor &descriptor)
	Creates a new NLSwapchain object.
	~NLSwapchain () final
	Destroys the NLSwapchain object.
GPUImagePtr	nextRenderImage () override
void	present () override
	Presents a image from the getSwapchain. The command buffer that signals.
Public Member Functions inherited from CeresEngine::GPUSwapchain
	GPUSwapchain (const GPUSwapchain &)=delete
	Deleted copy constructor.
GPUSwapchain &	operator= (const GPUSwapchain &)=delete
	GPUSwapchain (GPUSwapchain &&)=delete
	Deleted move constructor.
GPUSwapchain &	operator= (GPUSwapchain &&)=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< GPUSwapchainDescriptor >
	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 GPUSwapchainDescriptor	mDescriptor
	A structure that describes the swapchain and it's properties.

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

Detailed Description

Null RenderAPI swapchain object.

Constructor & Destructor Documentation

NLSwapchain()

CeresEngine::NLSwapchain::NLSwapchain	(	NLDevicePtr	device,
		const GPUSwapchainDescriptor &	descriptor
	)

Creates a new NLSwapchain object.

Parameters

device	The owning device
descriptor	The descriptor object that describes the object

~NLSwapchain()

CeresEngine::NLSwapchain::~NLSwapchain ( )

final

Destroys the NLSwapchain object.

Member Function Documentation

nextRenderImage()

GPUImagePtr CeresEngine::NLSwapchain::nextRenderImage ( )

overridevirtual

Returns

The next render image in the getSwapchain

Implements CeresEngine::GPUSwapchain.

present()

void CeresEngine::NLSwapchain::present ( )

overridevirtual

Presents a image from the getSwapchain. The command buffer that signals.

Implements CeresEngine::GPUSwapchain.

Member Data Documentation

mDescriptor

const GPUSwapchainDescriptor CeresEngine::NLSwapchain::mDescriptor

private

A structure that describes the swapchain and it's properties.

---

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

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