Open 3D Engine Atom Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
AZ::Vulkan::Query Class Referencefinal

Inherits AZ::RHI::DeviceQuery.

Public Member Functions

 AZ_RTTI (Query, "{E27876FA-D96D-407A-926A-C480F4EDCBD0}", Base)
 
 AZ_CLASS_ALLOCATOR (Query, AZ::SystemAllocator)
 
- Public Member Functions inherited from AZ::RHI::DeviceQuery
 AZ_RTTI (DeviceQuery, "{5E4AAD1B-E1A5-45FA-B965-9E212CE58B57}", DeviceResource)
 
void ReportMemoryUsage (MemoryStatisticsBuilder &builder) const override
 Reports memory usage of this image to the memory statistics builder.
 
const DeviceQueryPool * GetQueryPool () const
 Returns the query pool that this query belongs to.
 
DeviceQueryPool * GetQueryPool ()
 
QueryHandle GetHandle () const
 Returns the handle of the query.
 
ResultCode Begin (CommandList &commandList, QueryControlFlags flags=QueryControlFlags::None)
 
ResultCode End (CommandList &commandList)
 
ResultCode WriteTimestamp (CommandList &commandList)
 
- Public Member Functions inherited from AZ::RHI::DeviceResource
 AZ_RTTI (DeviceResource, "{9D02CDAC-80EB-4B77-8E62-849AC6E69206}", DeviceObject)
 
bool IsAttachment () const
 Returns whether the resource is currently an attachment on a frame graph.
 
void Shutdown () override final
 Shuts down the buffer by detaching it from its parent pool.
 
const DeviceResourcePool * GetPool () const
 
DeviceResourcePool * GetPool ()
 
uint32_t GetVersion () const
 
const FrameAttachment * GetFrameAttachment () const
 Returns the frame attachment associated with this image (if it exists).
 
void InvalidateViews ()
 
bool IsInResourceCache (const ImageViewDescriptor &imageViewDescriptor)
 Returns true if the DeviceResourceView is in the cache.
 
bool IsInResourceCache (const BufferViewDescriptor &bufferViewDescriptor)
 
void EraseResourceView (DeviceResourceView *resourceView) const
 Removes the provided DeviceResourceView from the cache.
 
- 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.
 
Device & GetDevice () 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< Query > Create ()
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::DeviceResource
Ptr< DeviceImageView > GetResourceView (const ImageViewDescriptor &imageViewDescriptor) const
 Returns view based on the descriptor.
 
Ptr< DeviceBufferView > GetResourceView (const BufferViewDescriptor &bufferViewDescriptor) const
 
- 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::Object
AZStd::atomic_int m_useCount = 0
 
The documentation for this class was generated from the following file: