VkSemaphoreWaitInfo(3)

# VkSemaphoreWaitInfo(3) Manual Page

## Name

VkSemaphoreWaitInfo - Structure containing information about the semaphore wait condition

Loading… please wait.

## C Specification

The `VkSemaphoreWaitInfo` structure is defined as:

    // Provided by VK_VERSION_1_2
    typedef struct VkSemaphoreWaitInfo {
        VkStructureType         sType;
        const void*             pNext;
        VkSemaphoreWaitFlags    flags;
        uint32_t                semaphoreCount;
        const VkSemaphore*      pSemaphores;
        const uint64_t*         pValues;
    } VkSemaphoreWaitInfo;

or the equivalent

    // Provided by VK_KHR_timeline_semaphore
    typedef VkSemaphoreWaitInfo VkSemaphoreWaitInfoKHR;

## Members

- `sType` is the type of this structure.

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

- `flags` is a bitmask of VkSemaphoreWaitFlagBits 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

- VUID-VkSemaphoreWaitInfo-pSemaphores-03256
  All of the elements of `pSemaphores` must reference a semaphore that was created with a VkSemaphoreType of `VK_SEMAPHORE_TYPE_TIMELINE`

Valid Usage (Implicit)

- VUID-VkSemaphoreWaitInfo-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO`

- VUID-VkSemaphoreWaitInfo-pNext-pNext
  `pNext` must be `NULL`

- VUID-VkSemaphoreWaitInfo-flags-parameter
  `flags` must be a valid combination of VkSemaphoreWaitFlagBits values

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

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

- VUID-VkSemaphoreWaitInfo-semaphoreCount-arraylength
  `semaphoreCount` must be greater than `0`

## See Also

VK_KHR_timeline_semaphore, VK_VERSION_1_2, VkSemaphore, VkSemaphoreWaitFlags, VkStructureType, vkWaitSemaphores, 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 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0