#include <QueryPool.h>

Inherits AZ::RHI::ResourcePool.

Public Member Functions
	AZ_CLASS_ALLOCATOR (QueryPool, AZ::SystemAllocator, 0)

	AZ_RHI_MULTI_DEVICE_OBJECT_GETTER (QueryPool)

ResultCode	Init (const QueryPoolDescriptor &descriptor)

ResultCode	InitQuery (Query *query)

ResultCode	InitQuery (Query **queries, uint32_t queryCount)

uint32_t	CalculateResultsCount (uint32_t queryCount=0)

ResultCode	GetResults (uint64_t *results, uint32_t resultsCount, QueryResultFlagBits flags)

ResultCode	GetResults (Query query, uint64_t result, uint32_t resultsCount, QueryResultFlagBits flags)
	Same as GetResults(uint64_t, uint32_t, QueryResultFlagBits) but for a specific multi-device query.

ResultCode	GetResults (Query *queries, uint32_t queryCount, uint64_t results, uint32_t resultsCount, QueryResultFlagBits flags)

const QueryPoolDescriptor &	GetDescriptor () const override final

void	Shutdown () override final
	Forwards the shutdown call to all device-specific QueryPools.

Public Member Functions inherited from AZ::RHI::ResourcePool
	AZ_RTTI (ResourcePool, "{BAE5442C-A312-4133-AE80-1200753A7C3E}", MultiDeviceObject)

template<typename ResourceType >
void	ForEach (AZStd::function< void(ResourceType &)> callback)

template<typename ResourceType >
void	ForEach (AZStd::function< void(const ResourceType &)> callback) const

uint32_t	GetResourceCount () const
	Returns the number of resources in the pool.

Public Member Functions inherited from AZ::RHI::MultiDeviceObject
	AZ_RTTI (MultiDeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)

bool	IsInitialized () const
	Returns whether the device object is initialized.

AZ_FORCE_INLINE bool	IsDeviceSet (int deviceIndex) const

MultiDevice::DeviceMask	GetDeviceMask () const

Public Member Functions inherited from AZ::RHI::Object
	AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")

void	SetName (const Name &name)
	Sets the name of the object.

const Name &	GetName () const
	Returns the name set on the object by SetName.

uint32_t	use_count ()
	Returns the current use count of the object.

Additional Inherited Members
Static Public Member Functions inherited from AZ::RHI::MultiDeviceObject
template<typename T >
static AZ_FORCE_INLINE void	IterateDevices (MultiDevice::DeviceMask deviceMask, T callback)

Protected Types inherited from AZ::RHI::ResourcePool
using	PlatformMethod = AZStd::function< RHI::ResultCode()>
	//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//!//

Protected Member Functions inherited from AZ::RHI::ResourcePool
ResultCode	Init (MultiDevice::DeviceMask deviceMask, const PlatformMethod &initMethod)

ResultCode	InitResource (Resource *resource, const PlatformMethod &initResourceMethod)

bool	ValidateIsRegistered (const Resource *resource) const

bool	ValidateIsUnregistered (const Resource *resource) const

bool	ValidateIsInitialized () const
	Validates that the resource pool is initialized and ready to service requests.

Protected Member Functions inherited from AZ::RHI::MultiDeviceObject
void	Init (MultiDevice::DeviceMask deviceMask)
	The derived class should call this method to assign the device.

template<typename T >
AZ_FORCE_INLINE void	IterateDevices (T callback)
	Helper method that will iterate over all selected devices and call the provided callback.

template<typename T , typename U >
AZ_FORCE_INLINE decltype(auto)	IterateObjects (U callback)

template<typename T , typename U >
AZ_FORCE_INLINE decltype(auto)	IterateObjects (U callback) const

template<typename T >
AZ_FORCE_INLINE Ptr< T >	GetDeviceObject (int deviceIndex) const

Protected Member Functions inherited from AZ::RHI::Object
void	add_ref () const

void	release () const

Protected Attributes inherited from AZ::RHI::MultiDeviceObject
AZStd::unordered_map< int, Ptr< DeviceObject > >	m_deviceObjects
	A map of all device-specific objects, indexed by the device index.

Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int	m_useCount = 0

Detailed Description

QueryPool manages a map of device-specific QueryPools, which provide backing storage and context for query instances. The QueryPoolDescriptor contains properties defining memory characteristics of query pools. All queries created on a pool share the same backing and type.

Member Function Documentation

◆ CalculateResultsCount()

uint32_t AZ::RHI::QueryPool::CalculateResultsCount ( uint32_t queryCount = 0 )

Get the number of results that have to be allocated. The number returned is the number of results per query, multiplied by the number of queries and the number of devices. The number of devices is queried from the RHISystem. If the queryCount is omitted or equal to 0, the total number of queries in the pool is used.

◆ GetDescriptor()

const QueryPoolDescriptor & AZ::RHI::QueryPool::GetDescriptor ( ) const

finaloverridevirtual

Returns the buffer descriptor used to initialize the query pool. Descriptor contents are undefined for uninitialized pools.

Implements AZ::RHI::ResourcePool.

◆ GetResults() [1/2]

ResultCode AZ::RHI::QueryPool::GetResults	(	Query **	queries,
		uint32_t	queryCount,
		uint64_t *	results,
		uint32_t	resultsCount,
		QueryResultFlagBits	flags
	)

Same as GetResults(Query*, uint64_t, uint32_t, QueryResultFlagBits) but for a list of queries. It's more efficient if the list of queries is sorted by handle in ascending order because there's no need to sort the results before returning.

◆ GetResults() [2/2]

ResultCode AZ::RHI::QueryPool::GetResults	(	uint64_t *	results,
		uint32_t	resultsCount,
		QueryResultFlagBits	flags
	)

Get the results from all queries (from all devices) in the pool, which are returned as uint64_t data. The parameter "resultsCount" denotes the total number of results requested. It can be determined by calling GetResultsCount(). The "results" parameter must contain enough space to save the results from all queries (from all devices) in the pool, i.e. resultCount * sizeof(uint64_t), must be pre-allocated. Results are ordered by device (using the deviceIndex) first and then per query, i.e., all results from a device are consecutive in memory. Data will only be written to the results array if the device actually exists, i.e., if its bit in the query's device mask is set and the device index is lower than the RHISystem's device count. The function can return partial results. In case of failure of requesting results from a specific device, only results from lower-indexed devices (which already have successfully returned results) are returned. For further details related to device-specific query functionality, please check the related header.

◆ Init()

ResultCode AZ::RHI::QueryPool::Init ( const QueryPoolDescriptor & descriptor )

Initialize the QueryPool by initializing all device-specific QueryPools for each device mentioned in the descriptor's deviceMask.

◆ InitQuery() [1/2]

ResultCode AZ::RHI::QueryPool::InitQuery	(	Query **	queries,
		uint32_t	queryCount
	)

Initialize a group of queries from the pool. The initialization will try to allocate the queries in a consecutive space (consecutive per device). The reason for this is that is more efficient when requesting results or copying multiple query results.

Parameters

queries	Pointer to an array of queries to initialize.
queryCount	Number of queries.

◆ InitQuery() [2/2]

ResultCode AZ::RHI::QueryPool::InitQuery ( Query * query )

Initialize a query from the pool (one device-specific query for each DeviceQueryPool). When initializing multiple queries use the other version of InitQuery because the pool will try to group the queries together.

Parameters

query Query to initialize.

◆ Shutdown()

void AZ::RHI::QueryPool::Shutdown ( )