CeresEngine::GPUFence Class Reference

#include <CeresEngine/RenderAPI/GPUFence.hpp>

Inheritance diagram for CeresEngine::GPUFence:

Public Member Functions
	GPUFence (const GPUFence &)=delete
	Deleted copy constructor.
GPUFence &	operator= (const GPUFence &)=delete
	GPUFence (GPUFence &&)=delete
	Deleted move constructor.
GPUFence &	operator= (GPUFence &&)=delete
virtual void	reset ()=0
	Resets the fence.
virtual bool	wait (UInt64 timeout)=0
	Blocks the CPU execution until the specified fence has been signaled.
	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.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUFenceDescriptor >
using	Descriptor = GPUFenceDescriptor
	An type-alias to the descriptor struct type.
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.

Constructor & Destructor Documentation

GPUFence() [1/2]

CeresEngine::GPUFence::GPUFence ( const GPUFence &  )

delete

Deleted copy constructor.

GPUFence() [2/2]

CeresEngine::GPUFence::GPUFence ( GPUFence &&  )

delete

Deleted move constructor.

Member Function Documentation

operator=() [1/2]

GPUFence & CeresEngine::GPUFence::operator= ( const GPUFence &  )

delete

operator=() [2/2]

GPUFence & CeresEngine::GPUFence::operator= ( GPUFence &&  )

delete

reset()

virtual void CeresEngine::GPUFence::reset ( )

pure virtual

Resets the fence.

Implemented in CeresEngine::MTFence, CeresEngine::MKFence, CeresEngine::NLFence, CeresEngine::GLFence, CeresEngine::VKFence, and CeresEngine::WGFence.

TDeviceObject() [1/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( const TDeviceObject &  )

delete

Inherited constructors.

TDeviceObject() [2/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( GPUDevice &  device, const Descriptor &  descriptor  )

inlineexplicit

Inherited constructors.

TDeviceObject() [3/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( TDeviceObject &&  )

delete

Inherited constructors.

wait()

virtual bool CeresEngine::GPUFence::wait ( UInt64  timeout )

pure virtual

Blocks the CPU execution until the specified fence has been signaled.

Parameters

timeout

Specifies the waiting timeout (in nanoseconds).

Returns

true on success, or false if the fence has a timeout (in nanoseconds) or the device is lost.

Implemented in CeresEngine::MTFence, CeresEngine::MKFence, CeresEngine::NLFence, CeresEngine::GLFence, CeresEngine::VKFence, and CeresEngine::WGFence.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPUFence.hpp