CeresEngine::MTDevice Class Reference

Metal RenderAPI device object. More...

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

Inheritance diagram for CeresEngine::MTDevice:

Public Types
using	MTLDeviceType = void *

Public Member Functions
	MTDevice (MTRenderAPI &renderAPI)
	~MTDevice () final
	operator MTLDeviceType () const noexcept
	The Metal API device object.
GPUCommandBufferPtr	createCommandBuffer (const GPUCommandBufferDescriptor &descriptor) final
GPURenderPassPtr	createRenderPass (const GPURenderPassDescriptor &descriptor) final
GPUPipelineLayoutPtr	createPipelineLayout (const GPUPipelineLayoutDescriptor &descriptor) final
GPUGraphicsPipelinePtr	createGraphicsPipeline (const GPUGraphicsPipelineDescriptor &descriptor) final
GPUComputePipelinePtr	createComputePipeline (const GPUComputePipelineDescriptor &descriptor) final
GPUShaderPtr	createShader (const GPUShaderDescriptor &descriptor) final
GPUShaderProgramPtr	createShaderProgram (const GPUShaderProgramDescriptor &descriptor) final
GPURenderTargetPtr	createRenderTarget (const GPURenderTargetDescriptor &descriptor) final
GPUBufferPtr	createBuffer (const GPUBufferDescriptor &descriptor) final
GPUImagePtr	createImage (const GPUImageDescriptor &descriptor) final
GPUSamplerPtr	createSampler (const GPUSamplerDescriptor &descriptor) final
GPUFencePtr	createFence (const GPUFenceDescriptor &descriptor) final
GPUTimerQueryPtr	createTimerQuery (const GPUTimerQueryDescriptor &descriptor) final
GPUOcclusionQueryPtr	createOcclusionQuery (const GPUOcclusionQueryDescriptor &descriptor) final
GPUSwapchainPtr	createSwapchain (const GPUSwapchainDescriptor &descriptor) final
const GPURenderTargetPtr &	getNextRenderTarget () const
const GPURenderPassPtr &	getDefaultRenderPass () const
GPUCommandQueuePtr	getGraphicsQueue () final
GPUCommandQueuePtr	getTransferQueue () final
GPUCommandQueuePtr	getComputeQueue () final
MTRenderAPI &	getRenderAPI ()
Public Member Functions inherited from CeresEngine::GPUDevice
	GPUDevice (ExecutionContext &transferExecutionContext, const GPUDeviceInfo &information, const GPURenderingCapabilities &capabilities)
	Creates a new Device instance.
	~GPUDevice () override=default
	Destroys the device object.
	GPUDevice (const GPUDevice &)=delete
	Deleted copy constructor.
GPUDevice &	operator= (const GPUDevice &)=delete
	GPUDevice (GPUDevice &&)=delete
	Deleted move constructor.
GPUDevice &	operator= (GPUDevice &&)=delete
virtual Async< GPUBufferPtr >	createBufferAsync (const GPUBufferDescriptor &descriptor)
	Creates a new Buffer object asynchronously.
virtual Async< GPUImagePtr >	createImageAsync (const GPUImageDescriptor &descriptor)
	Creates a new Image object asynchronously.
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
MTLDeviceType	mDevice
	The Metal API device object.
MTRenderAPI &	mRenderAPI
	The owning MTRenderAPI instance.
ThreadPool	mTransferExecutor {1}
	The executor used to run the transfer operations on.
GPUDeviceInfo	mInformation
	The The device information structure.
GPURenderingCapabilities	mCapabilities
MTCommandQueuePtr	mCommandQueue
	The Metal graphics queue.
GPURenderPassPtr	mDefaultRenderPass
	The default render pass.
GPURenderTargetPtr	mDefaultRenderTarget
	The default render target object.

Friends
class	MTCommandQueue

Additional Inherited Members
Static Public Member Functions inherited from CeresEngine::MTObject< MTDevice, GPUDevice >
static RC< MTDevice >	cast (const RC< GPUDevice > &ptr)
	Casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
