vkCreateSemaphore(3)

# vkCreateSemaphore(3) Manual Page

## Name

vkCreateSemaphore - Create a new queue semaphore object

Loading… please wait.

## 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

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-parameter
  If `pAllocator` is not `NULL`, `pAllocator` must be a valid pointer to a valid VkAllocationCallbacks structure

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

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

SPDX-License-Identifier: CC-BY-4.0