Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Description

Name

VK_NV_device_diagnostic_checkpoints - device extension

VK_NV_device_diagnostic_checkpoints

Name String: VK_NV_device_diagnostic_checkpoints

Extension Type

Device extension

Registered Extension Number

207

Revision

2

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Vulkan Version 1.1

API Interactions

Interacts with VK_VERSION_1_3
Interacts with VK_KHR_synchronization2

Contact

Nuno Subtil @nsubtil%0A*Here describe the issue or question you have about the VK_NV_device_diagnostic_checkpoints extension*

Other Extension Metadata

Last Modified Date: 2018-07-16

Contributors

Oleg Kuznetsov, NVIDIA
Alex Dunn, NVIDIA
Jeff Bolz, NVIDIA
Eric Werness, NVIDIA
Daniel Koch, NVIDIA

Description

This extension allows applications to insert markers in the command stream and associate them with custom data.

If a device lost error occurs, the application may then query the implementation for the last markers to cross specific implementation-defined pipeline stages, in order to narrow down which commands were executing at the time and might have caused the failure.

New Commands

cmdSetCheckpointNV

getQueueCheckpointDataNV

If Vulkan Version 1.3 or VK_KHR_synchronization2 is supported:

getQueueCheckpointData2NV

New Structures

CheckpointDataNV

Extending QueueFamilyProperties2:
- QueueFamilyCheckpointPropertiesNV

If Vulkan Version 1.3 or VK_KHR_synchronization2 is supported:

CheckpointData2NV
Extending QueueFamilyProperties2:
- QueueFamilyCheckpointProperties2NV

New Enum Constants

NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME

If Vulkan Version 1.3 or VK_KHR_synchronization2 is supported:

Extending StructureType:
- STRUCTURE_TYPE_CHECKPOINT_DATA_2_NV
- STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_2_NV

Version History

Revision 1, 2018-07-16 (Nuno Subtil)
- Internal revisions

Revision 2, 2018-07-16 (Nuno Subtil)
- ???

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.

Synopsis

cmdSetCheckpointNV :: MonadIO io => CommandBuffer -> ("checkpointMarker" ::: Ptr ()) -> io ()
getQueueCheckpointDataNV :: MonadIO io => Queue -> io ("checkpointData" ::: Vector CheckpointDataNV)
getQueueCheckpointData2NV :: MonadIO io => Queue -> io ("checkpointData" ::: Vector CheckpointData2NV)
data QueueFamilyCheckpointPropertiesNV = QueueFamilyCheckpointPropertiesNV {
- checkpointExecutionStageMask :: PipelineStageFlags
}
data CheckpointDataNV = CheckpointDataNV {
- stage :: PipelineStageFlagBits
- checkpointMarker :: Ptr ()
}
data QueueFamilyCheckpointProperties2NV = QueueFamilyCheckpointProperties2NV {
- checkpointExecutionStageMask :: PipelineStageFlags2
}
data CheckpointData2NV = CheckpointData2NV {
- stage :: PipelineStageFlags2
- checkpointMarker :: Ptr ()
}
type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION = 2
pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION :: Integral a => a
type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME = "VK_NV_device_diagnostic_checkpoints"
pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

cmdSetCheckpointNV Source #

Arguments

:: MonadIO io
=> CommandBuffer	`commandBuffer` is the command buffer that will receive the marker
-> ("checkpointMarker" ::: Ptr ())	`pCheckpointMarker` is an opaque application-provided value that will be associated with the checkpoint.
-> io ()

vkCmdSetCheckpointNV - Insert diagnostic checkpoint in command stream

Valid Usage (Implicit)

commandBuffer must be a valid CommandBuffer handle

commandBuffer must be in the recording state
The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, QUEUE_GRAPHICS_BIT, or QUEUE_TRANSFER_BIT operations
This command must not be called between suspended render pass instances
This command must only be called outside of a video coding scope

Host Synchronization

Host access to commandBuffer must be externally synchronized

Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Both	Outside	VK_QUEUE_COMPUTE_BIT VK_QUEUE_GRAPHICS_BIT VK_QUEUE_TRANSFER_BIT	Action

Conditional Rendering

vkCmdSetCheckpointNV is not affected by conditional rendering

Description

If pCheckpointData is NULL, then the number of checkpoint markers available is returned in pCheckpointDataCount.

Otherwise, pCheckpointDataCount must point to a variable set by the application to the number of elements in the pCheckpointData array, and on return the variable is overwritten with the number of structures actually written to pCheckpointData.

If pCheckpointDataCount is less than the number of checkpoint markers available, at most pCheckpointDataCount structures will be written.

Valid Usage

The device that queue belongs to must be in the lost state

Valid Usage (Implicit)

queue must be a valid Queue handle

