Open 3D Engine Atom Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Vulkan::QueryPool Class Referencefinal

#include <QueryPool.h>

Inherits AZ::RHI::QueryPool.

Public Member Functions

 AZ_RTTI (QueryPool, "{46816FA4-3B31-434A-AAE3-037BC889AE73}", Base)
 
 AZ_CLASS_ALLOCATOR (QueryPool, AZ::SystemAllocator)
 
VkQueryPool GetNativeQueryPool () const
 
void ResetQueries (CommandList &commandList, const RHI::Interval &interval)
 
- Public Member Functions inherited from AZ::RHI::QueryPool
ResultCode Init (Device &device, const QueryPoolDescriptor &descriptor)
 Initialize the QueryPool.
 
ResultCode InitQuery (Query *query)
 
ResultCode InitQuery (Query **queries, uint32_t queryCount)
 
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 one specific Query.
 
ResultCode GetResults (Query **queries, uint32_t queryCount, uint64_t *results, uint32_t resultsCount, QueryResultFlagBits flags)
 
const QueryPoolDescriptorGetDescriptor () const override final
 
const QueryGetQuery (QueryHandle handle) const
 Returns the query by their handle.
 
- Public Member Functions inherited from AZ::RHI::ResourcePool
 AZ_RTTI (ResourcePool, "{757EB674-25DC-4D00-9808-D3DAF33A4EFE}", DeviceObject)
 
void Shutdown () override final
 Shuts down the pool. This method will shutdown all resources associated with the pool.
 
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.
 
ResourcePoolResolverGetResolver ()
 Returns the resolver for this pool.
 
const ResourcePoolResolverGetResolver () const
 
const HeapMemoryUsageGetHeapMemoryUsage (HeapMemoryLevel heapMemoryLevel) const
 Returns the memory used by this pool for a specific heap type.
 
const PoolMemoryUsageGetMemoryUsage () const
 Returns the memory used by this pool.
 
- Public Member Functions inherited from AZ::RHI::DeviceObject
 AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
DeviceGetDevice () 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.
 

Static Public Member Functions

static RHI::Ptr< QueryPoolCreate ()
 

Additional Inherited Members

- Protected Types inherited from AZ::RHI::ResourcePool
using PlatformMethod = AZStd::function< RHI::ResultCode()>
 A simple functor that returns a result code.
 
- Protected Member Functions inherited from AZ::RHI::QueryPool
QueryGetQuery (QueryHandle handle)
 
template<class T >
AZStd::vector< IntervalGetQueryIntervals (const AZStd::vector< T * > &queries)
 
template<class T >
AZStd::vector< IntervalGetQueryIntervalsSorted (const AZStd::vector< T * > &queries)
 
template<class T >
void SortQueries (AZStd::vector< T * > &queries)
 
void ComputeFragmentation () const override
 
- Protected Member Functions inherited from AZ::RHI::ResourcePool
void OnFrameBegin () override
 
void OnFrameCompile () override
 
void OnFrameEnd () override
 
void SetResolver (AZStd::unique_ptr< ResourcePoolResolver > &&resolvePolicy)
 
ResultCode Init (Device &device, const ResourcePoolDescriptor &descriptor, 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.
 
bool ValidateNotProcessingFrame () const
 Validates that we are not in the frame processing phase.
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::ResourcePool
PoolMemoryUsage m_memoryUsage
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Detailed Description

QueryPool implementation for Vulkan. It uses the VkQueryPool vulkan object to implement the pool.


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