Package org.lwjgl.vulkan

Class NVLowLatency2

java.lang.Object

org.lwjgl.vulkan.NVLowLatency2

public class NVLowLatency2
extends Object

• GetLatencyTimingsNV
• LatencySleepNV
• QueueNotifyOutOfBandNV
• SetLatencyMarkerNV
• SetLatencySleepModeNV

Description

This extension gives applications timing suggestions on when to start the recording of new frames to reduce the latency between input sampling and frame presentation. Applications can accomplish this through the extension by calling SetLatencySleepModeNV to allow the driver to pace a given swapchain, then calling LatencySleepNV before input sampling to delay the start of the CPU side work. Additional methods and structures are provided to give insight into the latency pipeline of an application through the latency markers. VK_NV_low_latency provides legacy support for applications that make use of the NVIDIA Reflex SDK whereas new implementations should use the VK_NV_low_latency2 extension.

Name String

VK_NV_low_latency2

Extension Type

Device extension

Registered Extension Number

506

Revision

2

Extension and Version Dependencies

Version 1.2 or VK_KHR_timeline_semaphore

Contact

• Charles Hansen cshansen

Other Extension Metadata

Last Modified Date

2023-09-25

Contributors

• Charles Hansen, NVIDIA
• Liam Middlebrook, NVIDIA
• Lionel Duc, NVIDIA
• James Jones, NVIDIA
• Eric Sullivan, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_LATENCY_MARKER_INPUT_SAMPLE_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_PRESENT_END_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_PRESENT_START_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_RENDERSUBMIT_END_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_RENDERSUBMIT_START_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_SIMULATION_END_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_SIMULATION_START_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final int	VK_LATENCY_MARKER_TRIGGER_FLASH_NV	VkLatencyMarkerNV - Structure used to mark different points in latency
static final String	VK_NV_LOW_LATENCY_2_EXTENSION_NAME	The extension name.
static final int	VK_NV_LOW_LATENCY_2_SPEC_VERSION	The extension specification version.
static final int	VK_OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV	VkOutOfBandQueueTypeNV - Type of out of band queue
static final int	VK_OUT_OF_BAND_QUEUE_TYPE_RENDER_NV	VkOutOfBandQueueTypeNV - Type of out of band queue
static final int	VK_STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkGetLatencyTimingsNV(org.lwjgl.vulkan.VkDevice device, long swapchain, long pLatencyMarkerInfo)	Unsafe version of: GetLatencyTimingsNV
static int	nvkLatencySleepNV(org.lwjgl.vulkan.VkDevice device, long swapchain, long pSleepInfo)	Unsafe version of: LatencySleepNV
static void	nvkQueueNotifyOutOfBandNV(org.lwjgl.vulkan.VkQueue queue, long pQueueTypeInfo)	Unsafe version of: QueueNotifyOutOfBandNV
static void	nvkSetLatencyMarkerNV(org.lwjgl.vulkan.VkDevice device, long swapchain, long pLatencyMarkerInfo)	Unsafe version of: SetLatencyMarkerNV
static int	nvkSetLatencySleepModeNV(org.lwjgl.vulkan.VkDevice device, long swapchain, long pSleepModeInfo)	Unsafe version of: SetLatencySleepModeNV
static void	vkGetLatencyTimingsNV(org.lwjgl.vulkan.VkDevice device, long swapchain, VkGetLatencyMarkerInfoNV pLatencyMarkerInfo)	Get latency marker results.
static int	vkLatencySleepNV(org.lwjgl.vulkan.VkDevice device, long swapchain, VkLatencySleepInfoNV pSleepInfo)	Trigger low latency mode Sleep.
static void	vkQueueNotifyOutOfBandNV(org.lwjgl.vulkan.VkQueue queue, VkOutOfBandQueueTypeInfoNV pQueueTypeInfo)	Notify out of band queue.
static void	vkSetLatencyMarkerNV(org.lwjgl.vulkan.VkDevice device, long swapchain, VkSetLatencyMarkerInfoNV pLatencyMarkerInfo)	Pass in marker for timing info.
static int	vkSetLatencySleepModeNV(org.lwjgl.vulkan.VkDevice device, long swapchain, VkLatencySleepModeInfoNV pSleepModeInfo)	Enable or Disable low latency mode on a swapchain.

Methods inherited from class java.lang.Object

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

Field Details

VK_NV_LOW_LATENCY_2_SPEC_VERSION

public static final int VK_NV_LOW_LATENCY_2_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_NV_LOW_LATENCY_2_EXTENSION_NAME

public static final String VK_NV_LOW_LATENCY_2_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV

public static final int VK_STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV

public static final int VK_STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV

public static final int VK_STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV

public static final int VK_STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV

public static final int VK_STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV

public static final int VK_STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV

public static final int VK_STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

public static final int VK_STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV
• STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV
• STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV
• STRUCTURE_TYPE_OUT_OF_BAND_QUEUE_TYPE_INFO_NV
• STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV
• STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_SIMULATION_START_NV