pCheckpointDataCount must be a valid pointer to a uint32_t value
If the value referenced by pCheckpointDataCount is not 0, and pCheckpointData is not NULL, pCheckpointData must be a valid pointer to an array of pCheckpointDataCount CheckpointDataNV structures

Description

If pCheckpointData is NULL, then the number of checkpoint markers available is returned in pCheckpointDataCount. Otherwise, pCheckpointDataCount must point to a variable set by the application to the number of elements in the pCheckpointData array, and on return the variable is overwritten with the number of structures actually written to pCheckpointData.

If pCheckpointDataCount is less than the number of checkpoint markers available, at most pCheckpointDataCount structures will be written.

Valid Usage

The device that queue belongs to must be in the lost state

Valid Usage (Implicit)

queue must be a valid Queue handle

pCheckpointDataCount must be a valid pointer to a uint32_t value
If the value referenced by pCheckpointDataCount is not 0, and pCheckpointData is not NULL, pCheckpointData must be a valid pointer to an array of pCheckpointDataCount CheckpointData2NV structures

Description

Additional queue family information can be queried by setting QueueFamilyProperties2::pNext to point to a QueueFamilyCheckpointPropertiesNV structure.

Valid Usage (Implicit)

Description

The stages at which a checkpoint marker can be executed are implementation-defined and can be queried by calling getPhysicalDeviceQueueFamilyProperties2.

Valid Usage (Implicit)

Description

Additional queue family information can be queried by setting QueueFamilyProperties2::pNext to point to a QueueFamilyCheckpointProperties2NV structure.

Eq QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods (==) :: QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> Bool # (/=) :: QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> Bool #
Storable QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods sizeOf :: QueueFamilyCheckpointPropertiesNV -> Int # alignment :: QueueFamilyCheckpointPropertiesNV -> Int # peekElemOff :: Ptr QueueFamilyCheckpointPropertiesNV -> Int -> IO QueueFamilyCheckpointPropertiesNV # pokeElemOff :: Ptr QueueFamilyCheckpointPropertiesNV -> Int -> QueueFamilyCheckpointPropertiesNV -> IO () # peekByteOff :: Ptr b -> Int -> IO QueueFamilyCheckpointPropertiesNV # pokeByteOff :: Ptr b -> Int -> QueueFamilyCheckpointPropertiesNV -> IO () # peek :: Ptr QueueFamilyCheckpointPropertiesNV -> IO QueueFamilyCheckpointPropertiesNV # poke :: Ptr QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> IO () #
Show QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods showsPrec :: Int -> QueueFamilyCheckpointPropertiesNV -> ShowS # show :: QueueFamilyCheckpointPropertiesNV -> String # showList :: [QueueFamilyCheckpointPropertiesNV] -> ShowS #
FromCStruct QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods peekCStruct :: Ptr QueueFamilyCheckpointPropertiesNV -> IO QueueFamilyCheckpointPropertiesNV Source #
ToCStruct QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods withCStruct :: QueueFamilyCheckpointPropertiesNV -> (Ptr QueueFamilyCheckpointPropertiesNV -> IO b) -> IO b Source # pokeCStruct :: Ptr QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr QueueFamilyCheckpointPropertiesNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr QueueFamilyCheckpointPropertiesNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods zero :: QueueFamilyCheckpointPropertiesNV Source #

Storable CheckpointDataNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods sizeOf :: CheckpointDataNV -> Int # alignment :: CheckpointDataNV -> Int # peekElemOff :: Ptr CheckpointDataNV -> Int -> IO CheckpointDataNV # pokeElemOff :: Ptr CheckpointDataNV -> Int -> CheckpointDataNV -> IO () # peekByteOff :: Ptr b -> Int -> IO CheckpointDataNV # pokeByteOff :: Ptr b -> Int -> CheckpointDataNV -> IO () # peek :: Ptr CheckpointDataNV -> IO CheckpointDataNV # poke :: Ptr CheckpointDataNV -> CheckpointDataNV -> IO () #
Show CheckpointDataNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods showsPrec :: Int -> CheckpointDataNV -> ShowS # show :: CheckpointDataNV -> String # showList :: [CheckpointDataNV] -> ShowS #
FromCStruct CheckpointDataNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods peekCStruct :: Ptr CheckpointDataNV -> IO CheckpointDataNV Source #
ToCStruct CheckpointDataNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods withCStruct :: CheckpointDataNV -> (Ptr CheckpointDataNV -> IO b) -> IO b Source # pokeCStruct :: Ptr CheckpointDataNV -> CheckpointDataNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr CheckpointDataNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr CheckpointDataNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero CheckpointDataNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods zero :: CheckpointDataNV Source #

