xiiGALCommandQueue Class Reference

Interface that defines methods to manipulate a command queue object. More...

#include <CommandQueue.h>

Inheritance diagram for xiiGALCommandQueue:

Public Member Functions
XII_ALWAYS_INLINE const xiiGALCommandQueueCreationDescription &	GetDescription () const
	This returns the creation description for this object.
XII_ALWAYS_INLINE xiiGALDevice *	GetDevice () const
	This returns the device for this object.
virtual xiiUInt64	GetNextFenceValue () const =0
	This returns the value of the internal fence that will be signaled the next time.
virtual xiiUInt64	GetCompletedFenceValue ()=0
	This returns the last completed value of the internal fence.
virtual xiiUInt64	WaitForIdle ()=0
	This blocks execution until all pending GPU commands are complete.
virtual xiiSharedPtr< xiiGALCommandList >	BeginCommandList ()=0
	This begins a command list for recording commands.
Public Member Functions inherited from xiiGALObject
XII_ALWAYS_INLINE xiiStringView	GetDebugName () const
	Returns the debug name of this resource.
void	SetDebugName (xiiStringView sDebugName) const
	Sets the debug name for this resource.
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.
Public Member Functions inherited from xiiRefCounted
virtual	~xiiRefCounted ()=default
	Adds a virtual destructor.
Public Member Functions inherited from xiiRefCountingImpl
	xiiRefCountingImpl ()=default
	Constructor.
	xiiRefCountingImpl (const xiiRefCountingImpl &rhs)
void	operator= (const xiiRefCountingImpl &rhs)
xiiUInt32	AddRef () const
	Increments the reference counter. Returns the new reference count.
xiiUInt32	ReleaseRef () const
	Decrements the reference counter. Returns the new reference count.
bool	IsReferenced () const
	Returns true if the reference count is greater than 0, false otherwise.
xiiUInt32	GetRefCount () const
	Returns the current reference count.

Protected Member Functions
	xiiGALCommandQueue (xiiGALDevice *pDevice, const xiiGALCommandQueueCreationDescription &creationDescription)
Protected Member Functions inherited from xiiGALObject
virtual XII_ALWAYS_INLINE void	SetDebugNamePlatform (xiiStringView sName) const

Protected Attributes
xiiGALCommandQueueCreationDescription	m_Description
xiiGALDevice *	m_pDevice

Friends
class	xiiGALDevice

Additional Inherited Members
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Detailed Description

Interface that defines methods to manipulate a command queue object.

Member Function Documentation

BeginCommandList()

virtual xiiSharedPtr< xiiGALCommandList > xiiGALCommandQueue::BeginCommandList ( )

nodiscardpure virtual

This begins a command list for recording commands.

Implemented in xiiGALCommandQueueVulkan.

GetCompletedFenceValue()

virtual xiiUInt64 xiiGALCommandQueue::GetCompletedFenceValue ( )

pure virtual

This returns the last completed value of the internal fence.

Implemented in xiiGALCommandQueueVulkan.

GetNextFenceValue()

virtual xiiUInt64 xiiGALCommandQueue::GetNextFenceValue ( ) const

pure virtual

This returns the value of the internal fence that will be signaled the next time.

Implemented in xiiGALCommandQueueVulkan.

WaitForIdle()

virtual xiiUInt64 xiiGALCommandQueue::WaitForIdle ( )

pure virtual

This blocks execution until all pending GPU commands are complete.

Implemented in xiiGALCommandQueueVulkan.

---

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

• /home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/CommandEncoder/CommandQueue.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/CommandEncoder/Implementation/CommandQueue.cpp