CeresEngine::MTGraphicsPipeline Class Reference

Metal RenderAPI graphics pipeline object. More...

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

Inheritance diagram for CeresEngine::MTGraphicsPipeline:

Public Member Functions
	MTGraphicsPipeline (MTDevicePtr device, const GPUGraphicsPipelineDescriptor &descriptor)
	~MTGraphicsPipeline () final
GPUResourceSetPtr	createResourceSet (const GPUResourceSetDescriptor &descriptor, UInt32 set=0) final
void	begin (GPUCommandBuffer &commandBuffer) final
void	end (GPUCommandBuffer &commandBuffer) final
Public Member Functions inherited from CeresEngine::GPUGraphicsPipeline
	GPUGraphicsPipeline (const GPUGraphicsPipeline &)=delete
	Deleted copy constructor.
GPUGraphicsPipeline &	operator= (const GPUGraphicsPipeline &)=delete
	GPUGraphicsPipeline (GPUGraphicsPipeline &&)=delete
	Deleted move constructor.
GPUGraphicsPipeline &	operator= (GPUGraphicsPipeline &&)=delete
template<typename Func , typename... Args>
decltype(auto)	with (GPUCommandBuffer &commandBuffer, Func &&func)
	Prepares the pipeline for execution.
	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< GPUGraphicsPipelineDescriptor >
	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 GPUGraphicsPipelineDescriptor	mDescriptor
	A object that describes the graphics pipeline object.
MTRenderPassPtr	mRenderPass
	The Metal render pass.
MTPipelineLayoutPtr	mPipelineLayout
	The Metal pipeline layout.
MTShaderProgramPtr	mShaderProgram
	A vector of all pipelines stages in the pipeline.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUGraphicsPipelineDescriptor >
using	Descriptor = GPUGraphicsPipelineDescriptor
	An type-alias to the descriptor struct type.
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< GPUGraphicsPipelineDescriptor >
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< MTGraphicsPipeline, GPUGraphicsPipeline >
	MTDeviceObject (MTDevicePtr device)
	Creates a new MTDeviceObject from the given device.
Protected Attributes inherited from CeresEngine::MTDeviceObject< MTGraphicsPipeline, GPUGraphicsPipeline >
MTDevice &	deviceMT
	The owning MTDevice instance.

Detailed Description

Metal RenderAPI graphics pipeline object.

Constructor & Destructor Documentation

MTGraphicsPipeline()

CeresEngine::MTGraphicsPipeline::MTGraphicsPipeline	(	MTDevicePtr	device,
		const GPUGraphicsPipelineDescriptor &	descriptor
	)

~MTGraphicsPipeline()

CeresEngine::MTGraphicsPipeline::~MTGraphicsPipeline ( )

final

Member Function Documentation

begin()

void CeresEngine::MTGraphicsPipeline::begin ( GPUCommandBuffer &  commandBuffer )

finalvirtual

Implements CeresEngine::GPUGraphicsPipeline.

createResourceSet()

GPUResourceSetPtr CeresEngine::MTGraphicsPipeline::createResourceSet ( const GPUResourceSetDescriptor &  descriptor, UInt32  set = 0  )

finalvirtual

Implements CeresEngine::GPUGraphicsPipeline.

end()

void CeresEngine::MTGraphicsPipeline::end ( GPUCommandBuffer &  commandBuffer )

finalvirtual

Implements CeresEngine::GPUGraphicsPipeline.

Member Data Documentation

mDescriptor

const GPUGraphicsPipelineDescriptor CeresEngine::MTGraphicsPipeline::mDescriptor

private

A object that describes the graphics pipeline object.

mPipelineLayout

MTPipelineLayoutPtr CeresEngine::MTGraphicsPipeline::mPipelineLayout

private

The Metal pipeline layout.

mRenderPass

MTRenderPassPtr CeresEngine::MTGraphicsPipeline::mRenderPass

private

The Metal render pass.

mShaderProgram

MTShaderProgramPtr CeresEngine::MTGraphicsPipeline::mShaderProgram

private

A vector of all pipelines stages in the pipeline.

---

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

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