CeresEngine::VKFence Class Reference

#include <CeresEngine/RenderAPI/Vulkan/VKFence.hpp>

Inheritance diagram for CeresEngine::VKFence:

Public Types
using	Allocator = VKObjectAllocator
	An allocator type used to allocate new VKFence instances from a memory pool.
Public Types inherited from CeresEngine::TDeviceObject< GPUFenceDescriptor >
using	Descriptor = GPUFenceDescriptor
	An type-alias to the descriptor struct type.

Public Member Functions
	VKFence (VKDevice &device, const GPUFenceDescriptor &descriptor)
	Creates a new VKFence object.
	~VKFence () final
	Destroys the VKFence object.
	operator VkFence () const noexcept
	The Vulkan fence 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.
Public Member Functions inherited from CeresEngine::VKDeviceObjectBase
	VKDeviceObjectBase (VKDevice &device) noexcept
	Creates a new VKDeviceObjectBase from the given device.
	~VKDeviceObjectBase () noexcept
	Destroys the VKDeviceObjectBase.

Static Public Member Functions
static Allocator &	getAllocator () noexcept
	Returns the allocator for VKFence.
static void *	operator new (size_t size) noexcept
	Allocates memory for a new instance of VKFence.
static void	operator delete (void *p, std::size_t size) noexcept
	Deletes memory for an instance of VKFence.
Static Public Member Functions inherited from CeresEngine::VKObject< 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 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 Public Member Functions inherited from CeresEngine::VKObjectBase
static void *	operator new (size_t size) noexcept
static void	operator delete (void *p, std::size_t sz) noexcept

Private Attributes
const GPUFenceDescriptor	descriptorVK
	A structure that describes the fence and it's properties.
VkFence	mFence = VK_NULL_HANDLE
	The Vulkan fence object.

Additional Inherited Members
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.
Public Attributes inherited from CeresEngine::VKDeviceObjectBase
VKDevice &	deviceVK
	The owning VKDevice instance.
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::VKDeviceObject< VKFence, GPUFence >
	VKDeviceObject (VKDevice &device) noexcept
	Creates a new VKDeviceObject from the given device.

Member Typedef Documentation

Allocator

using CeresEngine::VKFence::Allocator = VKObjectAllocator

An allocator type used to allocate new VKFence instances from a memory pool.

Constructor & Destructor Documentation

VKFence()

CeresEngine::VKFence::VKFence	(	VKDevice &	device,
		const GPUFenceDescriptor &	descriptor
	)

Creates a new VKFence object.

Parameters

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

~VKFence()

CeresEngine::VKFence::~VKFence ( )

final

Destroys the VKFence object.

Member Function Documentation

getAllocator()

static Allocator & CeresEngine::VKFence::getAllocator ( )

staticnoexcept

Returns the allocator for VKFence.

operator delete()

static void CeresEngine::VKFence::operator delete ( void *  p, std::size_t  size  )

staticnoexcept

Deletes memory for an instance of VKFence.

operator new()

static void * CeresEngine::VKFence::operator new ( size_t  size )

staticnoexcept

Allocates memory for a new instance of VKFence.

operator VkFence()

CeresEngine::VKFence::operator VkFence ( ) const

inlinenoexcept

The Vulkan fence object.

reset()

void CeresEngine::VKFence::reset ( )

finalvirtual

Implements CeresEngine::GPUFence.

wait()

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

finalvirtual

Implements CeresEngine::GPUFence.

Member Data Documentation

descriptorVK

const GPUFenceDescriptor CeresEngine::VKFence::descriptorVK

private

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

mFence

VkFence CeresEngine::VKFence::mFence = VK_NULL_HANDLE

private

The Vulkan fence object.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/Vulkan/VKFence.hpp