Vulkan.Extensions.VK_NV_low_latency2

Name

VK_NV_low_latency2 - device extension

VK_NV_low_latency2

Name String

VK_NV_low_latency2

Extension Type

Device extension

Registered Extension Number

506

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies; Contact

• Charles Hansen @cshansen%0A*Here describe the issue or question you have about the VK_NV_low_latency2 extension*

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

New Commands

• getLatencyTimingsNV

• latencySleepNV
• queueNotifyOutOfBandNV
• setLatencyMarkerNV
• setLatencySleepModeNV

New Structures

• GetLatencyMarkerInfoNV

• LatencySleepInfoNV
• LatencySleepModeInfoNV
• LatencyTimingsFrameReportNV
• OutOfBandQueueTypeInfoNV
• SetLatencyMarkerInfoNV

• Extending SubmitInfo, SubmitInfo2:

  • LatencySubmissionPresentIdNV

• Extending SurfaceCapabilities2KHR:

  • LatencySurfaceCapabilitiesNV

• Extending SwapchainCreateInfoKHR:

  • SwapchainLatencyCreateInfoNV

New Enums

• LatencyMarkerNV

• OutOfBandQueueTypeNV

New Enum Constants

• NV_LOW_LATENCY_2_EXTENSION_NAME

• NV_LOW_LATENCY_2_SPEC_VERSION

• Extending StructureType:

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

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.

Issues

1) How does Low Latency 2 work with applications that utilize device groups?

Low Latency 2 does not support device groups.

Version History

• Revision 1, 2023-09-25 (Charles Hansen)

  • Internal revisions

See Also

GetLatencyMarkerInfoNV, LatencyMarkerNV, LatencySleepInfoNV, LatencySleepModeInfoNV, LatencySubmissionPresentIdNV, LatencySurfaceCapabilitiesNV, LatencyTimingsFrameReportNV, OutOfBandQueueTypeInfoNV, OutOfBandQueueTypeNV, SetLatencyMarkerInfoNV, SwapchainLatencyCreateInfoNV, getLatencyTimingsNV, latencySleepNV, queueNotifyOutOfBandNV, setLatencyMarkerNV, setLatencySleepModeNV

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

setLatencySleepModeNV

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

device must be a valid Device handle

-> SwapchainKHR

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

swapchain must be a valid SwapchainKHR handle

swapchain must have been created, allocated, or retrieved from device

-> LatencySleepModeInfoNV

pSleepModeInfo is NULL or a pointer to a LatencySleepModeInfoNV structure specifying the parameters of the latency sleep mode.

pSleepModeInfo must be a valid pointer to a valid LatencySleepModeInfoNV structure

-> io ()

vkSetLatencySleepModeNV - Enable or Disable low latency mode on a swapchain

Description

If pSleepModeInfo is NULL, setLatencySleepModeNV will disable low latency mode, low latency boost, and set the minimum present interval previously specified by LatencySleepModeInfoNV to zero on swapchain.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED

See Also

VK_NV_low_latency2, Device, LatencySleepModeInfoNV, SwapchainKHR

latencySleepNV

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

device must be a valid Device handle

-> SwapchainKHR

swapchain is the swapchain to delay associated CPU work based on LatencySubmissionPresentIdNV submissions.

swapchain must be a valid SwapchainKHR handle

swapchain must have been created, allocated, or retrieved from device

-> LatencySleepInfoNV

pSleepInfo is a pointer to a LatencySleepInfoNV structure specifying the parameters of the latency sleep.

pSleepInfo must be a valid pointer to a valid LatencySleepInfoNV structure

-> io ()

vkLatencySleepNV - Trigger low latency mode Sleep

Description

latencySleepNV 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. It is recommended to call this function before input sampling. When using this function, it should be called exactly once between presents.

Return Codes

Success

• SUCCESS

Failure

• ERROR_UNKNOWN

See Also

VK_NV_low_latency2, Device, LatencySleepInfoNV, SwapchainKHR

setLatencyMarkerNV

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

device must be a valid Device handle

-> SwapchainKHR

swapchain is the swapchain to capture timestamps on.

swapchain must be a valid SwapchainKHR handle

swapchain must have been created, allocated, or retrieved from device

-> SetLatencyMarkerInfoNV

pLatencyMarkerInfo must be a valid pointer to a valid SetLatencyMarkerInfoNV structure

-> io ()

vkSetLatencyMarkerNV - Pass in marker for timing info

Description

At the beginning and end of simulation and render threads and beginning and end of queuePresentKHR calls, setLatencyMarkerNV 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.

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, Device, SetLatencyMarkerInfoNV, SwapchainKHR

getLatencyTimingsNV

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

device must be a valid Device handle

-> SwapchainKHR

swapchain is the swapchain to return data from.

swapchain must be a valid SwapchainKHR handle

swapchain must have been created, allocated, or retrieved from device

-> io ("timingCount" ::: Word32, GetLatencyMarkerInfoNV)

vkGetLatencyTimingsNV - Get latency marker results

Description

The timings returned by getLatencyTimingsNV contain the timestamps requested from setLatencyMarkerNV and additional implementation-specific markers defined in LatencyTimingsFrameReportNV. If pTimings is NULL, then the maximum number of queryable frame data is returned in pTimingCount. Otherwise, pTimingCount must point to a variable set by the user to the number of elements in the pTimings array in pGetLatencyMarkerInfo, and on return the variable is overwritten with the number of values actually written to pTimings.

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, Device, GetLatencyMarkerInfoNV, SwapchainKHR

queueNotifyOutOfBandNV

Arguments

:: forall io. MonadIO io

=> Queue

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

queue must be a valid Queue handle

-> OutOfBandQueueTypeInfoNV

pQueueTypeInfo is a pointer to a OutOfBandQueueTypeInfoNV structure specifying the queue type.