public static final int VK_LATENCY_MARKER_SIMULATION_START_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_SIMULATION_END_NV

public static final int VK_LATENCY_MARKER_SIMULATION_END_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_RENDERSUBMIT_START_NV

public static final int VK_LATENCY_MARKER_RENDERSUBMIT_START_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_RENDERSUBMIT_END_NV

public static final int VK_LATENCY_MARKER_RENDERSUBMIT_END_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_PRESENT_START_NV

public static final int VK_LATENCY_MARKER_PRESENT_START_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_PRESENT_END_NV

public static final int VK_LATENCY_MARKER_PRESENT_END_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_INPUT_SAMPLE_NV

public static final int VK_LATENCY_MARKER_INPUT_SAMPLE_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_TRIGGER_FLASH_NV

public static final int VK_LATENCY_MARKER_TRIGGER_FLASH_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV

public static final int VK_LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV

public static final int VK_LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV

public static final int VK_LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

public static final int VK_LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the VkLatencyMarkerNV are used as arguments for SetLatencyMarkerNV in the use cases described below:

• LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to vkLatencySleepNV.
• LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.
• LATENCY_MARKER_RENDERSUBMIT_START_NV should be called at the beginning of the render submission execution each frame. This should be wherever Vulkan API calls are made and must not span into asynchronous rendering.
• LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.
• LATENCY_MARKER_PRESENT_START_NV should be called just before vkQueuePresentKHR.
• LATENCY_MARKER_PRESENT_END_NV should be called when vkQueuePresentKHR returns.
• LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.
• LATENCY_MARKER_TRIGGER_FLASH_NV should be called anywhere between LATENCY_MARKER_SIMULATION_START_NV and LATENCY_MARKER_SIMULATION_END_NV whenever a left mouse click occurs.

See Also

VkSetLatencyMarkerInfoNV

Enum values:

• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV
• LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV

See Also:

• Constant Field Values

VK_OUT_OF_BAND_QUEUE_TYPE_RENDER_NV

public static final int VK_OUT_OF_BAND_QUEUE_TYPE_RENDER_NV

VkOutOfBandQueueTypeNV - Type of out of band queue

Description

The members of the VkOutOfBandQueueTypeNV are used to describe the queue type in VkOutOfBandQueueTypeInfoNV as described below:

• OUT_OF_BAND_QUEUE_TYPE_RENDER_NV specifies that work will be submitted to this queue.
• OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV specifies that this queue will be presented from.

See Also

VkOutOfBandQueueTypeInfoNV

See Also:

• Constant Field Values

VK_OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV

public static final int VK_OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV

VkOutOfBandQueueTypeNV - Type of out of band queue

Description

The members of the VkOutOfBandQueueTypeNV are used to describe the queue type in VkOutOfBandQueueTypeInfoNV as described below:

• OUT_OF_BAND_QUEUE_TYPE_RENDER_NV specifies that work will be submitted to this queue.
• OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV specifies that this queue will be presented from.

See Also

VkOutOfBandQueueTypeInfoNV

See Also:

• Constant Field Values

Method Details

nvkSetLatencySleepModeNV

public static int nvkSetLatencySleepModeNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 long pSleepModeInfo)

Unsafe version of: SetLatencySleepModeNV

vkSetLatencySleepModeNV

public static int vkSetLatencySleepModeNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 VkLatencySleepModeInfoNV pSleepModeInfo)

Enable or Disable low latency mode on a swapchain.

C Specification

To enable or disable low latency mode on a swapchain, call:

 VkResult vkSetLatencySleepModeNV(
     VkDevice                                    device,
     VkSwapchainKHR                              swapchain,
     const VkLatencySleepModeInfoNV*             pSleepModeInfo);

Description

If pSleepModeInfo is NULL, vkSetLatencySleepModeNV will disable low latency mode, low latency boost, and set the minimum present interval previously specified by VkLatencySleepModeInfoNV to zero on swapchain. As an exception to the normal rules for objects which are externally synchronized, the swapchain passed to vkSetLatencySleepModeNV may be simultaneously used by other threads in calls to functions other than DestroySwapchainKHR. Access to the swapchain data associated with this extension must be atomic within the implementation.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• pSleepModeInfo must be a valid pointer to a valid VkLatencySleepModeInfoNV structure
• swapchain must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED

See Also

VkLatencySleepModeInfoNV

Parameters:

device - the device associated with swapchain.

swapchain - the swapchain to enable or disable low latency mode on.

pSleepModeInfo - NULL or a pointer to a VkLatencySleepModeInfoNV structure specifying the parameters of the latency sleep mode.

nvkLatencySleepNV

public static int nvkLatencySleepNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 long pSleepInfo)

Unsafe version of: LatencySleepNV

vkLatencySleepNV

public static int vkLatencySleepNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 VkLatencySleepInfoNV pSleepInfo)

Trigger low latency mode Sleep.

C Specification

