CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::MTRenderTarget Class Referencefinal

Metal RenderAPI render target object. More...

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

Inheritance diagram for CeresEngine::MTRenderTarget:
CeresEngine::GPURenderTarget CeresEngine::MTDeviceObject< MTRenderTarget, GPURenderTarget > CeresEngine::TDeviceObject< GPURenderTargetDescriptor > CeresEngine::MTObject< ChildTypeName, ParentType > CeresEngine::GPUDeviceObject CeresEngine::GPUObject

Public Member Functions

 MTRenderTarget (MTDevicePtr device, const GPURenderTargetDescriptor &descriptor)
 
 ~MTRenderTarget () final
 
- Public Member Functions inherited from CeresEngine::GPURenderTarget
 GPURenderTarget (const GPURenderTarget &)=delete
 Deleted copy constructor.
 
GPURenderTargetoperator= (const GPURenderTarget &)=delete
 
 GPURenderTarget (GPURenderTarget &&)=delete
 Deleted move constructor.
 
GPURenderTargetoperator= (GPURenderTarget &&)=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< GPURenderTargetDescriptor >
 TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
 Initializes a new RenderAPI device object instance.
 
 TDeviceObject (const TDeviceObject &)=delete
 
 TDeviceObject (TDeviceObject &&)=delete
 
 ~TDeviceObject () override=default
 
TDeviceObjectoperator= (const TDeviceObject &)=delete
 
TDeviceObjectoperator= (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
 
GPUObjectoperator= (const GPUObject &)=delete
 
 GPUObject (GPUObject &&)=delete
 
GPUObjectoperator= (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 GPURenderTargetDescriptor mDescriptor
 The descriptor used to create the render target.
 

Additional Inherited Members

- Public Types inherited from CeresEngine::TDeviceObject< GPURenderTargetDescriptor >
using Descriptor = GPURenderTargetDescriptor
 An type-alias to the descriptor struct type.
 
- Static Public Member Functions inherited from CeresEngine::MTObject< ChildTypeName, ParentType >
static RC< ChildTypeNamecast (const RC< ParentType > &ptr)
 Casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
 
static RC< ChildTypeNamesafeCast (const RC< ParentType > &ptr)
 Safely casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
 
static ChildTypeNamecast (ParentType &object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static const ChildTypeNamecast (const ParentType &object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static ChildTypeNamecast (ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static const ChildTypeNamecast (const ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static ChildTypeNamesafeCast (ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static const ChildTypeNamesafeCast (const ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
- Public Attributes inherited from CeresEngine::TDeviceObject< GPURenderTargetDescriptor >
const Descriptordescriptor
 A structure that describes the object and it's properties.
 
- Public Attributes inherited from CeresEngine::GPUDeviceObject
GPUDevicedevice
 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< MTRenderTarget, GPURenderTarget >
 MTDeviceObject (MTDevicePtr device)
 Creates a new MTDeviceObject from the given device.
 
- Protected Attributes inherited from CeresEngine::MTDeviceObject< MTRenderTarget, GPURenderTarget >
MTDevicedeviceMT
 The owning MTDevice instance.
 

Detailed Description

Metal RenderAPI render target object.

Constructor & Destructor Documentation

◆ MTRenderTarget()

CeresEngine::MTRenderTarget::MTRenderTarget ( MTDevicePtr  device,
const GPURenderTargetDescriptor descriptor 
)

◆ ~MTRenderTarget()

CeresEngine::MTRenderTarget::~MTRenderTarget ( )
final

Member Data Documentation

◆ mDescriptor

const GPURenderTargetDescriptor CeresEngine::MTRenderTarget::mDescriptor
private

The descriptor used to create the render target.


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