Vulkan.Extensions.VK_KHR_performance_query

Name

VK_KHR_performance_query - device extension

VK_KHR_performance_query

Name String

VK_KHR_performance_query

Extension Type

Device extension

Registered Extension Number

117

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Special Use

• Developer tools

Contact

• Alon Or-bach @alonorbach%0A<<Here describe the issue or question you have about the VK_KHR_performance_query extension> >

Other Extension Metadata

Last Modified Date

2019-10-08

IP Status

No known IP claims.

Contributors

• Jesse Barker, Unity Technologies
• Kenneth Benzie, Codeplay
• Jan-Harald Fredriksen, ARM
• Jeff Leger, Qualcomm
• Jesse Hall, Google
• Tobias Hector, AMD
• Neil Henning, Codeplay
• Baldur Karlsson
• Lionel Landwerlin, Intel
• Peter Lohrmann, AMD
• Alon Or-bach, Samsung
• Daniel Rakos, AMD
• Niklas Smedberg, Unity Technologies
• Igor Ostrowski, Intel

Description

The VK_KHR_performance_query extension adds a mechanism to allow querying of performance counters for use in applications and by profiling tools.

Each queue family may expose counters that can be enabled on a queue of that family. We extend QueryType to add a new query type for performance queries, and chain a structure on QueryPoolCreateInfo to specify the performance queries to enable.

New Commands

• acquireProfilingLockKHR

• enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR
• getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR
• releaseProfilingLockKHR

New Structures

• AcquireProfilingLockInfoKHR

• PerformanceCounterDescriptionKHR
• PerformanceCounterKHR

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDevicePerformanceQueryFeaturesKHR

• Extending PhysicalDeviceProperties2:

  • PhysicalDevicePerformanceQueryPropertiesKHR

• Extending QueryPoolCreateInfo:

  • QueryPoolPerformanceCreateInfoKHR

• Extending SubmitInfo, SubmitInfo2KHR:

  • PerformanceQuerySubmitInfoKHR

New Unions

• PerformanceCounterResultKHR

New Enums

• AcquireProfilingLockFlagBitsKHR

• PerformanceCounterDescriptionFlagBitsKHR
• PerformanceCounterScopeKHR
• PerformanceCounterStorageKHR
• PerformanceCounterUnitKHR

New Bitmasks

• AcquireProfilingLockFlagsKHR

• PerformanceCounterDescriptionFlagsKHR

New Enum Constants

• KHR_PERFORMANCE_QUERY_EXTENSION_NAME

• KHR_PERFORMANCE_QUERY_SPEC_VERSION

• Extending QueryType:

  • QUERY_TYPE_PERFORMANCE_QUERY_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR
  • STRUCTURE_TYPE_PERFORMANCE_COUNTER_DESCRIPTION_KHR
  • STRUCTURE_TYPE_PERFORMANCE_COUNTER_KHR
  • STRUCTURE_TYPE_PERFORMANCE_QUERY_SUBMIT_INFO_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_PERFORMANCE_QUERY_FEATURES_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_PERFORMANCE_QUERY_PROPERTIES_KHR
  • STRUCTURE_TYPE_QUERY_POOL_PERFORMANCE_CREATE_INFO_KHR

Issues

1) Should this extension include a mechanism to begin a query in command buffer A and end the query in command buffer B?

RESOLVED No - queries are tied to command buffer creation and thus have to be encapsulated within a single command buffer.

2) Should this extension include a mechanism to begin and end queries globally on the queue, not using the existing command buffer commands?

RESOLVED No - for the same reasoning as the resolution of 1).

3) Should this extension expose counters that require multiple passes?

RESOLVED Yes - users should re-submit a command buffer with the same commands in it multiple times, specifying the pass to count as the query parameter in VkPerformanceQuerySubmitInfoKHR.

4) How to handle counters across parallel workloads?

RESOLVED In the spirit of Vulkan, a counter description flag PERFORMANCE_COUNTER_DESCRIPTION_CONCURRENTLY_IMPACTED_BIT_KHR denotes that the accuracy of a counter result is affected by parallel workloads.

5) How to handle secondary command buffers?

RESOLVED Secondary command buffers inherit any counter pass index specified in the parent primary command buffer. Note: this is no longer an issue after change from issue 10 resolution

6) What commands does the profiling lock have to be held for?

RESOLVED For any command buffer that is being queried with a performance query pool, the profiling lock must be held while that command buffer is in the recording, executable, or pending state.

7) Should we support cmdCopyQueryPoolResults?

RESOLVED Yes.

8) Should we allow performance queries to interact with multiview?

RESOLVED Yes, but the performance queries must be performed once for each pass per view.

9) Should a queryCount > 1 be usable for performance queries?

RESOLVED Yes. Some vendors will have costly performance counter query pool creation, and would rather if a certain set of counters were to be used multiple times that a queryCount > 1 can be used to amortize the instantiation cost.

10) Should we introduce an indirect mechanism to set the counter pass index?

RESOLVED Specify the counter pass index at submit time instead, to avoid requiring re-recording of command buffers when multiple counter passes are needed.

Examples

The following example shows how to find what performance counters a queue family supports, setup a query pool to record these performance counters, how to add the query pool to the command buffer to record information, and how to get the results from the query pool.

// A previously created physical device
VkPhysicalDevice physicalDevice;

// One of the queue families our device supports
uint32_t queueFamilyIndex;

uint32_t counterCount;

// Get the count of counters supported
vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR(
  physicalDevice,
  queueFamilyIndex,
  &counterCount,
  NULL,
  NULL);

VkPerformanceCounterKHR* counters =
  malloc(sizeof(VkPerformanceCounterKHR) * counterCount);
VkPerformanceCounterDescriptionKHR* counterDescriptions =
  malloc(sizeof(VkPerformanceCounterDescriptionKHR) * counterCount);

// Get the counters supported
vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR(
  physicalDevice,
  queueFamilyIndex,
  &counterCount,
  counters,
  counterDescriptions);

// Try to enable the first 8 counters
uint32_t enabledCounters[8];

const uint32_t enabledCounterCount = min(counterCount, 8));

for (uint32_t i = 0; i < enabledCounterCount; i++) {
  enabledCounters[i] = i;
}

// A previously created device that had the performanceCounterQueryPools feature
// set to VK_TRUE
VkDevice device;

VkQueryPoolPerformanceCreateInfoKHR performanceQueryCreateInfo = {
  VK_STRUCTURE_TYPE_QUERY_POOL_PERFORMANCE_CREATE_INFO_KHR,
  NULL,

  // Specify the queue family that this performance query is performed on
  queueFamilyIndex,

  // The number of counters to enable
  enabledCounterCount,

  // The array of indices of counters to enable
  enabledCounters
};


// Get the number of passes our counters will require.
uint32_t numPasses;

vkGetPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR(
  physicalDevice,
  &performanceQueryCreateInfo,
  &numPasses);

VkQueryPoolCreateInfo queryPoolCreateInfo = {
  VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO,
  &performanceQueryCreateInfo,
  0,

  // Using our new query type here
  VK_QUERY_TYPE_PERFORMANCE_QUERY_KHR,

  1,

  0
};

VkQueryPool queryPool;

VkResult result = vkCreateQueryPool(
  device,
  &queryPoolCreateInfo,
  NULL,
  &queryPool);

assert(VK_SUCCESS == result);

// A queue from queueFamilyIndex
VkQueue queue;

// A command buffer we want to record counters on
VkCommandBuffer commandBuffer;

VkCommandBufferBeginInfo commandBufferBeginInfo = {
  VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO,
  NULL,
  0,
  NULL
};

VkAcquireProfilingLockInfoKHR lockInfo = {
  VK_STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR,
  NULL,
  0,
  UINT64_MAX // Wait forever for the lock
};

// Acquire the profiling lock before we record command buffers
// that will use performance queries

result = vkAcquireProfilingLockKHR(device, &lockInfo);

assert(VK_SUCCESS == result);

result = vkBeginCommandBuffer(commandBuffer, &commandBufferBeginInfo);

assert(VK_SUCCESS == result);

vkCmdResetQueryPool(
  commandBuffer,
  queryPool,
  0,
  1);

vkCmdBeginQuery(
  commandBuffer,
  queryPool,
  0,
  0);

// Perform the commands you want to get performance information on
// ...

// Perform a barrier to ensure all previous commands were complete before
// ending the query
vkCmdPipelineBarrier(commandBuffer,
  VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
  VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
  0,
  0,
  NULL,
  0,
  NULL,
  0,
  NULL);

vkCmdEndQuery(
  commandBuffer,
  queryPool,
  0);

result = vkEndCommandBuffer(commandBuffer);

assert(VK_SUCCESS == result);

for (uint32_t counterPass = 0; counterPass < numPasses; counterPass++) {

  VkPerformanceQuerySubmitInfoKHR performanceQuerySubmitInfo = {
    VK_STRUCTURE_TYPE_PERFORMANCE_QUERY_SUBMIT_INFO_KHR,
    NULL,
    counterPass
  };


  // Submit the command buffer and wait for its completion
  // ...
}

// Release the profiling lock after the command buffer is no longer in the
// pending state.
vkReleaseProfilingLockKHR(device);

result = vkResetCommandBuffer(commandBuffer, 0);

assert(VK_SUCCESS == result);

// Create an array to hold the results of all counters
VkPerformanceCounterResultKHR* recordedCounters = malloc(
  sizeof(VkPerformanceCounterResultKHR) * enabledCounterCount);

result = vkGetQueryPoolResults(
  device,
  queryPool,
  0,
  1,
  sizeof(VkPerformanceCounterResultKHR) * enabledCounterCount,
  recordedCounters,
  sizeof(VkPerformanceCounterResultKHR),
  NULL);

// recordedCounters is filled with our counters, we will look at one for posterity
switch (counters[0].storage) {
  case VK_PERFORMANCE_COUNTER_STORAGE_INT32:
    // use recordCounters[0].int32 to get at the counter result!
    break;
  case VK_PERFORMANCE_COUNTER_STORAGE_INT64:
    // use recordCounters[0].int64 to get at the counter result!
    break;
  case VK_PERFORMANCE_COUNTER_STORAGE_UINT32:
    // use recordCounters[0].uint32 to get at the counter result!
    break;
  case VK_PERFORMANCE_COUNTER_STORAGE_UINT64:
    // use recordCounters[0].uint64 to get at the counter result!
    break;
  case VK_PERFORMANCE_COUNTER_STORAGE_FLOAT32:
    // use recordCounters[0].float32 to get at the counter result!
    break;
  case VK_PERFORMANCE_COUNTER_STORAGE_FLOAT64:
    // use recordCounters[0].float64 to get at the counter result!
    break;
}

Version History

• Revision 1, 2019-10-08

See Also

AcquireProfilingLockFlagBitsKHR, AcquireProfilingLockFlagsKHR, AcquireProfilingLockInfoKHR, PerformanceCounterDescriptionFlagBitsKHR, PerformanceCounterDescriptionFlagsKHR, PerformanceCounterDescriptionKHR, PerformanceCounterKHR, PerformanceCounterResultKHR, PerformanceCounterScopeKHR, PerformanceCounterStorageKHR, PerformanceCounterUnitKHR, PerformanceQuerySubmitInfoKHR, PhysicalDevicePerformanceQueryFeaturesKHR, PhysicalDevicePerformanceQueryPropertiesKHR, QueryPoolPerformanceCreateInfoKHR, acquireProfilingLockKHR, enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR, getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR, releaseProfilingLockKHR

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the handle to the physical device whose queue family performance query counter properties will be queried.

