CeresEngine::MKFence Class Reference

Mock RenderAPI fence object. More...

#include <CeresEngine/RenderAPI/Mock/MKFence.hpp>

Inheritance diagram for CeresEngine::MKFence:

Public Member Functions
	MKFence (MKDevicePtr device, const GPUFenceDescriptor &descriptor)
	Creates a new MKFence object.
	~MKFence () final
	Destroys the MKFence object.
void	reset () final
bool	wait (UInt64 timeout) final
Public Member Functions inherited from CeresEngine::GPUFence
	GPUFence (const GPUFence &)=delete
	Deleted copy constructor.
GPUFence &	operator= (const GPUFence &)=delete
	GPUFence (GPUFence &&)=delete
	Deleted move constructor.
GPUFence &	operator= (GPUFence &&)=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< GPUFenceDescriptor >
	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 GPUFenceDescriptor	mDescriptor
	A structure that describes the fence and it's properties.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUFenceDescriptor >
using	Descriptor = GPUFenceDescriptor
	An type-alias to the descriptor struct type.
Static Public Member Functions inherited from CeresEngine::MKObject< 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< GPUFenceDescriptor >
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::MKDeviceObject< MKFence, GPUFence >
	MKDeviceObject (MKDevicePtr device)
	Creates a new MKDeviceObject from the given device.
Protected Attributes inherited from CeresEngine::MKDeviceObject< MKFence, GPUFence >
MKDevice &	deviceMK
	The owning MKDevice instance.

Detailed Description

Mock RenderAPI fence object.

Constructor & Destructor Documentation

MKFence()

CeresEngine::MKFence::MKFence	(	MKDevicePtr	device,
		const GPUFenceDescriptor &	descriptor
	)

Creates a new MKFence object.

Parameters

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

~MKFence()

CeresEngine::MKFence::~MKFence ( )

final

Destroys the MKFence object.

Member Function Documentation

reset()

void CeresEngine::MKFence::reset ( )

finalvirtual

Implements CeresEngine::GPUFence.

wait()

bool CeresEngine::MKFence::wait ( UInt64  timeout )

finalvirtual

Implements CeresEngine::GPUFence.

Member Data Documentation

mDescriptor

const GPUFenceDescriptor CeresEngine::MKFence::mDescriptor

private

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

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/Mock/MKFence.hpp