C Specification

To signal a semaphore created with a VkSemaphoreTypeKHR of VK_SEMAPHORE_TYPE_TIMELINE_KHR with a particular counter value, on the host, call:

VkResult vkSignalSemaphoreKHR(
    VkDevice                                    device,
    const VkSemaphoreSignalInfoKHR*             pSignalInfo);

Parameters

  • device is the logical device that owns the semaphore.

  • pSignalInfo is a pointer to an instance of the VkSemaphoreSignalInfoKHR structure containing information about the signal operation.

Description

When vkSignalSemaphoreKHR is executed on the host, it defines and immediately executes a semaphore signal operation which sets the timeline semaphore to the given value.

The first synchronization scope is defined by the host execution model, but includes execution of vkSignalSemaphoreKHR on the host and anything that happened-before it.

The second synchronization scope is empty.

Valid Usage (Implicit)
  • device must be a valid VkDevice handle

  • pSignalInfo must be a valid pointer to a valid VkSemaphoreSignalInfoKHR structure

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

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