-> ("queueFamilyIndex" ::: Word32)

queueFamilyIndex is the index into the queue family of the physical device we want to get properties for.

-> io (Result, "counters" ::: Vector PerformanceCounterKHR, "counterDescriptions" ::: Vector PerformanceCounterDescriptionKHR)

vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR - Reports properties of the performance query counters available on a queue family of a device

Description

If pCounters is NULL and pCounterDescriptions is NULL, then the number of counters available is returned in pCounterCount. Otherwise, pCounterCount must point to a variable set by the user to the number of elements in the pCounters, pCounterDescriptions, or both arrays and on return the variable is overwritten with the number of structures actually written out. If pCounterCount is less than the number of counters available, at most pCounterCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available counters were returned.

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• pCounterCount must be a valid pointer to a uint32_t value
• If the value referenced by pCounterCount is not 0, and pCounters is not NULL, pCounters must be a valid pointer to an array of pCounterCount PerformanceCounterKHR structures
• If the value referenced by pCounterCount is not 0, and pCounterDescriptions is not NULL, pCounterDescriptions must be a valid pointer to an array of pCounterCount PerformanceCounterDescriptionKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

See Also

VK_KHR_performance_query, PerformanceCounterDescriptionKHR, PerformanceCounterKHR, PhysicalDevice

getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the handle to the physical device whose queue family performance query counter properties will be queried.

physicalDevice must be a valid PhysicalDevice handle

-> ("performanceQueryCreateInfo" ::: QueryPoolPerformanceCreateInfoKHR)

pPerformanceQueryCreateInfo is a pointer to a QueryPoolPerformanceCreateInfoKHR of the performance query that is to be created.

pPerformanceQueryCreateInfo must be a valid pointer to a valid QueryPoolPerformanceCreateInfoKHR structure

-> io ("numPasses" ::: Word32)

vkGetPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR - Reports the number of passes require for a performance query pool type

Description

The pPerformanceQueryCreateInfo member QueryPoolPerformanceCreateInfoKHR::queueFamilyIndex must be a queue family of physicalDevice. The number of passes required to capture the counters specified in the pPerformanceQueryCreateInfo member QueryPoolPerformanceCreateInfoKHR::pCounters is returned in pNumPasses.

Valid Usage (Implicit)

See Also

VK_KHR_performance_query, PhysicalDevice, QueryPoolPerformanceCreateInfoKHR

acquireProfilingLockKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device to profile.

device must be a valid Device handle

-> AcquireProfilingLockInfoKHR

pInfo is a pointer to a AcquireProfilingLockInfoKHR structure containing information about how the profiling is to be acquired.

pInfo must be a valid pointer to a valid AcquireProfilingLockInfoKHR structure

-> io ()

vkAcquireProfilingLockKHR - Acquires the profiling lock

Description

Implementations may allow multiple actors to hold the profiling lock concurrently.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• TIMEOUT

See Also

VK_KHR_performance_query, AcquireProfilingLockInfoKHR, Device

releaseProfilingLockKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device to cease profiling on.

-> io ()

vkReleaseProfilingLockKHR - Releases the profiling lock

Valid Usage

• The profiling lock of device must have been held via a previous successful call to acquireProfilingLockKHR

Valid Usage (Implicit)

• device must be a valid Device handle

See Also

VK_KHR_performance_query, Device

pattern QUERY_SCOPE_COMMAND_BUFFER_KHR :: PerformanceCounterScopeKHR

pattern QUERY_SCOPE_RENDER_PASS_KHR :: PerformanceCounterScopeKHR

pattern QUERY_SCOPE_COMMAND_KHR :: PerformanceCounterScopeKHR

pattern PERFORMANCE_COUNTER_DESCRIPTION_PERFORMANCE_IMPACTING_KHR :: PerformanceCounterDescriptionFlagBitsKHR

pattern PERFORMANCE_COUNTER_DESCRIPTION_CONCURRENTLY_IMPACTED_KHR :: PerformanceCounterDescriptionFlagBitsKHR

data PhysicalDevicePerformanceQueryFeaturesKHR

VkPhysicalDevicePerformanceQueryFeaturesKHR - Structure describing performance query support for an implementation

Members

This structure describes the following features:

Description

If the PhysicalDevicePerformanceQueryFeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDevicePerformanceQueryFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_performance_query, Bool32, StructureType

Constructors

PhysicalDevicePerformanceQueryFeaturesKHR

Fields

• performanceCounterQueryPools :: Bool

  performanceCounterQueryPools indicates whether the implementation supports performance counter query pools.

• performanceCounterMultipleQueryPools :: Bool

  performanceCounterMultipleQueryPools indicates whether the implementation supports using multiple performance query pools in a primary command buffer and secondary command buffers executed within it.

Instances

Eq PhysicalDevicePerformanceQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PhysicalDevicePerformanceQueryFeaturesKHR -> PhysicalDevicePerformanceQueryFeaturesKHR -> Bool

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

Show PhysicalDevicePerformanceQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PhysicalDevicePerformanceQueryFeaturesKHR -> ShowS

show :: PhysicalDevicePerformanceQueryFeaturesKHR -> String

showList :: [PhysicalDevicePerformanceQueryFeaturesKHR] -> ShowS

Storable PhysicalDevicePerformanceQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PhysicalDevicePerformanceQueryFeaturesKHR -> Int

alignment :: PhysicalDevicePerformanceQueryFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> Int -> IO PhysicalDevicePerformanceQueryFeaturesKHR

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

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

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

