HORIZON HASKELLDocslts/ghc-10.0.x8174fa42026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8174fa4 · 2026-10-11

Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_KHR_shader_abort

Name

VK_KHR_shader_abort - device extension

VK_KHR_shader_abort

Name String

VK_KHR_shader_abort

Extension Type

Device extension

Registered Extension Number

234

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_device_fault

and

VK_KHR_shader_constant_data

SPIR-V Dependencies
Contact
Extension Proposal

VK_KHR_shader_abort

Other Extension Metadata

Last Modified Date

2026-03-18

IP Status

No known IP claims.

Contributors
  • Tobias Hector, AMD

  • Piers Daniell, Nvidia

  • Craig Graham, Samsung

  • Erik Hogeman, ARM

  • Ralph Potter, Samsung

  • Vikram Tarikere, IMG

Description

This extension enables the use of the OpAbortKHR instruction in shaders.

New Structures

New Enum Constants

Version History

  • Revision 1, 2024-08-22 (Tobias Hector)

    • Initial revision

See Also

No cross-references are available

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.

  • 5 types
  • Packagevulkan-3.27
  • Exports7
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceVK_KHR_shader_abort.hs

VkPhysicalDeviceShaderAbortFeaturesKHR - Structure describing whether shader abort is supported or not

Members

This structure describes the following feature:

Description

If the PhysicalDeviceShaderAbortFeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceShaderAbortFeaturesKHR, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

See Also

VK_KHR_shader_abort, Bool32, StructureType

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkPhysicalDeviceShaderAbortPropertiesKHR - Structure describing the maximum size of a shader abort message

Members

The PhysicalDeviceShaderAbortPropertiesKHR structure describes the following:

Description

If the PhysicalDeviceShaderAbortPropertiesKHR structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Structure Chaining

Extends the structure

See Also

VK_KHR_shader_abort, StructureType

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkDeviceFaultShaderAbortMessageInfoKHR - Structure specifying message data from OpAbortKHR

Description

This structure can be included in the pNext chain of DeviceFaultDebugInfoKHR to retrieve messages returned by OpAbortKHR instructions.

pMessageData is populated with a series of (size,payload) pairs, each aligned to 8-byte boundaries. The size in each pair is a 64-bit integer indicating the number of bytes in the subsequent payload. The data in payload is laid out in the exact manner specified in the OpAbortKHR instruction by the message type, with no modifications. If multiple messages are present, the next message size will always be at the following 8-byte aligned offset after the payload ends.

Implementations must report the message reported by the first OpAbortKHR instruction executed in an invocation for this device. They may report additional messages if other invocations continued to execute after the abort instruction was executed.

Even though shading languages may provide definitions for printf-style abort commands, no formatting is performed by the Vulkan implementation. Applications should consult documentation for the shader language they are using on how abort messages are packed, so that they can unpack them after they are queried.

Structure Chaining

Extends the structure

See Also

VK_KHR_shader_abort, StructureType

Constructors

  • DeviceFaultShaderAbortMessageInfoKHR
    • messageDataSize :: Word64

      messageDataSize is the size of pMessageData in bytes. If pMessageData is NULL, this value is populated by the implementation.

    • messageData :: Ptr ()

      pMessageData is NULL or a pointer to messageDataSize bytes of data, which will be populated with data for messages reported via OpAbortKHR. If pMessageData is NULL then messageDataSize will be populated with the required size.

Instances5Show, Storable, FromCStruct, ToCStruct, Zero