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

Extension and Version Dependencies

Requires Vulkan 1.0
Requires VK_KHR_get_physical_device_properties2

Contact

Nuno Subtil https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_NV_device_diagnostic_checkpoints:%20&body=@nsubtil%20

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

New Structures

CheckpointDataNV

Extending QueueFamilyProperties2:
- QueueFamilyCheckpointPropertiesNV

New Enum Constants

NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME

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 :: forall io. MonadIO io => CommandBuffer -> ("checkpointMarker" ::: Ptr ()) -> io ()
getQueueCheckpointDataNV :: forall io. MonadIO io => Queue -> io ("checkpointData" ::: Vector CheckpointDataNV)
data QueueFamilyCheckpointPropertiesNV = QueueFamilyCheckpointPropertiesNV {
- checkpointExecutionStageMask :: PipelineStageFlags
}
data CheckpointDataNV = CheckpointDataNV {
- stage :: PipelineStageFlagBits
- checkpointMarker :: Ptr ()
}
type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION = 2
pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION :: forall a. Integral a => a
type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME = "VK_NV_device_diagnostic_checkpoints"
pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

cmdSetCheckpointNV Source #

Arguments

:: forall io. 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 graphics, compute, or transfer operations

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	Supported Queue Types	Pipeline Type
Primary Secondary	Both	Graphics Compute Transfer

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

Eq QueueFamilyCheckpointPropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints Methods (==) :: QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> Bool # (/=) :: QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> Bool #
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 #
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 () #
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 #

data CheckpointDataNV Source #

VkCheckpointDataNV - return structure for command buffer checkpoint data

Description

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

Valid Usage (Implicit)

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 #
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 () #
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 #

type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION = 2 Source #

pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION :: forall a. Integral a => a Source #

type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME = "VK_NV_device_diagnostic_checkpoints" Source #

pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a 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

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

:: forall io. 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` indicates 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.