LWJGL 3.3.3 · org.lwjgl.vulkan.KHRTimelineSemaphore

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.

VK_KHR_timeline_semaphore

Name String

VK_KHR_timeline_semaphore

Extension Type

Device extension

Registered Extension Number

208

Revision

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

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
Promoted to Vulkan 1.2 Core

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

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

Access	Constructor and Description
protected	KHRTimelineSemaphore()

Method Summary

Modifier and Type	Method and Description
public static int	nvkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, long pValue) Unsafe version of: `GetSemaphoreCounterValueKHR`
public static int	nvkSignalSemaphoreKHR(VkDevice device, long pSignalInfo) Unsafe version of: `SignalSemaphoreKHR`
public static int	nvkWaitSemaphoresKHR(VkDevice device, long pWaitInfo, long timeout) Unsafe version of: `WaitSemaphoresKHR`
public static int	vkGetSemaphoreCounterValueKHR(VkDevice the logical device that owns the semaphore. device, long the handle of the semaphore to query. semaphore, LongBuffer a pointer to a 64-bit integer value in which the current counter value of the semaphore is returned. pValue) See `GetSemaphoreCounterValue`.
public static int	vkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, long[] pValue) Array version of: `GetSemaphoreCounterValueKHR`
public static int	vkSignalSemaphoreKHR(VkDevice the logical device that owns the semaphore. device, VkSemaphoreSignalInfo a pointer to a `VkSemaphoreSignalInfo` structure containing information about the signal operation. pSignalInfo) See `SignalSemaphore`.
public static int	vkWaitSemaphoresKHR(VkDevice the logical device that owns the semaphores. device, VkSemaphoreWaitInfo a pointer to a `VkSemaphoreWaitInfo` structure containing information about the wait condition. pWaitInfo, long 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. timeout) See `WaitSemaphores`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

VK_KHR_TIMELINE_SEMAPHORE_EXTENSION_NAME	back to summary
public static final String VK_KHR_TIMELINE_SEMAPHORE_EXTENSION_NAME The extension name.

VK_KHR_TIMELINE_SEMAPHORE_SPEC_VERSION	back to summary
public static final int VK_KHR_TIMELINE_SEMAPHORE_SPEC_VERSION The extension specification version.

VK_SEMAPHORE_TYPE_BINARY_KHR back to summary

VK_SEMAPHORE_TYPE_BINARY_KHR	back to summary
public static final int VK_SEMAPHORE_TYPE_BINARY_KHR Extends `VkSemaphoreType`. Enum values: `SEMAPHORE_TYPE_BINARY_KHR` `SEMAPHORE_TYPE_TIMELINE_KHR`

public static final int VK_SEMAPHORE_TYPE_BINARY_KHR

Extends VkSemaphoreType.

Enum values:

VK_SEMAPHORE_TYPE_TIMELINE_KHR back to summary

VK_SEMAPHORE_TYPE_TIMELINE_KHR	back to summary
public static final int VK_SEMAPHORE_TYPE_TIMELINE_KHR Extends `VkSemaphoreType`. Enum values: `SEMAPHORE_TYPE_BINARY_KHR` `SEMAPHORE_TYPE_TIMELINE_KHR`

public static final int VK_SEMAPHORE_TYPE_TIMELINE_KHR

Extends VkSemaphoreType.

Enum values:

VK_SEMAPHORE_WAIT_ANY_BIT_KHR	back to summary
public static final int VK_SEMAPHORE_WAIT_ANY_BIT_KHR Extends `VkSemaphoreWaitFlagBits`.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR back to summary

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR	back to summary
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`

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_FEATURES_KHR

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR back to summary

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR	back to summary
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`

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR back to summary

VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO_KHR

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR back to summary

VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR back to summary

VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO_KHR

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR back to summary

VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR	back to summary
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`

public static final int VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO_KHR

Extends VkStructureType.

Enum values:

Constructor Detail

KHRTimelineSemaphore	back to summary
protected KHRTimelineSemaphore()

Method Detail

nvkGetSemaphoreCounterValueKHR	back to summary
public static int nvkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, long pValue) Unsafe version of: `GetSemaphoreCounterValueKHR`

nvkSignalSemaphoreKHR	back to summary
public static int nvkSignalSemaphoreKHR(VkDevice device, long pSignalInfo) Unsafe version of: `SignalSemaphoreKHR`

nvkWaitSemaphoresKHR	back to summary
public static int nvkWaitSemaphoresKHR(VkDevice device, long pWaitInfo, long timeout) Unsafe version of: `WaitSemaphoresKHR`

vkGetSemaphoreCounterValueKHR back to summary

vkGetSemaphoreCounterValueKHR	back to summary
public static int vkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, LongBuffer pValue) See `GetSemaphoreCounterValue`. Parameters device:VkDevice the logical device that owns the semaphore. semaphore:long the handle of the semaphore to query. pValue:LongBuffer a pointer to a 64-bit integer value in which the current counter value of the semaphore is returned. Annotations @NativeType:VkResult

public static int vkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, LongBuffer pValue)

See GetSemaphoreCounterValue.

Parameters

device:VkDevice: the logical device that owns the semaphore.
semaphore:long: the handle of the semaphore to query.
pValue:LongBuffer: a pointer to a 64-bit integer value in which the current counter value of the semaphore is returned.

Annotations

@NativeType:VkResult

vkGetSemaphoreCounterValueKHR back to summary

vkGetSemaphoreCounterValueKHR	back to summary
public static int vkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, long[] pValue) Array version of: `GetSemaphoreCounterValueKHR` Annotations @NativeType:VkResult

public static int vkGetSemaphoreCounterValueKHR(VkDevice device, long semaphore, long[] pValue)

Array version of: GetSemaphoreCounterValueKHR

Annotations

@NativeType:VkResult

vkSignalSemaphoreKHR back to summary

vkSignalSemaphoreKHR	back to summary
public static int vkSignalSemaphoreKHR(VkDevice device, VkSemaphoreSignalInfo pSignalInfo) See `SignalSemaphore`. Parameters device:VkDevice the logical device that owns the semaphore. pSignalInfo:VkSemaphoreSignalInfo a pointer to a `VkSemaphoreSignalInfo` structure containing information about the signal operation. Annotations @NativeType:VkResult

public static int vkSignalSemaphoreKHR(VkDevice device, VkSemaphoreSignalInfo pSignalInfo)

See SignalSemaphore.

Parameters

device:VkDevice: the logical device that owns the semaphore.
pSignalInfo:VkSemaphoreSignalInfo: a pointer to a VkSemaphoreSignalInfo structure containing information about the signal operation.

Annotations

@NativeType:VkResult

vkWaitSemaphoresKHR back to summary

vkWaitSemaphoresKHR	back to summary
public static int vkWaitSemaphoresKHR(VkDevice device, VkSemaphoreWaitInfo pWaitInfo, long timeout) See `WaitSemaphores`. Parameters device:VkDevice the logical device that owns the semaphores. pWaitInfo:VkSemaphoreWaitInfo a pointer to a `VkSemaphoreWaitInfo` structure containing information about the wait condition. timeout:long 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. Annotations @NativeType:VkResult

public static int vkWaitSemaphoresKHR(VkDevice device, VkSemaphoreWaitInfo pWaitInfo, long timeout)

See WaitSemaphores.

Parameters

device:VkDevice: the logical device that owns the semaphores.
pWaitInfo:VkSemaphoreWaitInfo: a pointer to a VkSemaphoreWaitInfo structure containing information about the wait condition.
timeout:long: 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.

Annotations

@NativeType:VkResult

public Class KHRTimelineSemaphore

Promotion to Vulkan 1.2

VK_KHR_timeline_semaphore

Other Extension Metadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Constructor Detail

Method Detail