peek :: Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> IO PhysicalDevicePerformanceQueryFeaturesKHR

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

FromCStruct PhysicalDevicePerformanceQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> IO PhysicalDevicePerformanceQueryFeaturesKHR

ToCStruct PhysicalDevicePerformanceQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: PhysicalDevicePerformanceQueryFeaturesKHR -> (Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> PhysicalDevicePerformanceQueryFeaturesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDevicePerformanceQueryFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDevicePerformanceQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PhysicalDevicePerformanceQueryFeaturesKHR

data PhysicalDevicePerformanceQueryPropertiesKHR

VkPhysicalDevicePerformanceQueryPropertiesKHR - Structure describing performance query properties for an implementation

Description

If the PhysicalDevicePerformanceQueryPropertiesKHR structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_KHR_performance_query, Bool32, StructureType

Constructors

PhysicalDevicePerformanceQueryPropertiesKHR

Fields

• allowCommandBufferQueryCopies :: Bool

  allowCommandBufferQueryCopies is TRUE if the performance query pools are allowed to be used with cmdCopyQueryPoolResults.

Instances

Eq PhysicalDevicePerformanceQueryPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PhysicalDevicePerformanceQueryPropertiesKHR -> PhysicalDevicePerformanceQueryPropertiesKHR -> Bool

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

Show PhysicalDevicePerformanceQueryPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PhysicalDevicePerformanceQueryPropertiesKHR -> ShowS

show :: PhysicalDevicePerformanceQueryPropertiesKHR -> String

showList :: [PhysicalDevicePerformanceQueryPropertiesKHR] -> ShowS

Storable PhysicalDevicePerformanceQueryPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PhysicalDevicePerformanceQueryPropertiesKHR -> Int

alignment :: PhysicalDevicePerformanceQueryPropertiesKHR -> Int

peekElemOff :: Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> Int -> IO PhysicalDevicePerformanceQueryPropertiesKHR

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

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

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

peek :: Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> IO PhysicalDevicePerformanceQueryPropertiesKHR

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

FromCStruct PhysicalDevicePerformanceQueryPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> IO PhysicalDevicePerformanceQueryPropertiesKHR

ToCStruct PhysicalDevicePerformanceQueryPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: PhysicalDevicePerformanceQueryPropertiesKHR -> (Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> PhysicalDevicePerformanceQueryPropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDevicePerformanceQueryPropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDevicePerformanceQueryPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PhysicalDevicePerformanceQueryPropertiesKHR

data PerformanceCounterKHR

VkPerformanceCounterKHR - Structure providing information about a counter

Valid Usage (Implicit)

See Also

VK_KHR_performance_query, PerformanceCounterScopeKHR, PerformanceCounterStorageKHR, PerformanceCounterUnitKHR, StructureType, enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR

Constructors

PerformanceCounterKHR

Fields

• unit :: PerformanceCounterUnitKHR

  unit is a PerformanceCounterUnitKHR specifying the unit that the counter data will record.

• scope :: PerformanceCounterScopeKHR

  scope is a PerformanceCounterScopeKHR specifying the scope that the counter belongs to.

• storage :: PerformanceCounterStorageKHR

  storage is a PerformanceCounterStorageKHR specifying the storage type that the counter’s data uses.

• uuid :: ByteString

  uuid is an array of size UUID_SIZE, containing 8-bit values that represent a universally unique identifier for the counter of the physical device.

Instances

Show PerformanceCounterKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterKHR -> ShowS

show :: PerformanceCounterKHR -> String

showList :: [PerformanceCounterKHR] -> ShowS

Storable PerformanceCounterKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceCounterKHR -> Int

alignment :: PerformanceCounterKHR -> Int

peekElemOff :: Ptr PerformanceCounterKHR -> Int -> IO PerformanceCounterKHR

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

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

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

peek :: Ptr PerformanceCounterKHR -> IO PerformanceCounterKHR

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

FromCStruct PerformanceCounterKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr PerformanceCounterKHR -> IO PerformanceCounterKHR

ToCStruct PerformanceCounterKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: PerformanceCounterKHR -> (Ptr PerformanceCounterKHR -> IO b) -> IO b

pokeCStruct :: Ptr PerformanceCounterKHR -> PerformanceCounterKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PerformanceCounterKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PerformanceCounterKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PerformanceCounterKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterKHR

data PerformanceCounterDescriptionKHR

VkPerformanceCounterDescriptionKHR - Structure providing more detailed information about a counter

Valid Usage (Implicit)

See Also

VK_KHR_performance_query, PerformanceCounterDescriptionFlagsKHR, StructureType, enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR

Constructors

PerformanceCounterDescriptionKHR

Fields

• flags :: PerformanceCounterDescriptionFlagsKHR

  flags is a bitmask of PerformanceCounterDescriptionFlagBitsKHR indicating the usage behavior for the counter.

• name :: ByteString

  name is an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.

• category :: ByteString

  category is an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.

• description :: ByteString

  description is an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.

Instances

Show PerformanceCounterDescriptionKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterDescriptionKHR -> ShowS

show :: PerformanceCounterDescriptionKHR -> String

showList :: [PerformanceCounterDescriptionKHR] -> ShowS

Storable PerformanceCounterDescriptionKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceCounterDescriptionKHR -> Int

alignment :: PerformanceCounterDescriptionKHR -> Int

peekElemOff :: Ptr PerformanceCounterDescriptionKHR -> Int -> IO PerformanceCounterDescriptionKHR

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

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

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

peek :: Ptr PerformanceCounterDescriptionKHR -> IO PerformanceCounterDescriptionKHR

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

FromCStruct PerformanceCounterDescriptionKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr PerformanceCounterDescriptionKHR -> IO PerformanceCounterDescriptionKHR

ToCStruct PerformanceCounterDescriptionKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: PerformanceCounterDescriptionKHR -> (Ptr PerformanceCounterDescriptionKHR -> IO b) -> IO b

pokeCStruct :: Ptr PerformanceCounterDescriptionKHR -> PerformanceCounterDescriptionKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PerformanceCounterDescriptionKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PerformanceCounterDescriptionKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PerformanceCounterDescriptionKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterDescriptionKHR

data QueryPoolPerformanceCreateInfoKHR

VkQueryPoolPerformanceCreateInfoKHR - Structure specifying parameters of a newly created performance query pool

Valid Usage

• queueFamilyIndex must be a valid queue family index of the device

• The performanceCounterQueryPools feature must be enabled
• Each element of pCounterIndices must be in the range of counters reported by enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR for the queue family specified in queueFamilyIndex

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUERY_POOL_PERFORMANCE_CREATE_INFO_KHR

• pCounterIndices must be a valid pointer to an array of counterIndexCount uint32_t values
• counterIndexCount must be greater than 0

See Also

VK_KHR_performance_query, StructureType, getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR

Constructors

QueryPoolPerformanceCreateInfoKHR

Fields

• queueFamilyIndex :: Word32

  queueFamilyIndex is the queue family index to create this performance query pool for.

• counterIndices :: Vector Word32

  pCounterIndices is a pointer to an array of indices into the enumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR::pCounters to enable in this performance query pool.

Instances

Show QueryPoolPerformanceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> QueryPoolPerformanceCreateInfoKHR -> ShowS

show :: QueryPoolPerformanceCreateInfoKHR -> String

showList :: [QueryPoolPerformanceCreateInfoKHR] -> ShowS

FromCStruct QueryPoolPerformanceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr QueryPoolPerformanceCreateInfoKHR -> IO QueryPoolPerformanceCreateInfoKHR

ToCStruct QueryPoolPerformanceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: QueryPoolPerformanceCreateInfoKHR -> (Ptr QueryPoolPerformanceCreateInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr QueryPoolPerformanceCreateInfoKHR -> QueryPoolPerformanceCreateInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr QueryPoolPerformanceCreateInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr QueryPoolPerformanceCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero QueryPoolPerformanceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: QueryPoolPerformanceCreateInfoKHR

data AcquireProfilingLockInfoKHR

VkAcquireProfilingLockInfoKHR - Structure specifying parameters to acquire the profiling lock

Valid Usage (Implicit)

If timeout is 0, acquireProfilingLockKHR will not block while attempting to acquire the profling lock. If timeout is UINT64_MAX, the function will not return until the profiling lock was acquired.

See Also

VK_KHR_performance_query, AcquireProfilingLockFlagsKHR, StructureType, acquireProfilingLockKHR

Constructors

AcquireProfilingLockInfoKHR

Fields

• flags :: AcquireProfilingLockFlagsKHR

  flags is reserved for future use.

  flags must be 0

• timeout :: Word64

  timeout indicates how long the function waits, in nanoseconds, if the profiling lock is not available.

Instances

Eq AcquireProfilingLockInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: AcquireProfilingLockInfoKHR -> AcquireProfilingLockInfoKHR -> Bool

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

Show AcquireProfilingLockInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> AcquireProfilingLockInfoKHR -> ShowS

show :: AcquireProfilingLockInfoKHR -> String

showList :: [AcquireProfilingLockInfoKHR] -> ShowS

Storable AcquireProfilingLockInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: AcquireProfilingLockInfoKHR -> Int

alignment :: AcquireProfilingLockInfoKHR -> Int

peekElemOff :: Ptr AcquireProfilingLockInfoKHR -> Int -> IO AcquireProfilingLockInfoKHR

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

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

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

peek :: Ptr AcquireProfilingLockInfoKHR -> IO AcquireProfilingLockInfoKHR

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

FromCStruct AcquireProfilingLockInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr AcquireProfilingLockInfoKHR -> IO AcquireProfilingLockInfoKHR

ToCStruct AcquireProfilingLockInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: AcquireProfilingLockInfoKHR -> (Ptr AcquireProfilingLockInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr AcquireProfilingLockInfoKHR -> AcquireProfilingLockInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr AcquireProfilingLockInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr AcquireProfilingLockInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AcquireProfilingLockInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: AcquireProfilingLockInfoKHR

data PerformanceQuerySubmitInfoKHR

VkPerformanceQuerySubmitInfoKHR - Structure indicating which counter pass index is active for performance queries

Description

If the SubmitInfo::pNext chain does not include this structure, the batch defaults to use counter pass index 0.

Valid Usage (Implicit)

See Also

VK_KHR_performance_query, StructureType

Constructors

PerformanceQuerySubmitInfoKHR

Fields

• counterPassIndex :: Word32

  counterPassIndex specifies which counter pass index is active.

  counterPassIndex must be less than the number of counter passes required by any queries within the batch. The required number of counter passes for a performance query is obtained by calling getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR

Instances

Eq PerformanceQuerySubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PerformanceQuerySubmitInfoKHR -> PerformanceQuerySubmitInfoKHR -> Bool

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

Show PerformanceQuerySubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceQuerySubmitInfoKHR -> ShowS

show :: PerformanceQuerySubmitInfoKHR -> String

showList :: [PerformanceQuerySubmitInfoKHR] -> ShowS

Storable PerformanceQuerySubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceQuerySubmitInfoKHR -> Int

alignment :: PerformanceQuerySubmitInfoKHR -> Int

peekElemOff :: Ptr PerformanceQuerySubmitInfoKHR -> Int -> IO PerformanceQuerySubmitInfoKHR

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

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

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

peek :: Ptr PerformanceQuerySubmitInfoKHR -> IO PerformanceQuerySubmitInfoKHR

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

FromCStruct PerformanceQuerySubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

peekCStruct :: Ptr PerformanceQuerySubmitInfoKHR -> IO PerformanceQuerySubmitInfoKHR

ToCStruct PerformanceQuerySubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: PerformanceQuerySubmitInfoKHR -> (Ptr PerformanceQuerySubmitInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr PerformanceQuerySubmitInfoKHR -> PerformanceQuerySubmitInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PerformanceQuerySubmitInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PerformanceQuerySubmitInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PerformanceQuerySubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceQuerySubmitInfoKHR

data PerformanceCounterResultKHR

Constructors

Int32Counter Int32

Int64Counter Int64

Uint32Counter Word32

Uint64Counter Word64

Float32Counter Float

Float64Counter Double

Instances

Show PerformanceCounterResultKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterResultKHR -> ShowS

show :: PerformanceCounterResultKHR -> String

showList :: [PerformanceCounterResultKHR] -> ShowS

ToCStruct PerformanceCounterResultKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

withCStruct :: PerformanceCounterResultKHR -> (Ptr PerformanceCounterResultKHR -> IO b) -> IO b

pokeCStruct :: Ptr PerformanceCounterResultKHR -> PerformanceCounterResultKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PerformanceCounterResultKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PerformanceCounterResultKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PerformanceCounterResultKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterResultKHR

newtype PerformanceCounterScopeKHR

VkPerformanceCounterScopeKHR - Supported counter scope types

See Also

VK_KHR_performance_query, PerformanceCounterKHR

Constructors

PerformanceCounterScopeKHR Int32

Bundled Patterns

pattern PERFORMANCE_COUNTER_SCOPE_COMMAND_BUFFER_KHR :: PerformanceCounterScopeKHR

PERFORMANCE_COUNTER_SCOPE_COMMAND_BUFFER_KHR - the performance counter scope is a single complete command buffer.

pattern PERFORMANCE_COUNTER_SCOPE_RENDER_PASS_KHR :: PerformanceCounterScopeKHR

PERFORMANCE_COUNTER_SCOPE_RENDER_PASS_KHR - the performance counter scope is zero or more complete render passes. The performance query containing the performance counter must begin and end outside a render pass instance.

pattern PERFORMANCE_COUNTER_SCOPE_COMMAND_KHR :: PerformanceCounterScopeKHR

PERFORMANCE_COUNTER_SCOPE_COMMAND_KHR - the performance counter scope is zero or more commands.

Instances

Eq PerformanceCounterScopeKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> Bool

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

Ord PerformanceCounterScopeKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

compare :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> Ordering

(<) :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> Bool

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

(>) :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> Bool

(>=) :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> Bool

max :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR

min :: PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR -> PerformanceCounterScopeKHR

Read PerformanceCounterScopeKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

readsPrec :: Int -> ReadS PerformanceCounterScopeKHR

readList :: ReadS [PerformanceCounterScopeKHR]

readPrec :: ReadPrec PerformanceCounterScopeKHR

readListPrec :: ReadPrec [PerformanceCounterScopeKHR]

Show PerformanceCounterScopeKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterScopeKHR -> ShowS

show :: PerformanceCounterScopeKHR -> String

showList :: [PerformanceCounterScopeKHR] -> ShowS

Storable PerformanceCounterScopeKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceCounterScopeKHR -> Int

alignment :: PerformanceCounterScopeKHR -> Int

peekElemOff :: Ptr PerformanceCounterScopeKHR -> Int -> IO PerformanceCounterScopeKHR

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

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

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

peek :: Ptr PerformanceCounterScopeKHR -> IO PerformanceCounterScopeKHR

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

Zero PerformanceCounterScopeKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterScopeKHR

newtype PerformanceCounterUnitKHR

VkPerformanceCounterUnitKHR - Supported counter unit types

See Also

VK_KHR_performance_query, PerformanceCounterKHR

Constructors

PerformanceCounterUnitKHR Int32

Bundled Patterns

pattern PERFORMANCE_COUNTER_UNIT_GENERIC_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_GENERIC_KHR - the performance counter unit is a generic data point.

pattern PERFORMANCE_COUNTER_UNIT_PERCENTAGE_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_PERCENTAGE_KHR - the performance counter unit is a percentage (%).

pattern PERFORMANCE_COUNTER_UNIT_NANOSECONDS_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_NANOSECONDS_KHR - the performance counter unit is a value of nanoseconds (ns).

pattern PERFORMANCE_COUNTER_UNIT_BYTES_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_BYTES_KHR - the performance counter unit is a value of bytes.

pattern PERFORMANCE_COUNTER_UNIT_BYTES_PER_SECOND_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_BYTES_PER_SECOND_KHR - the performance counter unit is a value of bytes/s.

pattern PERFORMANCE_COUNTER_UNIT_KELVIN_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_KELVIN_KHR - the performance counter unit is a temperature reported in Kelvin.

pattern PERFORMANCE_COUNTER_UNIT_WATTS_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_WATTS_KHR - the performance counter unit is a value of watts (W).

pattern PERFORMANCE_COUNTER_UNIT_VOLTS_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_VOLTS_KHR - the performance counter unit is a value of volts (V).

pattern PERFORMANCE_COUNTER_UNIT_AMPS_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_AMPS_KHR - the performance counter unit is a value of amps (A).

pattern PERFORMANCE_COUNTER_UNIT_HERTZ_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_HERTZ_KHR - the performance counter unit is a value of hertz (Hz).

pattern PERFORMANCE_COUNTER_UNIT_CYCLES_KHR :: PerformanceCounterUnitKHR

PERFORMANCE_COUNTER_UNIT_CYCLES_KHR - the performance counter unit is a value of cycles.

Instances

Eq PerformanceCounterUnitKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> Bool

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

Ord PerformanceCounterUnitKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

compare :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> Ordering

(<) :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> Bool

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

(>) :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> Bool

(>=) :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> Bool

max :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR

min :: PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR -> PerformanceCounterUnitKHR

Read PerformanceCounterUnitKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

readsPrec :: Int -> ReadS PerformanceCounterUnitKHR

readList :: ReadS [PerformanceCounterUnitKHR]

readPrec :: ReadPrec PerformanceCounterUnitKHR

readListPrec :: ReadPrec [PerformanceCounterUnitKHR]

Show PerformanceCounterUnitKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterUnitKHR -> ShowS

show :: PerformanceCounterUnitKHR -> String

showList :: [PerformanceCounterUnitKHR] -> ShowS

Storable PerformanceCounterUnitKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceCounterUnitKHR -> Int

alignment :: PerformanceCounterUnitKHR -> Int

peekElemOff :: Ptr PerformanceCounterUnitKHR -> Int -> IO PerformanceCounterUnitKHR

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

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

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

peek :: Ptr PerformanceCounterUnitKHR -> IO PerformanceCounterUnitKHR

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

Zero PerformanceCounterUnitKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterUnitKHR

newtype PerformanceCounterStorageKHR

VkPerformanceCounterStorageKHR - Supported counter storage types

See Also

VK_KHR_performance_query, PerformanceCounterKHR

Constructors

PerformanceCounterStorageKHR Int32

Bundled Patterns

pattern PERFORMANCE_COUNTER_STORAGE_INT32_KHR :: PerformanceCounterStorageKHR

PERFORMANCE_COUNTER_STORAGE_INT32_KHR - the performance counter storage is a 32-bit signed integer.

pattern PERFORMANCE_COUNTER_STORAGE_INT64_KHR :: PerformanceCounterStorageKHR

PERFORMANCE_COUNTER_STORAGE_INT64_KHR - the performance counter storage is a 64-bit signed integer.

pattern PERFORMANCE_COUNTER_STORAGE_UINT32_KHR :: PerformanceCounterStorageKHR

PERFORMANCE_COUNTER_STORAGE_UINT32_KHR - the performance counter storage is a 32-bit unsigned integer.

pattern PERFORMANCE_COUNTER_STORAGE_UINT64_KHR :: PerformanceCounterStorageKHR

PERFORMANCE_COUNTER_STORAGE_UINT64_KHR - the performance counter storage is a 64-bit unsigned integer.

pattern PERFORMANCE_COUNTER_STORAGE_FLOAT32_KHR :: PerformanceCounterStorageKHR

PERFORMANCE_COUNTER_STORAGE_FLOAT32_KHR - the performance counter storage is a 32-bit floating-point.

pattern PERFORMANCE_COUNTER_STORAGE_FLOAT64_KHR :: PerformanceCounterStorageKHR

PERFORMANCE_COUNTER_STORAGE_FLOAT64_KHR - the performance counter storage is a 64-bit floating-point.

Instances

Eq PerformanceCounterStorageKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> Bool

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

Ord PerformanceCounterStorageKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

compare :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> Ordering

(<) :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> Bool

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

(>) :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> Bool

(>=) :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> Bool

max :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR

min :: PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR -> PerformanceCounterStorageKHR

Read PerformanceCounterStorageKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

readsPrec :: Int -> ReadS PerformanceCounterStorageKHR

readList :: ReadS [PerformanceCounterStorageKHR]

readPrec :: ReadPrec PerformanceCounterStorageKHR

readListPrec :: ReadPrec [PerformanceCounterStorageKHR]

Show PerformanceCounterStorageKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterStorageKHR -> ShowS

show :: PerformanceCounterStorageKHR -> String

showList :: [PerformanceCounterStorageKHR] -> ShowS

Storable PerformanceCounterStorageKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceCounterStorageKHR -> Int

alignment :: PerformanceCounterStorageKHR -> Int

peekElemOff :: Ptr PerformanceCounterStorageKHR -> Int -> IO PerformanceCounterStorageKHR

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

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

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

peek :: Ptr PerformanceCounterStorageKHR -> IO PerformanceCounterStorageKHR

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

Zero PerformanceCounterStorageKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterStorageKHR

type PerformanceCounterDescriptionFlagsKHR = PerformanceCounterDescriptionFlagBitsKHR

newtype PerformanceCounterDescriptionFlagBitsKHR

VkPerformanceCounterDescriptionFlagBitsKHR - Bitmask specifying usage behavior for a counter

See Also

VK_KHR_performance_query, PerformanceCounterDescriptionFlagsKHR

Constructors

PerformanceCounterDescriptionFlagBitsKHR Flags

Bundled Patterns

pattern PERFORMANCE_COUNTER_DESCRIPTION_PERFORMANCE_IMPACTING_BIT_KHR :: PerformanceCounterDescriptionFlagBitsKHR

PERFORMANCE_COUNTER_DESCRIPTION_PERFORMANCE_IMPACTING_BIT_KHR specifies that recording the counter may have a noticeable performance impact.

pattern PERFORMANCE_COUNTER_DESCRIPTION_CONCURRENTLY_IMPACTED_BIT_KHR :: PerformanceCounterDescriptionFlagBitsKHR

PERFORMANCE_COUNTER_DESCRIPTION_CONCURRENTLY_IMPACTED_BIT_KHR specifies that concurrently recording the counter while other submitted command buffers are running may impact the accuracy of the recording.

Instances

Eq PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> Bool

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

Ord PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

compare :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> Ordering

(<) :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> Bool

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

(>) :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> Bool

(>=) :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> Bool

max :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR

min :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR

Read PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

readsPrec :: Int -> ReadS PerformanceCounterDescriptionFlagBitsKHR

readList :: ReadS [PerformanceCounterDescriptionFlagBitsKHR]

readPrec :: ReadPrec PerformanceCounterDescriptionFlagBitsKHR

readListPrec :: ReadPrec [PerformanceCounterDescriptionFlagBitsKHR]

Show PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> PerformanceCounterDescriptionFlagBitsKHR -> ShowS

show :: PerformanceCounterDescriptionFlagBitsKHR -> String

showList :: [PerformanceCounterDescriptionFlagBitsKHR] -> ShowS

Storable PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: PerformanceCounterDescriptionFlagBitsKHR -> Int

alignment :: PerformanceCounterDescriptionFlagBitsKHR -> Int

peekElemOff :: Ptr PerformanceCounterDescriptionFlagBitsKHR -> Int -> IO PerformanceCounterDescriptionFlagBitsKHR

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

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

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

peek :: Ptr PerformanceCounterDescriptionFlagBitsKHR -> IO PerformanceCounterDescriptionFlagBitsKHR

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

Bits PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(.&.) :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR

(.|.) :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR

xor :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR

complement :: PerformanceCounterDescriptionFlagBitsKHR -> PerformanceCounterDescriptionFlagBitsKHR

shift :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

rotate :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

zeroBits :: PerformanceCounterDescriptionFlagBitsKHR

bit :: Int -> PerformanceCounterDescriptionFlagBitsKHR

setBit :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

clearBit :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

complementBit :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

testBit :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: PerformanceCounterDescriptionFlagBitsKHR -> Maybe Int

bitSize :: PerformanceCounterDescriptionFlagBitsKHR -> Int

isSigned :: PerformanceCounterDescriptionFlagBitsKHR -> Bool

shiftL :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

unsafeShiftL :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

shiftR :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

unsafeShiftR :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

rotateL :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

rotateR :: PerformanceCounterDescriptionFlagBitsKHR -> Int -> PerformanceCounterDescriptionFlagBitsKHR

popCount :: PerformanceCounterDescriptionFlagBitsKHR -> Int

FiniteBits PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

finiteBitSize :: PerformanceCounterDescriptionFlagBitsKHR -> Int

countLeadingZeros :: PerformanceCounterDescriptionFlagBitsKHR -> Int

countTrailingZeros :: PerformanceCounterDescriptionFlagBitsKHR -> Int

Zero PerformanceCounterDescriptionFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: PerformanceCounterDescriptionFlagBitsKHR

type AcquireProfilingLockFlagsKHR = AcquireProfilingLockFlagBitsKHR

newtype AcquireProfilingLockFlagBitsKHR

VkAcquireProfilingLockFlagBitsKHR - Reserved for future use

See Also

VK_KHR_performance_query, AcquireProfilingLockFlagsKHR

Constructors

AcquireProfilingLockFlagBitsKHR Flags

Instances

Eq AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(==) :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> Bool

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

Ord AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

compare :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> Ordering

(<) :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> Bool

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

(>) :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> Bool

(>=) :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> Bool

max :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR

min :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR

Read AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

readsPrec :: Int -> ReadS AcquireProfilingLockFlagBitsKHR

readList :: ReadS [AcquireProfilingLockFlagBitsKHR]

readPrec :: ReadPrec AcquireProfilingLockFlagBitsKHR

readListPrec :: ReadPrec [AcquireProfilingLockFlagBitsKHR]

Show AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

showsPrec :: Int -> AcquireProfilingLockFlagBitsKHR -> ShowS

show :: AcquireProfilingLockFlagBitsKHR -> String

showList :: [AcquireProfilingLockFlagBitsKHR] -> ShowS

Storable AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

sizeOf :: AcquireProfilingLockFlagBitsKHR -> Int

alignment :: AcquireProfilingLockFlagBitsKHR -> Int

peekElemOff :: Ptr AcquireProfilingLockFlagBitsKHR -> Int -> IO AcquireProfilingLockFlagBitsKHR

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

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

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

peek :: Ptr AcquireProfilingLockFlagBitsKHR -> IO AcquireProfilingLockFlagBitsKHR

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

Bits AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

(.&.) :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR

(.|.) :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR

xor :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR

complement :: AcquireProfilingLockFlagBitsKHR -> AcquireProfilingLockFlagBitsKHR

shift :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

rotate :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

zeroBits :: AcquireProfilingLockFlagBitsKHR

bit :: Int -> AcquireProfilingLockFlagBitsKHR

setBit :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

clearBit :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

complementBit :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

testBit :: AcquireProfilingLockFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: AcquireProfilingLockFlagBitsKHR -> Maybe Int

bitSize :: AcquireProfilingLockFlagBitsKHR -> Int

isSigned :: AcquireProfilingLockFlagBitsKHR -> Bool

shiftL :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

unsafeShiftL :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

shiftR :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

unsafeShiftR :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

rotateL :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

rotateR :: AcquireProfilingLockFlagBitsKHR -> Int -> AcquireProfilingLockFlagBitsKHR

popCount :: AcquireProfilingLockFlagBitsKHR -> Int

FiniteBits AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

finiteBitSize :: AcquireProfilingLockFlagBitsKHR -> Int

countLeadingZeros :: AcquireProfilingLockFlagBitsKHR -> Int

countTrailingZeros :: AcquireProfilingLockFlagBitsKHR -> Int

Zero AcquireProfilingLockFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_performance_query

Methods

zero :: AcquireProfilingLockFlagBitsKHR

type KHR_PERFORMANCE_QUERY_SPEC_VERSION = 1

pattern KHR_PERFORMANCE_QUERY_SPEC_VERSION :: forall a. Integral a => a

type KHR_PERFORMANCE_QUERY_EXTENSION_NAME = "VK_KHR_performance_query"

pattern KHR_PERFORMANCE_QUERY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a