Package org.lwjgl.vulkan

Class KHRTimelineSemaphore

java.lang.Object

org.lwjgl.vulkan.KHRTimelineSemaphore

public class KHRTimelineSemaphore
extends 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.

Promotion to Vulkan 1.2

All functionality in this extension is included in core Vulkan 1.2, with the KHR suffix omitted. The original type, enum, and command names are still available as aliases of the core functionality.

Name String

VK_KHR_timeline_semaphore

Extension Type

Device extension

Registered Extension Number

208

Revision

2

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Deprecation State

• Promoted to Vulkan 1.2

Contact

• Faith Ekstrand gfxstrand

Other Extension Metadata

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
• Faith Ekstrand, Intel
• Jesse Hall, Google
• James Jones, NVIDIA
• Jeff Juliano, NVIDIA
• Daniel Rakos, AMD
• Ray Smith, Arm

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_KHR_TIMELINE_SEMAPHORE_EXTENSION_NAME	The extension name.
static final int	VK_KHR_TIMELINE_SEMAPHORE_SPEC_VERSION	The extension specification version.
static final int	VK_SEMAPHORE_TYPE_BINARY_KHR	Extends VkSemaphoreType.
static final int	VK_SEMAPHORE_TYPE_TIMELINE_KHR	Extends VkSemaphoreType.
static final int	VK_SEMAPHORE_WAIT_ANY_BIT_KHR	Extends VkSemaphoreWaitFlagBits.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	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, LongBuffer pValue)	See GetSemaphoreCounterValue.
static int	vkSignalSemaphoreKHR(org.lwjgl.vulkan.VkDevice device, VkSemaphoreSignalInfo pSignalInfo)	See SignalSemaphore.
static int	vkWaitSemaphoresKHR(org.lwjgl.vulkan.VkDevice device, VkSemaphoreWaitInfo pWaitInfo, long timeout)	See WaitSemaphores.

Methods inherited from class java.lang.Object

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

Field Details

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

Extends VkSemaphoreType.

Enum values:

• SEMAPHORE_TYPE_BINARY_KHR
• SEMAPHORE_TYPE_TIMELINE_KHR

See Also:

• Constant Field Values

VK_SEMAPHORE_TYPE_TIMELINE_KHR

public static final int VK_SEMAPHORE_TYPE_TIMELINE_KHR

Extends VkSemaphoreType.

Enum values:

• SEMAPHORE_TYPE_BINARY_KHR
• SEMAPHORE_TYPE_TIMELINE_KHR

See Also:

• Constant Field Values

VK_SEMAPHORE_WAIT_ANY_BIT_KHR

public static final int VK_SEMAPHORE_WAIT_ANY_BIT_KHR

Extends VkSemaphoreWaitFlagBits.

See Also:

• Constant Field Values

Method Details

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,
 LongBuffer pValue)

See GetSemaphoreCounterValue.

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,
 VkSemaphoreWaitInfo pWaitInfo,
 long timeout)

See WaitSemaphores.

Parameters:

device - the logical device that owns the semaphores.

pWaitInfo - a pointer to a VkSemaphoreWaitInfo 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,
 VkSemaphoreSignalInfo pSignalInfo)

See SignalSemaphore.

Parameters:

device - the logical device that owns the semaphore.

pSignalInfo - a pointer to a VkSemaphoreSignalInfo 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