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

Inheritance diagram for CeresEngine::MTImage:

Public Types
using	MTLTextureType = void *

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

Public Member Functions
	MTImage (MTDevicePtr device, const GPUImageDescriptor &descriptor)

	~MTImage () final

	operator MTLTextureType () const noexcept
	The Metal API texture object.

GPUImageViewPtr	createView (const GPUImageViewDescriptor &descriptor) final

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

GPUImage &	operator= (const GPUImage &)=delete

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

GPUImage &	operator= (GPUImage &&)=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< GPUImageDescriptor, GPUResource >
	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::GPUResource
	GPUDeviceObject (GPUDevice &device)

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 GPUImageDescriptor	mDescriptor
	The image descriptor.

MTLTextureType	mTexture
	The Metal API texture object.

Additional Inherited Members
Static Public Member Functions inherited from CeresEngine::GPUImage
static UInt32	numMipLevels (UInt32 width, UInt32 height=1, UInt32 depth=1) noexcept
	Returns the number of MIP-map levels for a image with the specified size.

static UInt32	numMipLevels (const GPUImageDescriptor &imageDesc) noexcept
	Returns the number of MIP-map levels for the specified image descriptor.

static UInt32	bufferSize (Format format, UInt32 numTexels) noexcept
	Returns the required buffer size (in bytes) of a image with the specified hardware format and number of texels.

static UInt32	size (const GPUImageDescriptor &imageDesc) noexcept

static bool	isMipMapped (const GPUImageDescriptor &imageDesc) noexcept
	Returns true if the specified image descriptor describes a image with MIP-mapping enabled.

static bool	isArray (GPUImageType type) noexcept
	Returns true if the specified image type is an array image.

static bool	isMultiSample (GPUImageType type) noexcept
	Returns true if the specified image type is a multi-sample image.

static bool	isCube (GPUImageType type) noexcept
	Returns true if the specified image type is a cube image.

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< GPUImageDescriptor, GPUResource >
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< MTImage, GPUImage >
	MTDeviceObject (MTDevicePtr device)
	Creates a new `MTDeviceObject` from the given `device`.

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

Detailed Description

Metal RenderAPI image object.

Member Typedef Documentation

◆ MTLTextureType

using CeresEngine::MTImage::MTLTextureType = void*

Constructor & Destructor Documentation

◆ MTImage()

CeresEngine::MTImage::MTImage	(	MTDevicePtr	device,
		const GPUImageDescriptor &	descriptor
	)

◆ ~MTImage()

CeresEngine::MTImage::~MTImage ( )

final

Member Function Documentation

◆ createView()

GPUImageViewPtr CeresEngine::MTImage::createView ( const GPUImageViewDescriptor & descriptor )

finalvirtual

Implements CeresEngine::GPUImage.

◆ operator MTLTextureType()

CeresEngine::MTImage::operator MTLTextureType ( ) const

inlinenoexcept

The Metal API texture object.

Member Data Documentation

◆ mDescriptor

const GPUImageDescriptor CeresEngine::MTImage::mDescriptor

private

The image descriptor.

◆ mTexture

MTLTextureType CeresEngine::MTImage::mTexture