VkSemaphoreType(3)

# VkSemaphoreType(3) Manual Page

## Name

VkSemaphoreType - Specifies the type of a semaphore object

Loading… please wait.

## C Specification

Possible values of VkSemaphoreTypeCreateInfo::`semaphoreType`, specifying the type of a semaphore, are:

    // Provided by VK_VERSION_1_2
    typedef enum VkSemaphoreType {
        VK_SEMAPHORE_TYPE_BINARY = 0,
        VK_SEMAPHORE_TYPE_TIMELINE = 1,
      // Provided by VK_KHR_timeline_semaphore
        VK_SEMAPHORE_TYPE_BINARY_KHR = VK_SEMAPHORE_TYPE_BINARY,
      // Provided by VK_KHR_timeline_semaphore
        VK_SEMAPHORE_TYPE_TIMELINE_KHR = VK_SEMAPHORE_TYPE_TIMELINE,
    } VkSemaphoreType;

or the equivalent

    // Provided by VK_KHR_timeline_semaphore
    typedef VkSemaphoreType VkSemaphoreTypeKHR;

## Description

- `VK_SEMAPHORE_TYPE_BINARY` specifies a binary semaphore type that has a boolean payload indicating whether the semaphore is currently signaled or unsignaled. When created, the semaphore is in the unsignaled state.

- `VK_SEMAPHORE_TYPE_TIMELINE` specifies a timeline semaphore type that has a strictly increasing 64-bit unsigned integer payload indicating whether the semaphore is signaled with respect to a particular reference value. When created, the semaphore payload has the value given by the `initialValue` field of VkSemaphoreTypeCreateInfo.

## See Also

VK_KHR_timeline_semaphore, VK_VERSION_1_2, VkSemaphoreTypeCreateInfo

## 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-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0