VkSemaphoreWaitInfoKHR(3)

# VkSemaphoreWaitInfoKHR(3) Manual Page

## Name

VkSemaphoreWaitInfoKHR - Structure containing information about the semaphore wait condition

## C Specification

The `VkSemaphoreWaitInfoKHR` structure is defined as:

    typedef struct VkSemaphoreWaitInfoKHR {
        VkStructureType            sType;
        const void*                pNext;
        VkSemaphoreWaitFlagsKHR    flags;
        uint32_t                   semaphoreCount;
        const VkSemaphore*         pSemaphores;
        const uint64_t*            pValues;
    } VkSemaphoreWaitInfoKHR;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to an extension-specific structure.

- `flags` is a bitmask of VkSemaphoreWaitFlagBitsKHR specifying additional parameters for the semaphore wait operation.

- `semaphoreCount` is the number of semaphores to wait on.

- `pSemaphores` is a pointer to an array of `semaphoreCount` semaphore handles to wait on.

- `pValues` is a pointer to an array of `semaphoreCount` timeline semaphore values.

## Description

Valid Usage

- All of the elements of `pSemaphores` must reference a semaphore that was created with a VkSemaphoreTypeKHR of `VK_SEMAPHORE_TYPE_TIMELINE_KHR`

Valid Usage (Implicit)

- `sType` must be `VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR`

- `pNext` must be `NULL`

- `flags` must be a valid combination of VkSemaphoreWaitFlagBitsKHR values

- `pSemaphores` must be a valid pointer to an array of `semaphoreCount` valid VkSemaphore handles

- `pValues` must be a valid pointer to an array of `semaphoreCount` `uint64_t` values

- `semaphoreCount` must be greater than `0`

## See Also

VkSemaphore, VkSemaphoreWaitFlagsKHR, VkStructureType, vkWaitSemaphoresKHR

## 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 (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.