Vulkan.Core10.Query

Documentation

createQueryPool

Arguments

:: forall a io. (Extendss QueryPoolCreateInfo a, PokeChain a, MonadIO io)

=> Device

device is the logical device that creates the query pool.

-> QueryPoolCreateInfo a

pCreateInfo is a pointer to a QueryPoolCreateInfo structure containing the number and type of queries to be managed by the pool.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io QueryPool

vkCreateQueryPool - Create a new query pool object

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid QueryPoolCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pQueryPool must be a valid pointer to a QueryPool handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, Device, QueryPool, QueryPoolCreateInfo

withQueryPool :: forall a io r. (Extendss QueryPoolCreateInfo a, PokeChain a, MonadIO io) => Device -> QueryPoolCreateInfo a -> Maybe AllocationCallbacks -> (io QueryPool -> (QueryPool -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createQueryPool and destroyQueryPool

To ensure that destroyQueryPool is always called: pass bracket (or the allocate function from your favourite resource management library) as the first argument. To just extract the pair pass (,) as the first argument.

destroyQueryPool

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the query pool.

-> QueryPool

queryPool is the query pool to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ()

vkDestroyQueryPool - Destroy a query pool object

Valid Usage

• All submitted commands that refer to queryPool must have completed execution

• If AllocationCallbacks were provided when queryPool was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when queryPool was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If queryPool is not NULL_HANDLE, queryPool must be a valid QueryPool handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If queryPool is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to queryPool must be externally synchronized

See Also

AllocationCallbacks, Device, QueryPool

getQueryPoolResults

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the query pool.

-> QueryPool

queryPool is the query pool managing the queries containing the desired results.

-> ("firstQuery" ::: Word32)

firstQuery is the initial query index.

-> ("queryCount" ::: Word32)

queryCount is the number of queries to read.

-> ("dataSize" ::: Word64)

dataSize is the size in bytes of the buffer pointed to by pData.

-> ("data" ::: Ptr ())

pData is a pointer to a user-allocated buffer where the results will be written

-> ("stride" ::: DeviceSize)

stride is the stride in bytes between results for individual queries within pData.

-> QueryResultFlags

flags is a bitmask of QueryResultFlagBits specifying how and when results are returned.

-> io Result

vkGetQueryPoolResults - Copy results of queries in a query pool to a host memory region

Description

The range of queries read is defined by [firstQuery, firstQuery + queryCount - 1]. For pipeline statistics queries, each query index in the pool contains one integer value for each bit that is enabled in QueryPoolCreateInfo::pipelineStatistics when the pool is created.

If no bits are set in flags, and all requested queries are in the available state, results are written as an array of 32-bit unsigned integer values. The behavior when not all queries are available, is described below.

If QUERY_RESULT_64_BIT is not set and the result overflows a 32-bit value, the value may either wrap or saturate. Similarly, if QUERY_RESULT_64_BIT is set and the result overflows a 64-bit value, the value may either wrap or saturate.

If QUERY_RESULT_WAIT_BIT is set, Vulkan will wait for each query to be in the available state before retrieving the numerical results for that query. In this case, getQueryPoolResults is guaranteed to succeed and return SUCCESS if the queries become available in a finite time (i.e. if they have been issued and not reset). If queries will never finish (e.g. due to being reset but not issued), then getQueryPoolResults may not return in finite time.

If QUERY_RESULT_WAIT_BIT and QUERY_RESULT_PARTIAL_BIT are both not set then no result values are written to pData for queries that are in the unavailable state at the time of the call, and getQueryPoolResults returns NOT_READY. However, availability state is still written to pData for those queries if QUERY_RESULT_WITH_AVAILABILITY_BIT is set.

Note

Applications must take care to ensure that use of the QUERY_RESULT_WAIT_BIT bit has the desired effect.

For example, if a query has been used previously and a command buffer records the commands cmdResetQueryPool, cmdBeginQuery, and cmdEndQuery for that query, then the query will remain in the available state until resetQueryPool is called or the cmdResetQueryPool command executes on a queue. Applications can use fences or events to ensure that a query has already been reset before checking for its results or availability status. Otherwise, a stale value could be returned from a previous use of the query.

The above also applies when QUERY_RESULT_WAIT_BIT is used in combination with QUERY_RESULT_WITH_AVAILABILITY_BIT. In this case, the returned availability status may reflect the result of a previous use of the query unless resetQueryPool is called or the cmdResetQueryPool command has been executed since the last use of the query.

Note

Applications can double-buffer query pool usage, with a pool per frame, and reset queries at the end of the frame in which they are read.

If QUERY_RESULT_PARTIAL_BIT is set, QUERY_RESULT_WAIT_BIT is not set, and the query’s status is unavailable, an intermediate result value between zero and the final result value is written to pData for that query.

If QUERY_RESULT_WITH_AVAILABILITY_BIT is set, the final integer value written for each query is non-zero if the query’s status was available or zero if the status was unavailable. When QUERY_RESULT_WITH_AVAILABILITY_BIT is used, implementations must guarantee that if they return a non-zero availability value then the numerical results must be valid, assuming the results are not reset by a subsequent command.

Note

Satisfying this guarantee may require careful ordering by the application, e.g. to read the availability status before reading the results.

Valid Usage

• firstQuery must be less than the number of queries in queryPool

• If QUERY_RESULT_64_BIT is not set in flags, then pData and stride must be multiples of 4
• If QUERY_RESULT_64_BIT is not set in flags and the queryType used to create queryPool was not QUERY_TYPE_PERFORMANCE_QUERY_KHR, then pData and stride must be multiples of 4
• If QUERY_RESULT_64_BIT is set in flags then pData and stride must be multiples of 8
• If the queryType used to create queryPool was QUERY_TYPE_PERFORMANCE_QUERY_KHR, then pData and stride must be multiples of the size of PerformanceCounterResultKHR
• The sum of firstQuery and queryCount must be less than or equal to the number of queries in queryPool
• dataSize must be large enough to contain the result of each query, as described here
• If the queryType used to create queryPool was QUERY_TYPE_TIMESTAMP, flags must not contain QUERY_RESULT_PARTIAL_BIT
• If the queryType used to create queryPool was QUERY_TYPE_PERFORMANCE_QUERY_KHR, flags must not contain QUERY_RESULT_WITH_AVAILABILITY_BIT, QUERY_RESULT_PARTIAL_BIT or QUERY_RESULT_64_BIT
• If the queryType used to create queryPool was QUERY_TYPE_PERFORMANCE_QUERY_KHR, the queryPool must have been recorded once for each pass as retrieved via a call to getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR

Valid Usage (Implicit)

• device must be a valid Device handle

• queryPool must be a valid QueryPool handle
• pData must be a valid pointer to an array of dataSize bytes
• flags must be a valid combination of QueryResultFlagBits values
• dataSize must be greater than 0
• queryPool must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS
• NOT_READY

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

See Also

Device, DeviceSize, QueryPool, QueryResultFlags

data QueryPoolCreateInfo (es :: [Type])

VkQueryPoolCreateInfo - Structure specifying parameters of a newly created query pool

Description

pipelineStatistics is ignored if queryType is not QUERY_TYPE_PIPELINE_STATISTICS.

Valid Usage

• If the pipeline statistics queries feature is not enabled, queryType must not be QUERY_TYPE_PIPELINE_STATISTICS

• If queryType is QUERY_TYPE_PIPELINE_STATISTICS, pipelineStatistics must be a valid combination of QueryPipelineStatisticFlagBits values
• If queryType is QUERY_TYPE_PERFORMANCE_QUERY_KHR, the pNext chain must include a structure of type QueryPoolPerformanceCreateInfoKHR
• queryCount must be greater than 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of QueryPoolPerformanceCreateInfoKHR or QueryPoolPerformanceQueryCreateInfoINTEL
• The sType value of each struct in the pNext chain must be unique
• flags must be 0
• queryType must be a valid QueryType value

See Also

QueryPipelineStatisticFlags, QueryPoolCreateFlags, QueryType, StructureType, createQueryPool

Constructors

QueryPoolCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: QueryPoolCreateFlags

  flags is reserved for future use.

• queryType :: QueryType

  queryType is a QueryType value specifying the type of queries managed by the pool.

• queryCount :: Word32

  queryCount is the number of queries managed by the pool.

• pipelineStatistics :: QueryPipelineStatisticFlags

  pipelineStatistics is a bitmask of QueryPipelineStatisticFlagBits specifying which counters will be returned in queries on the new pool, as described below in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#queries-pipestats.

Instances

Extensible QueryPoolCreateInfo

Defined in Vulkan.Core10.Query

Methods

extensibleType :: StructureType

getNext :: forall (es :: [Type]). QueryPoolCreateInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). QueryPoolCreateInfo ds -> Chain es -> QueryPoolCreateInfo es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends QueryPoolCreateInfo e => b) -> Maybe b