static MTDevice &	cast (GPUDevice &object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const MTDevice &	cast (const GPUDevice &object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static MTDevice *	cast (GPUDevice *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const MTDevice *	cast (const GPUDevice *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static RC< MTDevice >	safeCast (const RC< GPUDevice > &ptr)
	Safely casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
static MTDevice *	safeCast (GPUDevice *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const MTDevice *	safeCast (const GPUDevice *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
Public Attributes inherited from CeresEngine::GPUDevice
ExecutionContext &	transferExecutionContext
const GPUDeviceInfo &	information
	The The device information structure.
const GPURenderingCapabilities &	capabilities
	The device capabilities structure.
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.

Detailed Description

Metal RenderAPI device object.

Member Typedef Documentation

MTLDeviceType

using CeresEngine::MTDevice::MTLDeviceType = void*

Constructor & Destructor Documentation

MTDevice()

CeresEngine::MTDevice::MTDevice ( MTRenderAPI &  renderAPI )

explicit

~MTDevice()

CeresEngine::MTDevice::~MTDevice ( )

final

Member Function Documentation

createBuffer()

GPUBufferPtr CeresEngine::MTDevice::createBuffer ( const GPUBufferDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createCommandBuffer()

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

finalvirtual

Implements CeresEngine::GPUDevice.

createComputePipeline()

GPUComputePipelinePtr CeresEngine::MTDevice::createComputePipeline ( const GPUComputePipelineDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createFence()

GPUFencePtr CeresEngine::MTDevice::createFence ( const GPUFenceDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createGraphicsPipeline()

GPUGraphicsPipelinePtr CeresEngine::MTDevice::createGraphicsPipeline ( const GPUGraphicsPipelineDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createImage()

GPUImagePtr CeresEngine::MTDevice::createImage ( const GPUImageDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createOcclusionQuery()

GPUOcclusionQueryPtr CeresEngine::MTDevice::createOcclusionQuery ( const GPUOcclusionQueryDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createPipelineLayout()

GPUPipelineLayoutPtr CeresEngine::MTDevice::createPipelineLayout ( const GPUPipelineLayoutDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createRenderPass()

GPURenderPassPtr CeresEngine::MTDevice::createRenderPass ( const GPURenderPassDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createRenderTarget()

GPURenderTargetPtr CeresEngine::MTDevice::createRenderTarget ( const GPURenderTargetDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createSampler()

GPUSamplerPtr CeresEngine::MTDevice::createSampler ( const GPUSamplerDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createShader()

GPUShaderPtr CeresEngine::MTDevice::createShader ( const GPUShaderDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createShaderProgram()

GPUShaderProgramPtr CeresEngine::MTDevice::createShaderProgram ( const GPUShaderProgramDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createSwapchain()

GPUSwapchainPtr CeresEngine::MTDevice::createSwapchain ( const GPUSwapchainDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

createTimerQuery()

GPUTimerQueryPtr CeresEngine::MTDevice::createTimerQuery ( const GPUTimerQueryDescriptor &  descriptor )

finalvirtual

Implements CeresEngine::GPUDevice.

getComputeQueue()

GPUCommandQueuePtr CeresEngine::MTDevice::getComputeQueue ( )

finalvirtual

Implements CeresEngine::GPUDevice.

getDefaultRenderPass()

const GPURenderPassPtr & CeresEngine::MTDevice::getDefaultRenderPass ( ) const

inline

getGraphicsQueue()

GPUCommandQueuePtr CeresEngine::MTDevice::getGraphicsQueue ( )

finalvirtual

Implements CeresEngine::GPUDevice.

getNextRenderTarget()

const GPURenderTargetPtr & CeresEngine::MTDevice::getNextRenderTarget ( ) const

inline

getRenderAPI()

MTRenderAPI & CeresEngine::MTDevice::getRenderAPI ( )

inline

Returns

The owning MTRenderAPI instance.

getTransferQueue()

GPUCommandQueuePtr CeresEngine::MTDevice::getTransferQueue ( )

finalvirtual

Implements CeresEngine::GPUDevice.

operator MTLDeviceType()

CeresEngine::MTDevice::operator MTLDeviceType ( ) const

inlinenoexcept

The Metal API device object.

Friends And Related Symbol Documentation

MTCommandQueue

friend class MTCommandQueue

friend

Member Data Documentation

mCapabilities

GPURenderingCapabilities CeresEngine::MTDevice::mCapabilities

private

mCommandQueue

MTCommandQueuePtr CeresEngine::MTDevice::mCommandQueue

private

The Metal graphics queue.

mDefaultRenderPass

GPURenderPassPtr CeresEngine::MTDevice::mDefaultRenderPass

private

The default render pass.

mDefaultRenderTarget

GPURenderTargetPtr CeresEngine::MTDevice::mDefaultRenderTarget

private

The default render target object.

mDevice

MTLDeviceType CeresEngine::MTDevice::mDevice

private

The Metal API device object.

mInformation

GPUDeviceInfo CeresEngine::MTDevice::mInformation

private

The The device information structure.

mRenderAPI

MTRenderAPI& CeresEngine::MTDevice::mRenderAPI

private

The owning MTRenderAPI instance.

mTransferExecutor

ThreadPool CeresEngine::MTDevice::mTransferExecutor {1}

private

The executor used to run the transfer operations on.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/Metal/MTDevice.hpp