VkAcquireProfilingLockInfoKHR(3)

# VkAcquireProfilingLockInfoKHR(3) Manual Page

## Name

VkAcquireProfilingLockInfoKHR - Structure specifying parameters to acquire the profiling lock

Loading… please wait.

## C Specification

The `VkAcquireProfilingLockInfoKHR` structure is defined as:

    // Provided by VK_KHR_performance_query
    typedef struct VkAcquireProfilingLockInfoKHR {
        VkStructureType                   sType;
        const void*                       pNext;
        VkAcquireProfilingLockFlagsKHR    flags;
        uint64_t                          timeout;
    } VkAcquireProfilingLockInfoKHR;

## Members

- `sType` is the type of this structure.

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

- `flags` is reserved for future use.

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

## Description

Valid Usage (Implicit)

- VUID-VkAcquireProfilingLockInfoKHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR`

- VUID-VkAcquireProfilingLockInfoKHR-pNext-pNext
  `pNext` must be `NULL`

- VUID-VkAcquireProfilingLockInfoKHR-flags-zerobitmask
  `flags` must be `0`

If `timeout` is 0, `vkAcquireProfilingLockKHR` 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, VkAcquireProfilingLockFlagsKHR, VkStructureType, vkAcquireProfilingLockKHR

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0