To provide the synchronization primitive used to delay host CPU work for lower latency rendering, call:

 VkResult vkLatencySleepNV(
     VkDevice                                    device,
     VkSwapchainKHR                              swapchain,
     const VkLatencySleepInfoNV*                 pSleepInfo);

Description

vkLatencySleepNV returns immediately. Applications should use WaitSemaphores with pSleepInfo→signalSemaphore to delay host CPU work. CPU work refers to application work done before presenting which includes but is not limited to: input sampling, simulation, command buffer recording, command buffer submission, and present submission. Applications should call this function before input sampling, and exactly once between presents.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• pSleepInfo must be a valid pointer to a valid VkLatencySleepInfoNV structure
• swapchain must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

See Also

VkLatencySleepInfoNV

Parameters:

device - the device associated with swapchain.

swapchain - the swapchain to delay associated CPU work based on VkLatencySubmissionPresentIdNV submissions.

pSleepInfo - a pointer to a VkLatencySleepInfoNV structure specifying the parameters of the latency sleep.

nvkSetLatencyMarkerNV

public static void nvkSetLatencyMarkerNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 long pLatencyMarkerInfo)

Unsafe version of: SetLatencyMarkerNV

vkSetLatencyMarkerNV

public static void vkSetLatencyMarkerNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 VkSetLatencyMarkerInfoNV pLatencyMarkerInfo)

Pass in marker for timing info.

C Specification

An application can provide timestamps at various stages of its frame generation work by calling:

 void vkSetLatencyMarkerNV(
     VkDevice                                    device,
     VkSwapchainKHR                              swapchain,
     const VkSetLatencyMarkerInfoNV*             pLatencyMarkerInfo);

Description

At the beginning and end of simulation and render threads and beginning and end of QueuePresentKHR calls, vkSetLatencyMarkerNV can be called to provide timestamps for the application’s reference. These timestamps are returned with a call to GetLatencyTimingsNV alongside driver provided timestamps at various points of interest with regards to latency within the application. As an exception to the normal rules for objects which are externally synchronized, the swapchain passed to vkSetLatencyMarkerNV may be simultaneously used by other threads in calls to functions other than DestroySwapchainKHR. Access to the swapchain data associated with this extension must be atomic within the implementation.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• pLatencyMarkerInfo must be a valid pointer to a valid VkSetLatencyMarkerInfoNV structure
• swapchain must have been created, allocated, or retrieved from device

See Also

VkSetLatencyMarkerInfoNV

Parameters:

device - the device associated with swapchain.

swapchain - the swapchain to capture timestamps on.

nvkGetLatencyTimingsNV

public static void nvkGetLatencyTimingsNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 long pLatencyMarkerInfo)

Unsafe version of: GetLatencyTimingsNV

vkGetLatencyTimingsNV

public static void vkGetLatencyTimingsNV(org.lwjgl.vulkan.VkDevice device,
 long swapchain,
 VkGetLatencyMarkerInfoNV pLatencyMarkerInfo)

Get latency marker results.

C Specification

To get an array containing the newest collected latency data, call:

 void vkGetLatencyTimingsNV(
     VkDevice                                    device,
     VkSwapchainKHR                              swapchain,
     VkGetLatencyMarkerInfoNV*                   pLatencyMarkerInfo);

Description

The timings returned by vkGetLatencyTimingsNV contain the timestamps requested from SetLatencyMarkerNV and additional implementation-specific markers defined in VkLatencyTimingsFrameReportNV.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• pLatencyMarkerInfo must be a valid pointer to a VkGetLatencyMarkerInfoNV structure
• swapchain must have been created, allocated, or retrieved from device

See Also

VkGetLatencyMarkerInfoNV

Parameters:

device - the device associated with swapchain.

swapchain - the swapchain to return data from.

nvkQueueNotifyOutOfBandNV

public static void nvkQueueNotifyOutOfBandNV(org.lwjgl.vulkan.VkQueue queue,
 long pQueueTypeInfo)

Unsafe version of: QueueNotifyOutOfBandNV

vkQueueNotifyOutOfBandNV

public static void vkQueueNotifyOutOfBandNV(org.lwjgl.vulkan.VkQueue queue,
 VkOutOfBandQueueTypeInfoNV pQueueTypeInfo)

Notify out of band queue.

C Specification

To mark a queue as out of band, so that all vkQueueSubmit calls on the queue are ignored for latency evaluation, call:

 void vkQueueNotifyOutOfBandNV(
     VkQueue                                     queue,
     const VkOutOfBandQueueTypeInfoNV*           pQueueTypeInfo);

Valid Usage (Implicit)

• queue must be a valid VkQueue handle
• pQueueTypeInfo must be a valid pointer to a valid VkOutOfBandQueueTypeInfoNV structure

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
-	-	-	Any	-

See Also

VkOutOfBandQueueTypeInfoNV

Parameters:

queue - the VkQueue to be marked as out of band.

pQueueTypeInfo - a pointer to a VkOutOfBandQueueTypeInfoNV structure specifying the queue type.