pQueueTypeInfo must be a valid pointer to a valid OutOfBandQueueTypeInfoNV structure

-> io ()

vkQueueNotifyOutOfBandNV - Notify out of band queue

Command Properties

'

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

See Also

VK_NV_low_latency2, OutOfBandQueueTypeInfoNV, Queue

data LatencySleepModeInfoNV

VkLatencySleepModeInfoNV - Structure to set low latency mode

Description

If lowLatencyMode is set to FALSE, lowLatencyBoost will still hint to the GPU to increase its power state and latencySleepNV will still enforce minimumIntervalUs between queuePresentKHR calls.

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, Bool32, StructureType, setLatencySleepModeNV

Constructors

LatencySleepModeInfoNV

Fields

• lowLatencyMode :: Bool

  lowLatencyMode is the toggle to enable or disable low latency mode.

• lowLatencyBoost :: Bool

  lowLatencyBoost allows an application to hint to the GPU to increase performance to provide additional latency savings at a cost of increased power consumption.

• minimumIntervalUs :: Word32

Instances

Storable LatencySleepModeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: LatencySleepModeInfoNV -> Int

alignment :: LatencySleepModeInfoNV -> Int

peekElemOff :: Ptr LatencySleepModeInfoNV -> Int -> IO LatencySleepModeInfoNV

pokeElemOff :: Ptr LatencySleepModeInfoNV -> Int -> LatencySleepModeInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO LatencySleepModeInfoNV

pokeByteOff :: Ptr b -> Int -> LatencySleepModeInfoNV -> IO ()

peek :: Ptr LatencySleepModeInfoNV -> IO LatencySleepModeInfoNV

poke :: Ptr LatencySleepModeInfoNV -> LatencySleepModeInfoNV -> IO ()

Show LatencySleepModeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> LatencySleepModeInfoNV -> ShowS

show :: LatencySleepModeInfoNV -> String

showList :: [LatencySleepModeInfoNV] -> ShowS

Eq LatencySleepModeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: LatencySleepModeInfoNV -> LatencySleepModeInfoNV -> Bool

(/=) :: LatencySleepModeInfoNV -> LatencySleepModeInfoNV -> Bool

FromCStruct LatencySleepModeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr LatencySleepModeInfoNV -> IO LatencySleepModeInfoNV

