Metal RenderAPI swapchain object. More...

#include <CeresEngine/RenderAPI/Metal/MTSwapchain.hpp>

Inheritance diagram for CeresEngine::MTSwapchain:

Public Types
using	CAMetalDrawableType = void *

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

Public Member Functions
	MTSwapchain (MTDevicePtr device, const GPUSwapchainDescriptor &descriptor)
	Creates a new `MTSwapchain` object.

	~MTSwapchain () final
	Destroys the `MTSwapchain` object.

	operator CAMetalDrawableType () const noexcept
	The Metal API swapchain 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.

CAMetalDrawableType	mDrawable
	The Metal API swapchain object.

Additional Inherited Members
Static Public Member Functions inherited from CeresEngine::MTObject< 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::MTDeviceObject< MTSwapchain, GPUSwapchain >
	MTDeviceObject (MTDevicePtr device)
	Creates a new `MTDeviceObject` from the given `device`.

Protected Attributes inherited from CeresEngine::MTDeviceObject< MTSwapchain, GPUSwapchain >
MTDevice &	deviceMT
	The owning `MTDevice` instance.

Detailed Description

Metal RenderAPI swapchain object.

Member Typedef Documentation

◆ CAMetalDrawableType

using CeresEngine::MTSwapchain::CAMetalDrawableType = void*

Constructor & Destructor Documentation

◆ MTSwapchain()

CeresEngine::MTSwapchain::MTSwapchain	(	MTDevicePtr	device,
		const GPUSwapchainDescriptor &	descriptor
	)

Creates a new MTSwapchain object.

Parameters

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

◆ ~MTSwapchain()

CeresEngine::MTSwapchain::~MTSwapchain ( )

final

Destroys the MTSwapchain object.

Member Function Documentation

◆ nextRenderImage()

GPUImagePtr CeresEngine::MTSwapchain::nextRenderImage ( )

overridevirtual

Returns: The next render image in the getSwapchain

Implements CeresEngine::GPUSwapchain.

◆ operator CAMetalDrawableType()

CeresEngine::MTSwapchain::operator CAMetalDrawableType ( ) const

inlinenoexcept

The Metal API swapchain object.

◆ present()

void CeresEngine::MTSwapchain::present ( )

overridevirtual

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

Implements CeresEngine::GPUSwapchain.

Member Data Documentation

◆ mDescriptor

const GPUSwapchainDescriptor CeresEngine::MTSwapchain::mDescriptor

private

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

◆ mDrawable

CAMetalDrawableType CeresEngine::MTSwapchain::mDrawable