Eq QueueFamilyCheckpointProperties2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods (==) :: QueueFamilyCheckpointProperties2NV -> QueueFamilyCheckpointProperties2NV -> Bool # (/=) :: QueueFamilyCheckpointProperties2NV -> QueueFamilyCheckpointProperties2NV -> Bool #
Storable QueueFamilyCheckpointProperties2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods sizeOf :: QueueFamilyCheckpointProperties2NV -> Int # alignment :: QueueFamilyCheckpointProperties2NV -> Int # peekElemOff :: Ptr QueueFamilyCheckpointProperties2NV -> Int -> IO QueueFamilyCheckpointProperties2NV # pokeElemOff :: Ptr QueueFamilyCheckpointProperties2NV -> Int -> QueueFamilyCheckpointProperties2NV -> IO () # peekByteOff :: Ptr b -> Int -> IO QueueFamilyCheckpointProperties2NV # pokeByteOff :: Ptr b -> Int -> QueueFamilyCheckpointProperties2NV -> IO () # peek :: Ptr QueueFamilyCheckpointProperties2NV -> IO QueueFamilyCheckpointProperties2NV # poke :: Ptr QueueFamilyCheckpointProperties2NV -> QueueFamilyCheckpointProperties2NV -> IO () #
Show QueueFamilyCheckpointProperties2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods showsPrec :: Int -> QueueFamilyCheckpointProperties2NV -> ShowS # show :: QueueFamilyCheckpointProperties2NV -> String # showList :: [QueueFamilyCheckpointProperties2NV] -> ShowS #
FromCStruct QueueFamilyCheckpointProperties2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods peekCStruct :: Ptr QueueFamilyCheckpointProperties2NV -> IO QueueFamilyCheckpointProperties2NV Source #
ToCStruct QueueFamilyCheckpointProperties2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods withCStruct :: QueueFamilyCheckpointProperties2NV -> (Ptr QueueFamilyCheckpointProperties2NV -> IO b) -> IO b Source # pokeCStruct :: Ptr QueueFamilyCheckpointProperties2NV -> QueueFamilyCheckpointProperties2NV -> IO b -> IO b Source # withZeroCStruct :: (Ptr QueueFamilyCheckpointProperties2NV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr QueueFamilyCheckpointProperties2NV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero QueueFamilyCheckpointProperties2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods zero :: QueueFamilyCheckpointProperties2NV Source #

Storable CheckpointData2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods sizeOf :: CheckpointData2NV -> Int # alignment :: CheckpointData2NV -> Int # peekElemOff :: Ptr CheckpointData2NV -> Int -> IO CheckpointData2NV # pokeElemOff :: Ptr CheckpointData2NV -> Int -> CheckpointData2NV -> IO () # peekByteOff :: Ptr b -> Int -> IO CheckpointData2NV # pokeByteOff :: Ptr b -> Int -> CheckpointData2NV -> IO () # peek :: Ptr CheckpointData2NV -> IO CheckpointData2NV # poke :: Ptr CheckpointData2NV -> CheckpointData2NV -> IO () #
Show CheckpointData2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods showsPrec :: Int -> CheckpointData2NV -> ShowS # show :: CheckpointData2NV -> String # showList :: [CheckpointData2NV] -> ShowS #
FromCStruct CheckpointData2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods peekCStruct :: Ptr CheckpointData2NV -> IO CheckpointData2NV Source #
ToCStruct CheckpointData2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods withCStruct :: CheckpointData2NV -> (Ptr CheckpointData2NV -> IO b) -> IO b Source # pokeCStruct :: Ptr CheckpointData2NV -> CheckpointData2NV -> IO b -> IO b Source # withZeroCStruct :: (Ptr CheckpointData2NV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr CheckpointData2NV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero CheckpointData2NV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods zero :: CheckpointData2NV Source #

Name

VK_NV_device_diagnostic_checkpoints

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

:: MonadIO io
=> Queue	`queue` is the `Queue` object the caller would like to retrieve checkpoint data for
-> io ("checkpointData" ::: Vector CheckpointDataNV)

QueueFamilyCheckpointPropertiesNV
Fields checkpointExecutionStageMask :: PipelineStageFlags `checkpointExecutionStageMask` is a mask indicating which pipeline stages the implementation can execute checkpoint markers in.

CheckpointDataNV
Fields stage :: PipelineStageFlagBits `stage` is a `PipelineStageFlagBits` value specifying which pipeline stage the checkpoint marker data refers to. checkpointMarker :: Ptr () `pCheckpointMarker` contains the value of the last checkpoint marker executed in the stage that `stage` refers to.

QueueFamilyCheckpointProperties2NV
Fields checkpointExecutionStageMask :: PipelineStageFlags2 `checkpointExecutionStageMask` is a mask indicating which pipeline stages the implementation can execute checkpoint markers in.

CheckpointData2NV
Fields stage :: PipelineStageFlags2 `stage` indicates a single pipeline stage which the checkpoint marker data refers to. checkpointMarker :: Ptr () `pCheckpointMarker` contains the value of the last checkpoint marker executed in the stage that `stage` refers to.