ToCStruct LatencySleepModeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: LatencySleepModeInfoNV -> (Ptr LatencySleepModeInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr LatencySleepModeInfoNV -> LatencySleepModeInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr LatencySleepModeInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr LatencySleepModeInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero LatencySleepModeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: LatencySleepModeInfoNV

data LatencySleepInfoNV

VkLatencySleepInfoNV - Structure specifying the parameters of vkLatencySleepNV

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, Semaphore, StructureType, latencySleepNV

Constructors

LatencySleepInfoNV

Fields

• signalSemaphore :: Semaphore

  signalSemaphore is a semaphore that is signaled to indicate that the application should resume input sampling work.

  signalSemaphore must be a timeline semaphore

  signalSemaphore must be a valid Semaphore handle

• value :: Word64

  value is the value that signalSemaphore is set to for resuming sampling work.

Instances

Storable LatencySleepInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: LatencySleepInfoNV -> Int

alignment :: LatencySleepInfoNV -> Int

peekElemOff :: Ptr LatencySleepInfoNV -> Int -> IO LatencySleepInfoNV

pokeElemOff :: Ptr LatencySleepInfoNV -> Int -> LatencySleepInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO LatencySleepInfoNV

pokeByteOff :: Ptr b -> Int -> LatencySleepInfoNV -> IO ()

peek :: Ptr LatencySleepInfoNV -> IO LatencySleepInfoNV

poke :: Ptr LatencySleepInfoNV -> LatencySleepInfoNV -> IO ()

Show LatencySleepInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> LatencySleepInfoNV -> ShowS

show :: LatencySleepInfoNV -> String

showList :: [LatencySleepInfoNV] -> ShowS

Eq LatencySleepInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: LatencySleepInfoNV -> LatencySleepInfoNV -> Bool

(/=) :: LatencySleepInfoNV -> LatencySleepInfoNV -> Bool

FromCStruct LatencySleepInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr LatencySleepInfoNV -> IO LatencySleepInfoNV

ToCStruct LatencySleepInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: LatencySleepInfoNV -> (Ptr LatencySleepInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr LatencySleepInfoNV -> LatencySleepInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr LatencySleepInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr LatencySleepInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero LatencySleepInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: LatencySleepInfoNV

data SetLatencyMarkerInfoNV

VkSetLatencyMarkerInfoNV - Structure specifying the parameters of vkSetLatencyMarkerNV

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, LatencyMarkerNV, StructureType, setLatencyMarkerNV

Constructors

SetLatencyMarkerInfoNV

Fields

• presentID :: Word64
• marker :: LatencyMarkerNV

  marker is the type of timestamp to be recorded.

  marker must be a valid LatencyMarkerNV value

Instances

Storable SetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: SetLatencyMarkerInfoNV -> Int

alignment :: SetLatencyMarkerInfoNV -> Int

peekElemOff :: Ptr SetLatencyMarkerInfoNV -> Int -> IO SetLatencyMarkerInfoNV

pokeElemOff :: Ptr SetLatencyMarkerInfoNV -> Int -> SetLatencyMarkerInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO SetLatencyMarkerInfoNV

pokeByteOff :: Ptr b -> Int -> SetLatencyMarkerInfoNV -> IO ()

peek :: Ptr SetLatencyMarkerInfoNV -> IO SetLatencyMarkerInfoNV

poke :: Ptr SetLatencyMarkerInfoNV -> SetLatencyMarkerInfoNV -> IO ()

Show SetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> SetLatencyMarkerInfoNV -> ShowS

show :: SetLatencyMarkerInfoNV -> String

showList :: [SetLatencyMarkerInfoNV] -> ShowS

Eq SetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: SetLatencyMarkerInfoNV -> SetLatencyMarkerInfoNV -> Bool

(/=) :: SetLatencyMarkerInfoNV -> SetLatencyMarkerInfoNV -> Bool

FromCStruct SetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr SetLatencyMarkerInfoNV -> IO SetLatencyMarkerInfoNV

ToCStruct SetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: SetLatencyMarkerInfoNV -> (Ptr SetLatencyMarkerInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr SetLatencyMarkerInfoNV -> SetLatencyMarkerInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr SetLatencyMarkerInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr SetLatencyMarkerInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: SetLatencyMarkerInfoNV

data GetLatencyMarkerInfoNV

VkGetLatencyMarkerInfoNV - Structure specifying the parameters of vkGetLatencyTimingsNV

Description

The elements of pTimings are arranged in the order they were requested in, with the oldest data in the first entry.

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, LatencyTimingsFrameReportNV, StructureType, getLatencyTimingsNV

Constructors

GetLatencyMarkerInfoNV

Fields

• timings :: Ptr LatencyTimingsFrameReportNV

  pTimings is either NULL or a pointer to an array of LatencyTimingsFrameReportNV structures.

  pTimings must be a valid pointer to a LatencyTimingsFrameReportNV structure

Instances

Storable GetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: GetLatencyMarkerInfoNV -> Int

alignment :: GetLatencyMarkerInfoNV -> Int

peekElemOff :: Ptr GetLatencyMarkerInfoNV -> Int -> IO GetLatencyMarkerInfoNV

pokeElemOff :: Ptr GetLatencyMarkerInfoNV -> Int -> GetLatencyMarkerInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO GetLatencyMarkerInfoNV

pokeByteOff :: Ptr b -> Int -> GetLatencyMarkerInfoNV -> IO ()

peek :: Ptr GetLatencyMarkerInfoNV -> IO GetLatencyMarkerInfoNV

poke :: Ptr GetLatencyMarkerInfoNV -> GetLatencyMarkerInfoNV -> IO ()

Show GetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> GetLatencyMarkerInfoNV -> ShowS

show :: GetLatencyMarkerInfoNV -> String

showList :: [GetLatencyMarkerInfoNV] -> ShowS

Eq GetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: GetLatencyMarkerInfoNV -> GetLatencyMarkerInfoNV -> Bool

(/=) :: GetLatencyMarkerInfoNV -> GetLatencyMarkerInfoNV -> Bool

FromCStruct GetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr GetLatencyMarkerInfoNV -> IO GetLatencyMarkerInfoNV

ToCStruct GetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: GetLatencyMarkerInfoNV -> (Ptr GetLatencyMarkerInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr GetLatencyMarkerInfoNV -> GetLatencyMarkerInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr GetLatencyMarkerInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr GetLatencyMarkerInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero GetLatencyMarkerInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: GetLatencyMarkerInfoNV

data LatencyTimingsFrameReportNV

VkLatencyTimingsFrameReportNV - Structure containing latency data

Members

The members of the LatencyTimingsFrameReportNV structure describe the following:

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, GetLatencyMarkerInfoNV, StructureType

Constructors

LatencyTimingsFrameReportNV

Fields

• presentID :: Word64
• inputSampleTimeUs :: Word64
• simStartTimeUs :: Word64

  simStartTimeUs is the timestamp written when setLatencyMarkerNV is called with the LatencyMarkerNV enum LATENCY_MARKER_SIMULATION_START_NV.

• simEndTimeUs :: Word64

  simEndTimeUs is the timestamp written when setLatencyMarkerNV is called with the LatencyMarkerNV enum LATENCY_MARKER_SIMULATION_END_NV

• renderSubmitStartTimeUs :: Word64
• renderSubmitEndTimeUs :: Word64
• presentStartTimeUs :: Word64

  presentStartTimeUs is the timestamp written when setLatencyMarkerNV is called with the LatencyMarkerNV enum LATENCY_MARKER_PRESENT_START_NV.

• presentEndTimeUs :: Word64

  presentEndTimeUs is the timestamp written when setLatencyMarkerNV is called with the LatencyMarkerNV enum LATENCY_MARKER_PRESENT_END_NV.

• driverStartTimeUs :: Word64

  driverStartTimeUs is the timestamp written when the first queueSubmit for the frame is called.

• driverEndTimeUs :: Word64

  driverEndTimeUs is the timestamp written when the final queueSubmit hands off from the Vulkan Driver.

• osRenderQueueStartTimeUs :: Word64

  osRenderQueueStartTimeUs is the timestamp written when the final queueSubmit hands off from the Vulkan Driver.

• osRenderQueueEndTimeUs :: Word64

  osRenderQueueEndTimeUs is the timestamp written when the first submission reaches the GPU.

• gpuRenderStartTimeUs :: Word64

  gpuRenderStartTimeUs is the timestamp written when the first submission reaches the GPU.

• gpuRenderEndTimeUs :: Word64

  gpuRenderEndTimeUs is the timestamp written when the final submission finishes on the GPU for the frame.

Instances

Storable LatencyTimingsFrameReportNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: LatencyTimingsFrameReportNV -> Int

alignment :: LatencyTimingsFrameReportNV -> Int

peekElemOff :: Ptr LatencyTimingsFrameReportNV -> Int -> IO LatencyTimingsFrameReportNV

pokeElemOff :: Ptr LatencyTimingsFrameReportNV -> Int -> LatencyTimingsFrameReportNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO LatencyTimingsFrameReportNV

pokeByteOff :: Ptr b -> Int -> LatencyTimingsFrameReportNV -> IO ()

peek :: Ptr LatencyTimingsFrameReportNV -> IO LatencyTimingsFrameReportNV

poke :: Ptr LatencyTimingsFrameReportNV -> LatencyTimingsFrameReportNV -> IO ()

Show LatencyTimingsFrameReportNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> LatencyTimingsFrameReportNV -> ShowS

show :: LatencyTimingsFrameReportNV -> String

showList :: [LatencyTimingsFrameReportNV] -> ShowS

Eq LatencyTimingsFrameReportNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: LatencyTimingsFrameReportNV -> LatencyTimingsFrameReportNV -> Bool

(/=) :: LatencyTimingsFrameReportNV -> LatencyTimingsFrameReportNV -> Bool

FromCStruct LatencyTimingsFrameReportNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr LatencyTimingsFrameReportNV -> IO LatencyTimingsFrameReportNV

ToCStruct LatencyTimingsFrameReportNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: LatencyTimingsFrameReportNV -> (Ptr LatencyTimingsFrameReportNV -> IO b) -> IO b

pokeCStruct :: Ptr LatencyTimingsFrameReportNV -> LatencyTimingsFrameReportNV -> IO b -> IO b

withZeroCStruct :: (Ptr LatencyTimingsFrameReportNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr LatencyTimingsFrameReportNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero LatencyTimingsFrameReportNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: LatencyTimingsFrameReportNV

data OutOfBandQueueTypeInfoNV

VkOutOfBandQueueTypeInfoNV - Structure used to describe the queue that is being marked as Out of Band

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, OutOfBandQueueTypeNV, StructureType, queueNotifyOutOfBandNV

Constructors

OutOfBandQueueTypeInfoNV

Fields

• queueType :: OutOfBandQueueTypeNV

  queueType describes the usage of the queue to be marked as out of band.

  queueType must be a valid OutOfBandQueueTypeNV value

Instances

Storable OutOfBandQueueTypeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: OutOfBandQueueTypeInfoNV -> Int

alignment :: OutOfBandQueueTypeInfoNV -> Int

peekElemOff :: Ptr OutOfBandQueueTypeInfoNV -> Int -> IO OutOfBandQueueTypeInfoNV

pokeElemOff :: Ptr OutOfBandQueueTypeInfoNV -> Int -> OutOfBandQueueTypeInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO OutOfBandQueueTypeInfoNV

pokeByteOff :: Ptr b -> Int -> OutOfBandQueueTypeInfoNV -> IO ()

peek :: Ptr OutOfBandQueueTypeInfoNV -> IO OutOfBandQueueTypeInfoNV

poke :: Ptr OutOfBandQueueTypeInfoNV -> OutOfBandQueueTypeInfoNV -> IO ()

Show OutOfBandQueueTypeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> OutOfBandQueueTypeInfoNV -> ShowS

show :: OutOfBandQueueTypeInfoNV -> String

showList :: [OutOfBandQueueTypeInfoNV] -> ShowS

Eq OutOfBandQueueTypeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: OutOfBandQueueTypeInfoNV -> OutOfBandQueueTypeInfoNV -> Bool

(/=) :: OutOfBandQueueTypeInfoNV -> OutOfBandQueueTypeInfoNV -> Bool

FromCStruct OutOfBandQueueTypeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr OutOfBandQueueTypeInfoNV -> IO OutOfBandQueueTypeInfoNV

ToCStruct OutOfBandQueueTypeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: OutOfBandQueueTypeInfoNV -> (Ptr OutOfBandQueueTypeInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr OutOfBandQueueTypeInfoNV -> OutOfBandQueueTypeInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr OutOfBandQueueTypeInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr OutOfBandQueueTypeInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero OutOfBandQueueTypeInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: OutOfBandQueueTypeInfoNV

data LatencySubmissionPresentIdNV

VkLatencySubmissionPresentIdNV - Structure used to associate a queueSubmit with a presentId

Description

For any submission to be tracked with low latency mode pacing, it needs to be associated with other submissions in a given present. Applications :must include the VkLatencySubmissionPresentIdNV in the pNext chain of queueSubmit to associate that submission with the presentId present for low latency mode.

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, StructureType

Constructors

LatencySubmissionPresentIdNV

Fields

• presentID :: Word64

Instances

Storable LatencySubmissionPresentIdNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: LatencySubmissionPresentIdNV -> Int

alignment :: LatencySubmissionPresentIdNV -> Int

peekElemOff :: Ptr LatencySubmissionPresentIdNV -> Int -> IO LatencySubmissionPresentIdNV

pokeElemOff :: Ptr LatencySubmissionPresentIdNV -> Int -> LatencySubmissionPresentIdNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO LatencySubmissionPresentIdNV

pokeByteOff :: Ptr b -> Int -> LatencySubmissionPresentIdNV -> IO ()

peek :: Ptr LatencySubmissionPresentIdNV -> IO LatencySubmissionPresentIdNV

poke :: Ptr LatencySubmissionPresentIdNV -> LatencySubmissionPresentIdNV -> IO ()

Show LatencySubmissionPresentIdNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> LatencySubmissionPresentIdNV -> ShowS

show :: LatencySubmissionPresentIdNV -> String

showList :: [LatencySubmissionPresentIdNV] -> ShowS

Eq LatencySubmissionPresentIdNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: LatencySubmissionPresentIdNV -> LatencySubmissionPresentIdNV -> Bool

(/=) :: LatencySubmissionPresentIdNV -> LatencySubmissionPresentIdNV -> Bool

FromCStruct LatencySubmissionPresentIdNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr LatencySubmissionPresentIdNV -> IO LatencySubmissionPresentIdNV

ToCStruct LatencySubmissionPresentIdNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: LatencySubmissionPresentIdNV -> (Ptr LatencySubmissionPresentIdNV -> IO b) -> IO b

pokeCStruct :: Ptr LatencySubmissionPresentIdNV -> LatencySubmissionPresentIdNV -> IO b -> IO b

withZeroCStruct :: (Ptr LatencySubmissionPresentIdNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr LatencySubmissionPresentIdNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero LatencySubmissionPresentIdNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: LatencySubmissionPresentIdNV

data SwapchainLatencyCreateInfoNV

VkSwapchainLatencyCreateInfoNV - Specify that a swapchain will use low latency mode

Valid Usage (Implicit)

See Also

VK_NV_low_latency2, Bool32, StructureType

Constructors

SwapchainLatencyCreateInfoNV

Fields

• latencyModeEnable :: Bool

Instances

Storable SwapchainLatencyCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: SwapchainLatencyCreateInfoNV -> Int

alignment :: SwapchainLatencyCreateInfoNV -> Int

peekElemOff :: Ptr SwapchainLatencyCreateInfoNV -> Int -> IO SwapchainLatencyCreateInfoNV

pokeElemOff :: Ptr SwapchainLatencyCreateInfoNV -> Int -> SwapchainLatencyCreateInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO SwapchainLatencyCreateInfoNV

pokeByteOff :: Ptr b -> Int -> SwapchainLatencyCreateInfoNV -> IO ()

peek :: Ptr SwapchainLatencyCreateInfoNV -> IO SwapchainLatencyCreateInfoNV

poke :: Ptr SwapchainLatencyCreateInfoNV -> SwapchainLatencyCreateInfoNV -> IO ()

Show SwapchainLatencyCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> SwapchainLatencyCreateInfoNV -> ShowS

show :: SwapchainLatencyCreateInfoNV -> String

showList :: [SwapchainLatencyCreateInfoNV] -> ShowS

Eq SwapchainLatencyCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: SwapchainLatencyCreateInfoNV -> SwapchainLatencyCreateInfoNV -> Bool

(/=) :: SwapchainLatencyCreateInfoNV -> SwapchainLatencyCreateInfoNV -> Bool

FromCStruct SwapchainLatencyCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr SwapchainLatencyCreateInfoNV -> IO SwapchainLatencyCreateInfoNV

ToCStruct SwapchainLatencyCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: SwapchainLatencyCreateInfoNV -> (Ptr SwapchainLatencyCreateInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr SwapchainLatencyCreateInfoNV -> SwapchainLatencyCreateInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr SwapchainLatencyCreateInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr SwapchainLatencyCreateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SwapchainLatencyCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: SwapchainLatencyCreateInfoNV

data LatencySurfaceCapabilitiesNV

VkLatencySurfaceCapabilitiesNV - Structure describing surface optimized presentation modes for use with low latency mode

Description

If pPresentModes is NULL, then the number of present modes that are optimized for use with low latency mode returned in presentModeCount. Otherwise, presentModeCount must be set by the user to the number of elements in the pPresentModes array, and on return the variable is overwritten with the number of values actually written to pPresentModes. If the value of presentModeCount is less than the number of optimized present modes, at most presentModeCount values will be written to pPresentModes.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_LATENCY_SURFACE_CAPABILITIES_NV

• If presentModeCount is not 0, and pPresentModes is not NULL, pPresentModes must be a valid pointer to an array of presentModeCount PresentModeKHR values

See Also

VK_NV_low_latency2, PresentModeKHR, StructureType

Constructors

LatencySurfaceCapabilitiesNV

Fields

• presentModeCount :: Word32

  presentModeCount is the number of presentation modes provided.

• presentModes :: Ptr PresentModeKHR

  pPresentModes is list of presentation modes optimized for use with low latency mode with presentModeCount entries.

Instances

Storable LatencySurfaceCapabilitiesNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: LatencySurfaceCapabilitiesNV -> Int

alignment :: LatencySurfaceCapabilitiesNV -> Int

peekElemOff :: Ptr LatencySurfaceCapabilitiesNV -> Int -> IO LatencySurfaceCapabilitiesNV

pokeElemOff :: Ptr LatencySurfaceCapabilitiesNV -> Int -> LatencySurfaceCapabilitiesNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO LatencySurfaceCapabilitiesNV

pokeByteOff :: Ptr b -> Int -> LatencySurfaceCapabilitiesNV -> IO ()

peek :: Ptr LatencySurfaceCapabilitiesNV -> IO LatencySurfaceCapabilitiesNV

poke :: Ptr LatencySurfaceCapabilitiesNV -> LatencySurfaceCapabilitiesNV -> IO ()

Show LatencySurfaceCapabilitiesNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> LatencySurfaceCapabilitiesNV -> ShowS

show :: LatencySurfaceCapabilitiesNV -> String

showList :: [LatencySurfaceCapabilitiesNV] -> ShowS

Eq LatencySurfaceCapabilitiesNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: LatencySurfaceCapabilitiesNV -> LatencySurfaceCapabilitiesNV -> Bool

(/=) :: LatencySurfaceCapabilitiesNV -> LatencySurfaceCapabilitiesNV -> Bool

FromCStruct LatencySurfaceCapabilitiesNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

peekCStruct :: Ptr LatencySurfaceCapabilitiesNV -> IO LatencySurfaceCapabilitiesNV

ToCStruct LatencySurfaceCapabilitiesNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

withCStruct :: LatencySurfaceCapabilitiesNV -> (Ptr LatencySurfaceCapabilitiesNV -> IO b) -> IO b

pokeCStruct :: Ptr LatencySurfaceCapabilitiesNV -> LatencySurfaceCapabilitiesNV -> IO b -> IO b

withZeroCStruct :: (Ptr LatencySurfaceCapabilitiesNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr LatencySurfaceCapabilitiesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero LatencySurfaceCapabilitiesNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: LatencySurfaceCapabilitiesNV

newtype LatencyMarkerNV

VkLatencyMarkerNV - Structure used to mark different points in latency

Description

The members of the LatencyMarkerNV are used as arguments for setLatencyMarkerNV in the use cases described below:

See Also

VK_NV_low_latency2, SetLatencyMarkerInfoNV

Constructors

LatencyMarkerNV Int32

Bundled Patterns

pattern LATENCY_MARKER_SIMULATION_START_NV :: LatencyMarkerNV

LATENCY_MARKER_SIMULATION_START_NV should be called at the start of the simulation execution each frame, but after the call to latencySleepNV.

pattern LATENCY_MARKER_SIMULATION_END_NV :: LatencyMarkerNV

LATENCY_MARKER_SIMULATION_END_NV should be called at the end of the simulation execution each frame.

pattern LATENCY_MARKER_RENDERSUBMIT_START_NV :: LatencyMarkerNV

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.

pattern LATENCY_MARKER_RENDERSUBMIT_END_NV :: LatencyMarkerNV

LATENCY_MARKER_RENDERSUBMIT_END_NV should be called at the end of the render submission execution each frame.

pattern LATENCY_MARKER_PRESENT_START_NV :: LatencyMarkerNV

LATENCY_MARKER_PRESENT_START_NV should be called just before queuePresentKHR.

pattern LATENCY_MARKER_PRESENT_END_NV :: LatencyMarkerNV

LATENCY_MARKER_PRESENT_END_NV should be called when queuePresentKHR returns.

pattern LATENCY_MARKER_INPUT_SAMPLE_NV :: LatencyMarkerNV

LATENCY_MARKER_INPUT_SAMPLE_NV should be called just before the application gathers input data.

pattern LATENCY_MARKER_TRIGGER_FLASH_NV :: LatencyMarkerNV

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.

pattern LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_START_NV :: LatencyMarkerNV

pattern LATENCY_MARKER_OUT_OF_BAND_RENDERSUBMIT_END_NV :: LatencyMarkerNV

pattern LATENCY_MARKER_OUT_OF_BAND_PRESENT_START_NV :: LatencyMarkerNV

pattern LATENCY_MARKER_OUT_OF_BAND_PRESENT_END_NV :: LatencyMarkerNV

Instances

Storable LatencyMarkerNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: LatencyMarkerNV -> Int

alignment :: LatencyMarkerNV -> Int

peekElemOff :: Ptr LatencyMarkerNV -> Int -> IO LatencyMarkerNV

pokeElemOff :: Ptr LatencyMarkerNV -> Int -> LatencyMarkerNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO LatencyMarkerNV

pokeByteOff :: Ptr b -> Int -> LatencyMarkerNV -> IO ()

peek :: Ptr LatencyMarkerNV -> IO LatencyMarkerNV

poke :: Ptr LatencyMarkerNV -> LatencyMarkerNV -> IO ()

Read LatencyMarkerNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

readsPrec :: Int -> ReadS LatencyMarkerNV

readList :: ReadS [LatencyMarkerNV]

readPrec :: ReadPrec LatencyMarkerNV

readListPrec :: ReadPrec [LatencyMarkerNV]

Show LatencyMarkerNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> LatencyMarkerNV -> ShowS

show :: LatencyMarkerNV -> String

showList :: [LatencyMarkerNV] -> ShowS

Eq LatencyMarkerNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: LatencyMarkerNV -> LatencyMarkerNV -> Bool

(/=) :: LatencyMarkerNV -> LatencyMarkerNV -> Bool

Ord LatencyMarkerNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

compare :: LatencyMarkerNV -> LatencyMarkerNV -> Ordering

(<) :: LatencyMarkerNV -> LatencyMarkerNV -> Bool

(<=) :: LatencyMarkerNV -> LatencyMarkerNV -> Bool

(>) :: LatencyMarkerNV -> LatencyMarkerNV -> Bool

(>=) :: LatencyMarkerNV -> LatencyMarkerNV -> Bool

max :: LatencyMarkerNV -> LatencyMarkerNV -> LatencyMarkerNV

min :: LatencyMarkerNV -> LatencyMarkerNV -> LatencyMarkerNV

Zero LatencyMarkerNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: LatencyMarkerNV

newtype OutOfBandQueueTypeNV

VkOutOfBandQueueTypeNV - Type of out of band queue

Description

The members of the OutOfBandQueueTypeNV are used to describe the queue type in OutOfBandQueueTypeInfoNV as described below:

See Also

VK_NV_low_latency2, OutOfBandQueueTypeInfoNV

Constructors

OutOfBandQueueTypeNV Int32

Bundled Patterns

pattern OUT_OF_BAND_QUEUE_TYPE_RENDER_NV :: OutOfBandQueueTypeNV

OUT_OF_BAND_QUEUE_TYPE_RENDER_NV indicates that work will be submitted to this queue.

pattern OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV :: OutOfBandQueueTypeNV

OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV indicates that this queue will be presented from.

Instances

Storable OutOfBandQueueTypeNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

sizeOf :: OutOfBandQueueTypeNV -> Int

alignment :: OutOfBandQueueTypeNV -> Int

peekElemOff :: Ptr OutOfBandQueueTypeNV -> Int -> IO OutOfBandQueueTypeNV

pokeElemOff :: Ptr OutOfBandQueueTypeNV -> Int -> OutOfBandQueueTypeNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO OutOfBandQueueTypeNV

pokeByteOff :: Ptr b -> Int -> OutOfBandQueueTypeNV -> IO ()

peek :: Ptr OutOfBandQueueTypeNV -> IO OutOfBandQueueTypeNV

poke :: Ptr OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> IO ()

Read OutOfBandQueueTypeNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

readsPrec :: Int -> ReadS OutOfBandQueueTypeNV

readList :: ReadS [OutOfBandQueueTypeNV]

readPrec :: ReadPrec OutOfBandQueueTypeNV

readListPrec :: ReadPrec [OutOfBandQueueTypeNV]

Show OutOfBandQueueTypeNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

showsPrec :: Int -> OutOfBandQueueTypeNV -> ShowS

show :: OutOfBandQueueTypeNV -> String

showList :: [OutOfBandQueueTypeNV] -> ShowS

Eq OutOfBandQueueTypeNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

(==) :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Bool

(/=) :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Bool

Ord OutOfBandQueueTypeNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

compare :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Ordering

(<) :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Bool

(<=) :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Bool

(>) :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Bool

(>=) :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> Bool

max :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV

min :: OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV -> OutOfBandQueueTypeNV

Zero OutOfBandQueueTypeNV

Defined in Vulkan.Extensions.VK_NV_low_latency2

Methods

zero :: OutOfBandQueueTypeNV

type NV_LOW_LATENCY_2_SPEC_VERSION = 1

pattern NV_LOW_LATENCY_2_SPEC_VERSION :: forall a. Integral a => a

type NV_LOW_LATENCY_2_EXTENSION_NAME = "VK_NV_low_latency2"

pattern NV_LOW_LATENCY_2_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype SwapchainKHR

VkSwapchainKHR - Opaque handle to a swapchain object

Description

A swapchain is an abstraction for an array of presentable images that are associated with a surface. The presentable images are represented by Image objects created by the platform. One image (which can be an array image for multiview/stereoscopic-3D surfaces) is displayed at a time, but multiple images can be queued for presentation. An application renders to the image, and then queues the image for presentation to the surface.

A native window cannot be associated with more than one non-retired swapchain at a time. Further, swapchains cannot be created for native windows that have a non-Vulkan graphics API surface associated with them.

Note

The presentation engine is an abstraction for the platform’s compositor or display engine.

The presentation engine may be synchronous or asynchronous with respect to the application and/or logical device.

Some implementations may use the device’s graphics queue or dedicated presentation hardware to perform presentation.

The presentable images of a swapchain are owned by the presentation engine. An application can acquire use of a presentable image from the presentation engine. Use of a presentable image must occur only after the image is returned by acquireNextImageKHR, and before it is released by queuePresentKHR. This includes transitioning the image layout and rendering commands.

An application can acquire use of a presentable image with acquireNextImageKHR. After acquiring a presentable image and before modifying it, the application must use a synchronization primitive to ensure that the presentation engine has finished reading from the image. The application can then transition the image’s layout, queue rendering commands to it, etc. Finally, the application presents the image with queuePresentKHR, which releases the acquisition of the image. The application can also release the acquisition of the image through releaseSwapchainImagesEXT, if the image is not in use by the device, and skip the present operation.

The presentation engine controls the order in which presentable images are acquired for use by the application.

Note

This allows the platform to handle situations which require out-of-order return of images after presentation. At the same time, it allows the application to generate command buffers referencing all of the images in the swapchain at initialization time, rather than in its main loop.

See Also

VK_KHR_swapchain, AcquireNextImageInfoKHR, BindImageMemorySwapchainInfoKHR, ImageSwapchainCreateInfoKHR, PresentInfoKHR, ReleaseSwapchainImagesInfoEXT, SwapchainCreateInfoKHR, acquireFullScreenExclusiveModeEXT, acquireNextImageKHR, createSharedSwapchainsKHR, createSwapchainKHR, destroySwapchainKHR, getLatencyTimingsNV, getPastPresentationTimingGOOGLE, getRefreshCycleDurationGOOGLE, getSwapchainCounterEXT, getSwapchainImagesKHR, getSwapchainStatusKHR, latencySleepNV, queuePresentKHR, releaseFullScreenExclusiveModeEXT, setHdrMetadataEXT, setLatencyMarkerNV, setLatencySleepModeNV, setLocalDimmingAMD, waitForPresentKHR

Constructors

SwapchainKHR Word64

Instances

Storable SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SwapchainKHR -> Int

alignment :: SwapchainKHR -> Int

peekElemOff :: Ptr SwapchainKHR -> Int -> IO SwapchainKHR

pokeElemOff :: Ptr SwapchainKHR -> Int -> SwapchainKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO SwapchainKHR

pokeByteOff :: Ptr b -> Int -> SwapchainKHR -> IO ()

peek :: Ptr SwapchainKHR -> IO SwapchainKHR

poke :: Ptr SwapchainKHR -> SwapchainKHR -> IO ()

Show SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SwapchainKHR -> ShowS

show :: SwapchainKHR -> String

showList :: [SwapchainKHR] -> ShowS

Eq SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: SwapchainKHR -> SwapchainKHR -> Bool

(/=) :: SwapchainKHR -> SwapchainKHR -> Bool

Ord SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SwapchainKHR -> SwapchainKHR -> Ordering

(<) :: SwapchainKHR -> SwapchainKHR -> Bool

(<=) :: SwapchainKHR -> SwapchainKHR -> Bool

(>) :: SwapchainKHR -> SwapchainKHR -> Bool

(>=) :: SwapchainKHR -> SwapchainKHR -> Bool

max :: SwapchainKHR -> SwapchainKHR -> SwapchainKHR

min :: SwapchainKHR -> SwapchainKHR -> SwapchainKHR

HasObjectType SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SwapchainKHR -> (ObjectType, Word64)

IsHandle SwapchainKHR

Defined in Vulkan.Extensions.Handles

Zero SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SwapchainKHR

newtype PresentModeKHR

VkPresentModeKHR - Presentation mode supported for a surface

Description

The supported ImageUsageFlagBits of the presentable images of a swapchain created for a surface may differ depending on the presentation mode, and can be determined as per the table below:

Presentation mode	Image usage flags
PRESENT_MODE_IMMEDIATE_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_MAILBOX_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_FIFO_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_FIFO_RELAXED_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR	SharedPresentSurfaceCapabilitiesKHR::sharedPresentSupportedUsageFlags
PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR	SharedPresentSurfaceCapabilitiesKHR::sharedPresentSupportedUsageFlags

Presentable image usage queries

Note

For reference, the mode indicated by PRESENT_MODE_FIFO_KHR is equivalent to the behavior of {wgl|glX|egl}SwapBuffers with a swap interval of 1, while the mode indicated by PRESENT_MODE_FIFO_RELAXED_KHR is equivalent to the behavior of {wgl|glX}SwapBuffers with a swap interval of -1 (from the {WGL|GLX}_EXT_swap_control_tear extensions).

See Also

VK_KHR_surface, LatencySurfaceCapabilitiesNV, SurfacePresentModeCompatibilityEXT, SurfacePresentModeEXT, SwapchainCreateInfoKHR, SwapchainPresentModeInfoEXT, SwapchainPresentModesCreateInfoEXT, getPhysicalDeviceSurfacePresentModes2EXT, getPhysicalDeviceSurfacePresentModesKHR

Constructors

PresentModeKHR Int32

Bundled Patterns

pattern PRESENT_MODE_IMMEDIATE_KHR :: PresentModeKHR

PRESENT_MODE_IMMEDIATE_KHR specifies that the presentation engine does not wait for a vertical blanking period to update the current image, meaning this mode may result in visible tearing. No internal queuing of presentation requests is needed, as the requests are applied immediately.

pattern PRESENT_MODE_MAILBOX_KHR :: PresentModeKHR

PRESENT_MODE_MAILBOX_KHR specifies that the presentation engine waits for the next vertical blanking period to update the current image. Tearing cannot be observed. An internal single-entry queue is used to hold pending presentation requests. If the queue is full when a new presentation request is received, the new request replaces the existing entry, and any images associated with the prior entry become available for reuse by the application. One request is removed from the queue and processed during each vertical blanking period in which the queue is non-empty.

pattern PRESENT_MODE_FIFO_KHR :: PresentModeKHR

PRESENT_MODE_FIFO_KHR specifies that the presentation engine waits for the next vertical blanking period to update the current image. Tearing cannot be observed. An internal queue is used to hold pending presentation requests. New requests are appended to the end of the queue, and one request is removed from the beginning of the queue and processed during each vertical blanking period in which the queue is non-empty. This is the only value of presentMode that is required to be supported.

pattern PRESENT_MODE_FIFO_RELAXED_KHR :: PresentModeKHR

PRESENT_MODE_FIFO_RELAXED_KHR specifies that the presentation engine generally waits for the next vertical blanking period to update the current image. If a vertical blanking period has already passed since the last update of the current image then the presentation engine does not wait for another vertical blanking period for the update, meaning this mode may result in visible tearing in this case. This mode is useful for reducing visual stutter with an application that will mostly present a new image before the next vertical blanking period, but may occasionally be late, and present a new image just after the next vertical blanking period. An internal queue is used to hold pending presentation requests. New requests are appended to the end of the queue, and one request is removed from the beginning of the queue and processed during or after each vertical blanking period in which the queue is non-empty.

pattern PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR :: PresentModeKHR

PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR specifies that the presentation engine and application have concurrent access to a single image, which is referred to as a shared presentable image. The presentation engine periodically updates the current image on its regular refresh cycle. The application is only required to make one initial presentation request, after which the presentation engine must update the current image without any need for further presentation requests. The application can indicate the image contents have been updated by making a presentation request, but this does not guarantee the timing of when it will be updated. This mode may result in visible tearing if rendering to the image is not timed correctly.

pattern PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR :: PresentModeKHR

PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR specifies that the presentation engine and application have concurrent access to a single image, which is referred to as a shared presentable image. The presentation engine is only required to update the current image after a new presentation request is received. Therefore the application must make a presentation request whenever an update is required. However, the presentation engine may update the current image at any point, meaning this mode may result in visible tearing.

Instances

Storable PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

sizeOf :: PresentModeKHR -> Int

alignment :: PresentModeKHR -> Int

peekElemOff :: Ptr PresentModeKHR -> Int -> IO PresentModeKHR

pokeElemOff :: Ptr PresentModeKHR -> Int -> PresentModeKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PresentModeKHR

pokeByteOff :: Ptr b -> Int -> PresentModeKHR -> IO ()

peek :: Ptr PresentModeKHR -> IO PresentModeKHR

poke :: Ptr PresentModeKHR -> PresentModeKHR -> IO ()

Read PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

readsPrec :: Int -> ReadS PresentModeKHR

readList :: ReadS [PresentModeKHR]

readPrec :: ReadPrec PresentModeKHR

readListPrec :: ReadPrec [PresentModeKHR]

Show PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

showsPrec :: Int -> PresentModeKHR -> ShowS

show :: PresentModeKHR -> String

showList :: [PresentModeKHR] -> ShowS

Eq PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

(==) :: PresentModeKHR -> PresentModeKHR -> Bool

(/=) :: PresentModeKHR -> PresentModeKHR -> Bool

Ord PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

compare :: PresentModeKHR -> PresentModeKHR -> Ordering

(<) :: PresentModeKHR -> PresentModeKHR -> Bool

(<=) :: PresentModeKHR -> PresentModeKHR -> Bool

(>) :: PresentModeKHR -> PresentModeKHR -> Bool

(>=) :: PresentModeKHR -> PresentModeKHR -> Bool

max :: PresentModeKHR -> PresentModeKHR -> PresentModeKHR

min :: PresentModeKHR -> PresentModeKHR -> PresentModeKHR

Zero PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

zero :: PresentModeKHR