org.lwjgl.vulkan

Class KHRTimelineSemaphore

java.lang.Object

org.lwjgl.vulkan.KHRTimelineSemaphore

public class KHRTimelineSemaphore
extends java.lang.Object

This extension introduces a new type of semaphore that has an integer payload identifying a point in a timeline. Such timeline semaphores support the following operations:

• Host query - A host operation that allows querying the payload of the timeline semaphore.
• Host wait - A host operation that allows a blocking wait for a timeline semaphore to reach a specified value.
• Host signal - A host operation that allows advancing the timeline semaphore to a specified value.
• Device wait - A device operation that allows waiting for a timeline semaphore to reach a specified value.
• Device signal - A device operation that allows advancing the timeline semaphore to a specified value.

Name String

VK_KHR_timeline_semaphore

Extension Type

Device extension

Registered Extension Number

208

Revision

2

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Contact

• Jason Ekstrand jekstrand

Last Modified Date

2019-06-12

IP Status

No known IP claims.

Interactions and External Dependencies

• This extension interacts with VK_KHR_external_semaphore_capabilities
• This extension interacts with VK_KHR_external_semaphore
• This extension interacts with VK_KHR_external_semaphore_win32

Contributors

• Jeff Bolz, NVIDIA
• Yuriy O’Donnell, Epic Games
• Jason Ekstrand, Intel
• Jesse Hall, Google
• James Jones, NVIDIA
• Jeff Juliano, NVIDIA
• Daniel Rakos, AMD
• Ray Smith, Arm

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VK_KHR_TIMELINE_SEMAPHORE_EXTENSION_NAME The extension name.
static int	VK_KHR_TIMELINE_SEMAPHORE_SPEC_VERSION The extension specification version.
static int	VK_SEMAPHORE_TYPE_BINARY_KHR VkSemaphoreTypeKHR - Sepcifies the type of a semaphore object
static int	VK_SEMAPHORE_TYPE_TIMELINE_KHR VkSemaphoreTypeKHR - Sepcifies the type of a semaphore object
static int	VK_SEMAPHORE_WAIT_ANY_BIT_KHR VkSemaphoreWaitFlagBitsKHR - Bitmask specifying additional parameters of a semaphore wait operation
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR Extends VkStructureType.

Method Summary

Modifier and Type	Method and Description
static int	nvkGetSemaphoreCounterValueKHR(org.lwjgl.vulkan.VkDevice device, long semaphore, long pValue) Unsafe version of: GetSemaphoreCounterValueKHR
static int	nvkSignalSemaphoreKHR(org.lwjgl.vulkan.VkDevice device, long pSignalInfo) Unsafe version of: SignalSemaphoreKHR
static int	nvkWaitSemaphoresKHR(org.lwjgl.vulkan.VkDevice device, long pWaitInfo, long timeout) Unsafe version of: WaitSemaphoresKHR
static int	vkGetSemaphoreCounterValueKHR(org.lwjgl.vulkan.VkDevice device, long semaphore, long[] pValue) Array version of: GetSemaphoreCounterValueKHR
static int	vkGetSemaphoreCounterValueKHR(org.lwjgl.vulkan.VkDevice device, long semaphore, java.nio.LongBuffer pValue) Query the current state of a timeline semaphore.
static int	vkSignalSemaphoreKHR(org.lwjgl.vulkan.VkDevice device, VkSemaphoreSignalInfoKHR pSignalInfo) Signal a timeline semaphore on the host.
static int	vkWaitSemaphoresKHR(org.lwjgl.vulkan.VkDevice device, VkSemaphoreWaitInfoKHR pWaitInfo, long timeout) Wait for timeline semaphores on the host.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_KHR_TIMELINE_SEMAPHORE_SPEC_VERSION

public static final int VK_KHR_TIMELINE_SEMAPHORE_SPEC_VERSION

The extension specification version.

See Also:

Constant Field Values

VK_KHR_TIMELINE_SEMAPHORE_EXTENSION_NAME

public static final java.lang.String VK_KHR_TIMELINE_SEMAPHORE_EXTENSION_NAME

The extension name.

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR
• STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR
• STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR
• STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR
• STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR
• STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR
• STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR

public static final int VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR
• STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR
• STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR
• STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR
• STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR
• STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR
• STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

See Also:

Constant Field Values

VK_SEMAPHORE_TYPE_BINARY_KHR

public static final int VK_SEMAPHORE_TYPE_BINARY_KHR

VkSemaphoreTypeKHR - Sepcifies the type of a semaphore object

Description

• SEMAPHORE_TYPE_BINARY_KHR 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.
• SEMAPHORE_TYPE_TIMELINE_KHR specifies a timeline semaphore type that has a monotonically 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 VkSemaphoreTypeCreateInfoKHR.

See Also

VkSemaphoreTypeCreateInfoKHR

See Also:

Constant Field Values

VK_SEMAPHORE_TYPE_TIMELINE_KHR

public static final int VK_SEMAPHORE_TYPE_TIMELINE_KHR

VkSemaphoreTypeKHR - Sepcifies the type of a semaphore object

Description

• SEMAPHORE_TYPE_BINARY_KHR 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.
• SEMAPHORE_TYPE_TIMELINE_KHR specifies a timeline semaphore type that has a monotonically 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 VkSemaphoreTypeCreateInfoKHR.

See Also

VkSemaphoreTypeCreateInfoKHR

See Also:

Constant Field Values

