C Specification

To create a semaphore, call:

// Provided by VK_VERSION_1_0
VkResult vkCreateSemaphore(
    VkDevice                                    device,
    const VkSemaphoreCreateInfo*                pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkSemaphore*                                pSemaphore);

Parameters

  • device is the logical device that creates the semaphore.

  • pCreateInfo is a pointer to a VkSemaphoreCreateInfo structure containing information about how the semaphore is to be created.

  • pAllocator controls host memory allocation as described in the Memory Allocation chapter.

  • pSemaphore is a pointer to a handle in which the resulting semaphore object is returned.

Description

If VkSemaphoreSciSyncCreateInfoNV is included in the pNext chain of VkSemaphoreCreateInfo, VkSemaphoreSciSyncCreateInfoNV::semaphorePool may be accessed any time the resulting semaphore is accessed.

If VkPhysicalDeviceVulkanSC10Properties::deviceNoDynamicHostAllocations is VK_TRUE, vkCreateSemaphore must not return VK_ERROR_OUT_OF_HOST_MEMORY.

Valid Usage

  • VUID-vkCreateSemaphore-device-05068
    The number of semaphores currently allocated from device plus 1 must be less than or equal to the total number of semaphores requested via VkDeviceObjectReservationCreateInfo::semaphoreRequestCount specified when device was created

Valid Usage (Implicit)

  • VUID-vkCreateSemaphore-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkCreateSemaphore-pCreateInfo-parameter
    pCreateInfo must be a valid pointer to a valid VkSemaphoreCreateInfo structure

  • VUID-vkCreateSemaphore-pAllocator-null
    pAllocator must be NULL

  • VUID-vkCreateSemaphore-pSemaphore-parameter
    pSemaphore must be a valid pointer to a VkSemaphore handle

  • VUID-vkCreateSemaphore-device-queuecount
    The device must have been created with at least 1 queue

Return Codes
On success, this command returns

  • VK_SUCCESS

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_VERSION_1_0, VkAllocationCallbacks, VkDevice, VkSemaphore, VkSemaphoreCreateInfo

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

SPDX-License-Identifier: CC-BY-4.0