Struct QueryPool

pub struct QueryPool { /* private fields */ }

A collection of one or more queries of a particular type.

Implementations

impl QueryPool

pub fn new( device: Arc<Device>, create_info: QueryPoolCreateInfo, ) -> Result<Arc<QueryPool>, Validated<VulkanError>>

Creates a new QueryPool.

pub unsafe fn from_handle( device: Arc<Device>, handle: QueryPool, create_info: QueryPoolCreateInfo, ) -> Arc<QueryPool>

Creates a new QueryPool from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.
• create_info must match the info used to create the object.

pub fn query_type(&self) -> QueryType

Returns the query type of the pool.

pub fn query_count(&self) -> u32

Returns the number of query slots of this query pool.

pub fn pipeline_statistics(&self) -> QueryPipelineStatisticFlags

Returns the pipeline statistics flags of this query pool.

pub const fn result_len(&self, result_flags: QueryResultFlags) -> DeviceSize

Returns the number of QueryResultElements that are needed to hold the result of a single query of this type.

pub fn get_results<T>( &self, range: Range<u32>, destination: &mut [T], flags: QueryResultFlags, ) -> Result<bool, Validated<VulkanError>>

where T: QueryResultElement,

Copies the results of a range of queries to a buffer on the CPU.

self.ty().result_len() will be written for each query in the range, plus 1 extra element per query if WITH_AVAILABILITY is enabled. The provided buffer must be large enough to hold the data.

true is returned if every result was available and written to the buffer. false is returned if some results were not yet available; these will not be written to the buffer.

See also copy_query_pool_results.

pub unsafe fn reset( &self, range: Range<u32>, ) -> Result<(), Box<ValidationError>>

Resets a range of queries.

The host_query_reset feature must be enabled on the device.

Safety

For the queries indicated by range:

• There must be no operations pending or executing on the device.
• There must be no calls to reset* or get_results* executing concurrently on another thread.

Trait Implementations

impl Debug for QueryPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeviceOwned for QueryPool

fn device(&self) -> &Arc<Device>

Returns the device that owns self.

impl Drop for QueryPool

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for QueryPool

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for QueryPool

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for QueryPool

type Handle = QueryPool

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for QueryPool