VK_SEMAPHORE_WAIT_ANY_BIT_KHR

public static final int VK_SEMAPHORE_WAIT_ANY_BIT_KHR

VkSemaphoreWaitFlagBitsKHR - Bitmask specifying additional parameters of a semaphore wait operation

Description

• SEMAPHORE_WAIT_ANY_BIT_KHR specifies that the semaphore wait condition is that at least one of the semaphores in VkSemaphoreWaitInfoKHR::pSemaphores has reached the value specified by the corresponding element of VkSemaphoreWaitInfoKHR::pValues. If SEMAPHORE_WAIT_ANY_BIT_KHR is not set, the semaphore wait condition is that all of the semaphores in VkSemaphoreWaitInfoKHR::pSemaphores have reached the value specified by the corresponding element of VkSemaphoreWaitInfoKHR::pValues.

See Also

VkSemaphoreWaitFlagsKHR

See Also:

Constant Field Values

Method Detail

nvkGetSemaphoreCounterValueKHR

public static int nvkGetSemaphoreCounterValueKHR(org.lwjgl.vulkan.VkDevice device,
                                                 long semaphore,
                                                 long pValue)

Unsafe version of: GetSemaphoreCounterValueKHR

vkGetSemaphoreCounterValueKHR

public static int vkGetSemaphoreCounterValueKHR(org.lwjgl.vulkan.VkDevice device,
                                                long semaphore,
                                                java.nio.LongBuffer pValue)

Query the current state of a timeline semaphore.

C Specification

To query the current counter value of a semaphore created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR from the host, call:

 VkResult vkGetSemaphoreCounterValueKHR(
     VkDevice                                    device,
     VkSemaphore                                 semaphore,
     uint64_t*                                   pValue);

Description

Note

If a queue submission command is pending execution, then the value returned by this command may immediately be out of date.

Valid Usage

• semaphore must have been created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• semaphore must be a valid VkSemaphore handle
• pValue must be a valid pointer to a uint64_t value
• semaphore must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

Parameters:

device - the logical device that owns the semaphore.

semaphore - the handle of the semaphore to query.

pValue - a pointer to a 64-bit integer value in which the current counter value of the semaphore is returned.

nvkWaitSemaphoresKHR

public static int nvkWaitSemaphoresKHR(org.lwjgl.vulkan.VkDevice device,
                                       long pWaitInfo,
                                       long timeout)

Unsafe version of: WaitSemaphoresKHR

vkWaitSemaphoresKHR

public static int vkWaitSemaphoresKHR(org.lwjgl.vulkan.VkDevice device,
                                      VkSemaphoreWaitInfoKHR pWaitInfo,
                                      long timeout)

Wait for timeline semaphores on the host.

C Specification

To wait for a set of semaphores created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR to reach particular counter values on the host, call:

 VkResult vkWaitSemaphoresKHR(
     VkDevice                                    device,
     const VkSemaphoreWaitInfoKHR*               pWaitInfo,
     uint64_t                                    timeout);

Description

If the condition is satisfied when vkWaitSemaphoresKHR is called, then vkWaitSemaphoresKHR returns immediately. If the condition is not satisfied at the time vkWaitSemaphoresKHR is called, then vkWaitSemaphoresKHR will block and wait up to timeout nanoseconds for the condition to become satisfied.

If timeout is zero, then vkWaitSemaphoresKHR does not wait, but simply returns information about the current state of the semaphore. TIMEOUT will be returned in this case if the condition is not satisfied, even though no actual wait was performed.

If the specified timeout period expires before the condition is satisfied, vkWaitSemaphoresKHR returns TIMEOUT. If the condition is satisfied before timeout nanoseconds has expired, vkWaitSemaphoresKHR returns SUCCESS.

If device loss occurs (see Lost Device) before the timeout has expired, vkWaitSemaphoresKHR must return in finite time with either SUCCESS or ERROR_DEVICE_LOST.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pWaitInfo must be a valid pointer to a valid VkSemaphoreWaitInfoKHR structure

Return Codes

On success, this command returns

• SUCCESS
• TIMEOUT

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

See Also

VkSemaphoreWaitInfoKHR

Parameters:

device - the logical device that owns the semaphore.

pWaitInfo - a pointer to a VkSemaphoreWaitInfoKHR structure containing information about the wait condition.

timeout - the timeout period in units of nanoseconds. timeout is adjusted to the closest value allowed by the implementation-dependent timeout accuracy, which may be substantially longer than one nanosecond, and may be longer than the requested period.

nvkSignalSemaphoreKHR

public static int nvkSignalSemaphoreKHR(org.lwjgl.vulkan.VkDevice device,
                                        long pSignalInfo)

Unsafe version of: SignalSemaphoreKHR

vkSignalSemaphoreKHR

public static int vkSignalSemaphoreKHR(org.lwjgl.vulkan.VkDevice device,
                                       VkSemaphoreSignalInfoKHR pSignalInfo)

Signal a timeline semaphore on the host.

C Specification

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

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

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

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkSemaphoreSignalInfoKHR

Parameters:

device - the logical device that owns the semaphore.

pSignalInfo - a pointer to a VkSemaphoreSignalInfoKHR structure containing information about the signal operation.

vkGetSemaphoreCounterValueKHR

public static int vkGetSemaphoreCounterValueKHR(org.lwjgl.vulkan.VkDevice device,
                                                long semaphore,
                                                long[] pValue)

Array version of: GetSemaphoreCounterValueKHR