Show (Chain es) => Show (QueryPoolCreateInfo es)

Defined in Vulkan.Core10.Query

Methods

showsPrec :: Int -> QueryPoolCreateInfo es -> ShowS

show :: QueryPoolCreateInfo es -> String

showList :: [QueryPoolCreateInfo es] -> ShowS

Generic (QueryPoolCreateInfo es)

Defined in Vulkan.Core10.Query

Associated Types

type Rep (QueryPoolCreateInfo es) :: Type -> Type

Methods

from :: QueryPoolCreateInfo es -> Rep (QueryPoolCreateInfo es) x

to :: Rep (QueryPoolCreateInfo es) x -> QueryPoolCreateInfo es

(Extendss QueryPoolCreateInfo es, PeekChain es) => FromCStruct (QueryPoolCreateInfo es)

Defined in Vulkan.Core10.Query

Methods

peekCStruct :: Ptr (QueryPoolCreateInfo es) -> IO (QueryPoolCreateInfo es)

(Extendss QueryPoolCreateInfo es, PokeChain es) => ToCStruct (QueryPoolCreateInfo es)

Defined in Vulkan.Core10.Query

Methods

withCStruct :: QueryPoolCreateInfo es -> (Ptr (QueryPoolCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (QueryPoolCreateInfo es) -> QueryPoolCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (QueryPoolCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (QueryPoolCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (QueryPoolCreateInfo es)

Defined in Vulkan.Core10.Query

Methods

zero :: QueryPoolCreateInfo es

type Rep (QueryPoolCreateInfo es)

Defined in Vulkan.Core10.Query

type Rep (QueryPoolCreateInfo es) = D1 ('MetaData "QueryPoolCreateInfo" "Vulkan.Core10.Query" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "QueryPoolCreateInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryPoolCreateFlags)) :*: (S1 ('MetaSel ('Just "queryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryType) :*: (S1 ('MetaSel ('Just "queryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "pipelineStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryPipelineStatisticFlags)))))

newtype QueryPool

VkQueryPool - Opaque handle to a query pool object

See Also

cmdBeginQuery, cmdBeginQueryIndexedEXT, cmdCopyQueryPoolResults, cmdEndQuery, cmdEndQueryIndexedEXT, cmdResetQueryPool, cmdWriteAccelerationStructuresPropertiesKHR, cmdWriteAccelerationStructuresPropertiesNV, cmdWriteTimestamp, createQueryPool, destroyQueryPool, getQueryPoolResults, resetQueryPool, resetQueryPoolEXT

Constructors

QueryPool Word64

Instances

Eq QueryPool

Defined in Vulkan.Core10.Handles

Methods

(==) :: QueryPool -> QueryPool -> Bool

(/=) :: QueryPool -> QueryPool -> Bool

Ord QueryPool

Defined in Vulkan.Core10.Handles

Methods

compare :: QueryPool -> QueryPool -> Ordering

(<) :: QueryPool -> QueryPool -> Bool

(<=) :: QueryPool -> QueryPool -> Bool

(>) :: QueryPool -> QueryPool -> Bool

(>=) :: QueryPool -> QueryPool -> Bool

max :: QueryPool -> QueryPool -> QueryPool

min :: QueryPool -> QueryPool -> QueryPool

Show QueryPool

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> QueryPool -> ShowS

show :: QueryPool -> String

showList :: [QueryPool] -> ShowS

Storable QueryPool

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: QueryPool -> Int

alignment :: QueryPool -> Int

peekElemOff :: Ptr QueryPool -> Int -> IO QueryPool

pokeElemOff :: Ptr QueryPool -> Int -> QueryPool -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueryPool

pokeByteOff :: Ptr b -> Int -> QueryPool -> IO ()

peek :: Ptr QueryPool -> IO QueryPool

poke :: Ptr QueryPool -> QueryPool -> IO ()

Zero QueryPool

Defined in Vulkan.Core10.Handles

Methods

zero :: QueryPool

HasObjectType QueryPool

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: QueryPool -> (ObjectType, Word64)

IsHandle QueryPool

Defined in Vulkan.Core10.Handles

newtype QueryPoolCreateFlags

VkQueryPoolCreateFlags - Reserved for future use

Description

QueryPoolCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

QueryPoolCreateInfo

Constructors

QueryPoolCreateFlags Flags

Instances

Eq QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

(==) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Bool

(/=) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Bool

Ord QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

compare :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Ordering

(<) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Bool

(<=) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Bool

(>) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Bool

(>=) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> Bool

max :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> QueryPoolCreateFlags

min :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> QueryPoolCreateFlags

Read QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

readsPrec :: Int -> ReadS QueryPoolCreateFlags

readList :: ReadS [QueryPoolCreateFlags]

readPrec :: ReadPrec QueryPoolCreateFlags

readListPrec :: ReadPrec [QueryPoolCreateFlags]

Show QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

showsPrec :: Int -> QueryPoolCreateFlags -> ShowS

show :: QueryPoolCreateFlags -> String

showList :: [QueryPoolCreateFlags] -> ShowS

Storable QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

sizeOf :: QueryPoolCreateFlags -> Int

alignment :: QueryPoolCreateFlags -> Int

peekElemOff :: Ptr QueryPoolCreateFlags -> Int -> IO QueryPoolCreateFlags

pokeElemOff :: Ptr QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueryPoolCreateFlags

pokeByteOff :: Ptr b -> Int -> QueryPoolCreateFlags -> IO ()

peek :: Ptr QueryPoolCreateFlags -> IO QueryPoolCreateFlags

poke :: Ptr QueryPoolCreateFlags -> QueryPoolCreateFlags -> IO ()

Bits QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

(.&.) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> QueryPoolCreateFlags

(.|.) :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> QueryPoolCreateFlags

xor :: QueryPoolCreateFlags -> QueryPoolCreateFlags -> QueryPoolCreateFlags

complement :: QueryPoolCreateFlags -> QueryPoolCreateFlags

shift :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

rotate :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

zeroBits :: QueryPoolCreateFlags

bit :: Int -> QueryPoolCreateFlags

setBit :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

clearBit :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

complementBit :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

testBit :: QueryPoolCreateFlags -> Int -> Bool

bitSizeMaybe :: QueryPoolCreateFlags -> Maybe Int

bitSize :: QueryPoolCreateFlags -> Int

isSigned :: QueryPoolCreateFlags -> Bool

shiftL :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

unsafeShiftL :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

shiftR :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

unsafeShiftR :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

rotateL :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

rotateR :: QueryPoolCreateFlags -> Int -> QueryPoolCreateFlags

popCount :: QueryPoolCreateFlags -> Int

Zero QueryPoolCreateFlags

Defined in Vulkan.Core10.Enums.QueryPoolCreateFlags

Methods

zero :: QueryPoolCreateFlags

newtype QueryType

VkQueryType - Specify the type of queries managed by a query pool

See Also

QueryPoolCreateInfo, cmdWriteAccelerationStructuresPropertiesKHR, cmdWriteAccelerationStructuresPropertiesNV, writeAccelerationStructuresPropertiesKHR

Constructors

QueryType Int32

Bundled Patterns

pattern QUERY_TYPE_OCCLUSION :: QueryType

QUERY_TYPE_OCCLUSION specifies an occlusion query.

pattern QUERY_TYPE_PIPELINE_STATISTICS :: QueryType

QUERY_TYPE_PIPELINE_STATISTICS specifies a pipeline statistics query.

pattern QUERY_TYPE_TIMESTAMP :: QueryType

QUERY_TYPE_TIMESTAMP specifies a timestamp query.

pattern QUERY_TYPE_PERFORMANCE_QUERY_INTEL :: QueryType

QUERY_TYPE_PERFORMANCE_QUERY_INTEL specifies a Intel performance query.

pattern QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR :: QueryType

QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR specifies a ray tracing serialization acceleration structure size query

pattern QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR :: QueryType

QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR specifies a ray tracing acceleration structure size query.

pattern QUERY_TYPE_PERFORMANCE_QUERY_KHR :: QueryType

QUERY_TYPE_PERFORMANCE_QUERY_KHR specifies a performance query.

pattern QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT :: QueryType

QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT specifies a transform feedback query.

Instances

Eq QueryType

Defined in Vulkan.Core10.Enums.QueryType

Methods

(==) :: QueryType -> QueryType -> Bool

(/=) :: QueryType -> QueryType -> Bool

Ord QueryType

Defined in Vulkan.Core10.Enums.QueryType

Methods

compare :: QueryType -> QueryType -> Ordering

(<) :: QueryType -> QueryType -> Bool

(<=) :: QueryType -> QueryType -> Bool

(>) :: QueryType -> QueryType -> Bool

(>=) :: QueryType -> QueryType -> Bool

max :: QueryType -> QueryType -> QueryType

min :: QueryType -> QueryType -> QueryType

Read QueryType

Defined in Vulkan.Core10.Enums.QueryType

Methods

readsPrec :: Int -> ReadS QueryType

readList :: ReadS [QueryType]

readPrec :: ReadPrec QueryType

readListPrec :: ReadPrec [QueryType]

Show QueryType

Defined in Vulkan.Core10.Enums.QueryType

Methods

showsPrec :: Int -> QueryType -> ShowS

show :: QueryType -> String

showList :: [QueryType] -> ShowS

Storable QueryType

Defined in Vulkan.Core10.Enums.QueryType

Methods

sizeOf :: QueryType -> Int

alignment :: QueryType -> Int

peekElemOff :: Ptr QueryType -> Int -> IO QueryType

pokeElemOff :: Ptr QueryType -> Int -> QueryType -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueryType

pokeByteOff :: Ptr b -> Int -> QueryType -> IO ()

peek :: Ptr QueryType -> IO QueryType

poke :: Ptr QueryType -> QueryType -> IO ()

Zero QueryType

Defined in Vulkan.Core10.Enums.QueryType

Methods

zero :: QueryType

newtype QueryResultFlagBits

VkQueryResultFlagBits - Bitmask specifying how and when query results are returned

See Also

QueryResultFlags

Constructors

QueryResultFlagBits Flags

Bundled Patterns

pattern QUERY_RESULT_64_BIT :: QueryResultFlagBits

QUERY_RESULT_64_BIT specifies the results will be written as an array of 64-bit unsigned integer values. If this bit is not set, the results will be written as an array of 32-bit unsigned integer values.

pattern QUERY_RESULT_WAIT_BIT :: QueryResultFlagBits

QUERY_RESULT_WAIT_BIT specifies that Vulkan will wait for each query’s status to become available before retrieving its results.

pattern QUERY_RESULT_WITH_AVAILABILITY_BIT :: QueryResultFlagBits

QUERY_RESULT_WITH_AVAILABILITY_BIT specifies that the availability status accompanies the results.

pattern QUERY_RESULT_PARTIAL_BIT :: QueryResultFlagBits

QUERY_RESULT_PARTIAL_BIT specifies that returning partial results is acceptable.

Instances

Eq QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

(==) :: QueryResultFlagBits -> QueryResultFlagBits -> Bool

(/=) :: QueryResultFlagBits -> QueryResultFlagBits -> Bool

Ord QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

compare :: QueryResultFlagBits -> QueryResultFlagBits -> Ordering

(<) :: QueryResultFlagBits -> QueryResultFlagBits -> Bool

(<=) :: QueryResultFlagBits -> QueryResultFlagBits -> Bool

(>) :: QueryResultFlagBits -> QueryResultFlagBits -> Bool

(>=) :: QueryResultFlagBits -> QueryResultFlagBits -> Bool

max :: QueryResultFlagBits -> QueryResultFlagBits -> QueryResultFlagBits

min :: QueryResultFlagBits -> QueryResultFlagBits -> QueryResultFlagBits

Read QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

readsPrec :: Int -> ReadS QueryResultFlagBits

readList :: ReadS [QueryResultFlagBits]

readPrec :: ReadPrec QueryResultFlagBits

readListPrec :: ReadPrec [QueryResultFlagBits]

Show QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

showsPrec :: Int -> QueryResultFlagBits -> ShowS

show :: QueryResultFlagBits -> String

showList :: [QueryResultFlagBits] -> ShowS

Storable QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

sizeOf :: QueryResultFlagBits -> Int

alignment :: QueryResultFlagBits -> Int

peekElemOff :: Ptr QueryResultFlagBits -> Int -> IO QueryResultFlagBits

pokeElemOff :: Ptr QueryResultFlagBits -> Int -> QueryResultFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueryResultFlagBits

pokeByteOff :: Ptr b -> Int -> QueryResultFlagBits -> IO ()

peek :: Ptr QueryResultFlagBits -> IO QueryResultFlagBits

poke :: Ptr QueryResultFlagBits -> QueryResultFlagBits -> IO ()

Bits QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

(.&.) :: QueryResultFlagBits -> QueryResultFlagBits -> QueryResultFlagBits

(.|.) :: QueryResultFlagBits -> QueryResultFlagBits -> QueryResultFlagBits

xor :: QueryResultFlagBits -> QueryResultFlagBits -> QueryResultFlagBits

complement :: QueryResultFlagBits -> QueryResultFlagBits

shift :: QueryResultFlagBits -> Int -> QueryResultFlagBits

rotate :: QueryResultFlagBits -> Int -> QueryResultFlagBits

zeroBits :: QueryResultFlagBits

bit :: Int -> QueryResultFlagBits

setBit :: QueryResultFlagBits -> Int -> QueryResultFlagBits

clearBit :: QueryResultFlagBits -> Int -> QueryResultFlagBits

complementBit :: QueryResultFlagBits -> Int -> QueryResultFlagBits

testBit :: QueryResultFlagBits -> Int -> Bool

bitSizeMaybe :: QueryResultFlagBits -> Maybe Int

bitSize :: QueryResultFlagBits -> Int

isSigned :: QueryResultFlagBits -> Bool

shiftL :: QueryResultFlagBits -> Int -> QueryResultFlagBits

unsafeShiftL :: QueryResultFlagBits -> Int -> QueryResultFlagBits

shiftR :: QueryResultFlagBits -> Int -> QueryResultFlagBits

unsafeShiftR :: QueryResultFlagBits -> Int -> QueryResultFlagBits

rotateL :: QueryResultFlagBits -> Int -> QueryResultFlagBits

rotateR :: QueryResultFlagBits -> Int -> QueryResultFlagBits

popCount :: QueryResultFlagBits -> Int

Zero QueryResultFlagBits

Defined in Vulkan.Core10.Enums.QueryResultFlagBits

Methods

zero :: QueryResultFlagBits

type QueryResultFlags = QueryResultFlagBits

newtype QueryPipelineStatisticFlagBits

VkQueryPipelineStatisticFlagBits - Bitmask specifying queried pipeline statistics

Description

These values are intended to measure relative statistics on one implementation. Various device architectures will count these values differently. Any or all counters may be affected by the issues described in Query Operation.

Note

For example, tile-based rendering devices may need to replay the scene multiple times, affecting some of the counts.

If a pipeline has rasterizerDiscardEnable enabled, implementations may discard primitives after the final vertex processing stage. As a result, if rasterizerDiscardEnable is enabled, the clipping input and output primitives counters may not be incremented.

When a pipeline statistics query finishes, the result for that query is marked as available. The application can copy the result to a buffer (via cmdCopyQueryPoolResults), or request it be put into host memory (via getQueryPoolResults).

See Also

QueryPipelineStatisticFlags

Constructors

QueryPipelineStatisticFlagBits Flags

Bundled Patterns

pattern QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT specifies that queries managed by the pool will count the number of vertices processed by the input assembly stage. Vertices corresponding to incomplete primitives may contribute to the count.

pattern QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT specifies that queries managed by the pool will count the number of primitives processed by the input assembly stage. If primitive restart is enabled, restarting the primitive topology has no effect on the count. Incomplete primitives may be counted.

pattern QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of vertex shader invocations. This counter’s value is incremented each time a vertex shader is invoked.

pattern QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of geometry shader invocations. This counter’s value is incremented each time a geometry shader is invoked. In the case of instanced geometry shaders, the geometry shader invocations count is incremented for each separate instanced invocation.

pattern QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT specifies that queries managed by the pool will count the number of primitives generated by geometry shader invocations. The counter’s value is incremented each time the geometry shader emits a primitive. Restarting primitive topology using the SPIR-V instructions OpEndPrimitive or OpEndStreamPrimitive has no effect on the geometry shader output primitives count.

pattern QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of primitives processed by the Primitive Clipping stage of the pipeline. The counter’s value is incremented each time a primitive reaches the primitive clipping stage.

pattern QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT specifies that queries managed by the pool will count the number of primitives output by the Primitive Clipping stage of the pipeline. The counter’s value is incremented each time a primitive passes the primitive clipping stage. The actual number of primitives output by the primitive clipping stage for a particular input primitive is implementation-dependent but must satisfy the following conditions:

• If at least one vertex of the input primitive lies inside the clipping volume, the counter is incremented by one or more.
• Otherwise, the counter is incremented by zero or more.

pattern QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of fragment shader invocations. The counter’s value is incremented each time the fragment shader is invoked.

pattern QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT specifies that queries managed by the pool will count the number of patches processed by the tessellation control shader. The counter’s value is incremented once for each patch for which a tessellation control shader is invoked.

pattern QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of invocations of the tessellation evaluation shader. The counter’s value is incremented each time the tessellation evaluation shader is invoked.

pattern QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT :: QueryPipelineStatisticFlagBits

QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of compute shader invocations. The counter’s value is incremented every time the compute shader is invoked. Implementations may skip the execution of certain compute shader invocations or execute additional compute shader invocations for implementation-dependent reasons as long as the results of rendering otherwise remain unchanged.

Instances

Eq QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

(==) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Bool

(/=) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Bool

Ord QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

compare :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Ordering

(<) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Bool

(<=) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Bool

(>) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Bool

(>=) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> Bool

max :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits

min :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits

Read QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

readsPrec :: Int -> ReadS QueryPipelineStatisticFlagBits

readList :: ReadS [QueryPipelineStatisticFlagBits]

readPrec :: ReadPrec QueryPipelineStatisticFlagBits

readListPrec :: ReadPrec [QueryPipelineStatisticFlagBits]

Show QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

showsPrec :: Int -> QueryPipelineStatisticFlagBits -> ShowS

show :: QueryPipelineStatisticFlagBits -> String

showList :: [QueryPipelineStatisticFlagBits] -> ShowS

Storable QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

sizeOf :: QueryPipelineStatisticFlagBits -> Int

alignment :: QueryPipelineStatisticFlagBits -> Int

peekElemOff :: Ptr QueryPipelineStatisticFlagBits -> Int -> IO QueryPipelineStatisticFlagBits

pokeElemOff :: Ptr QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueryPipelineStatisticFlagBits

pokeByteOff :: Ptr b -> Int -> QueryPipelineStatisticFlagBits -> IO ()

peek :: Ptr QueryPipelineStatisticFlagBits -> IO QueryPipelineStatisticFlagBits

poke :: Ptr QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> IO ()

Bits QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

(.&.) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits

(.|.) :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits

xor :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits

complement :: QueryPipelineStatisticFlagBits -> QueryPipelineStatisticFlagBits

shift :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

rotate :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

zeroBits :: QueryPipelineStatisticFlagBits

bit :: Int -> QueryPipelineStatisticFlagBits

setBit :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

clearBit :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

complementBit :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

testBit :: QueryPipelineStatisticFlagBits -> Int -> Bool

bitSizeMaybe :: QueryPipelineStatisticFlagBits -> Maybe Int

bitSize :: QueryPipelineStatisticFlagBits -> Int

isSigned :: QueryPipelineStatisticFlagBits -> Bool

shiftL :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

unsafeShiftL :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

shiftR :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

unsafeShiftR :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

rotateL :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

rotateR :: QueryPipelineStatisticFlagBits -> Int -> QueryPipelineStatisticFlagBits

popCount :: QueryPipelineStatisticFlagBits -> Int

Zero QueryPipelineStatisticFlagBits

Defined in Vulkan.Core10.Enums.QueryPipelineStatisticFlagBits

Methods

zero :: QueryPipelineStatisticFlagBits

type QueryPipelineStatisticFlags = QueryPipelineStatisticFlagBits