vulkan
Safe HaskellNone
LanguageHaskell2010

Vulkan.Extensions.VK_NV_ray_tracing

Description

Name

VK_NV_ray_tracing - device extension

VK_NV_ray_tracing

Name String
VK_NV_ray_tracing
Extension Type
Device extension
Registered Extension Number
166
Revision
3
Ratification Status
Not ratified
Extension and Version Dependencies

VK_KHR_get_physical_device_properties2      and

VK_KHR_get_memory_requirements2 or Vulkan Version 1.1

API Interactions
  • Interacts with VK_VERSION_1_1
  • Interacts with VK_EXT_debug_report
  • Interacts with VK_KHR_get_memory_requirements2
SPIR-V Dependencies
Deprecation State
Contact

Other Extension Metadata

Last Modified Date
2018-11-20
Interactions and External Dependencies
Contributors
  • Eric Werness, NVIDIA
  • Ashwin Lele, NVIDIA
  • Robert Stepinski, NVIDIA
  • Nuno Subtil, NVIDIA
  • Christoph Kubisch, NVIDIA
  • Martin Stich, NVIDIA
  • Daniel Koch, NVIDIA
  • Jeff Bolz, NVIDIA
  • Joshua Barczak, Intel
  • Tobias Hector, AMD
  • Henrik Rydgard, NVIDIA
  • Pascal Gautron, NVIDIA

Description

Rasterization has been the dominant method to produce interactive graphics, but increasing performance of graphics hardware has made ray tracing a viable option for interactive rendering. Being able to integrate ray tracing with traditional rasterization makes it easier for applications to incrementally add ray traced effects to existing applications or to do hybrid approaches with rasterization for primary visibility and ray tracing for secondary queries.

To enable ray tracing, this extension adds a few different categories of new functionality:

  • Acceleration structure objects and build commands
  • A new pipeline type with new shader domains
  • An indirection table to link shader groups with acceleration structure items

This extension adds support for the following SPIR-V extension in Vulkan:

  • SPV_NV_ray_tracing

New Object Types

New Commands

New Structures

If VK_KHR_get_memory_requirements2 or Vulkan Version 1.1 is supported:

New Enums

New Bitmasks

New Enum Constants

If VK_EXT_debug_report is supported:

New or Modified Built-In Variables

New SPIR-V Capabilities

Issues

1) Are there issues?

RESOLVED: Yes.

Sample Code

Example ray generation GLSL shader

#version 450 core
#extension GL_NV_ray_tracing : require
layout(set = 0, binding = 0, rgba8) uniform image2D image;
layout(set = 0, binding = 1) uniform accelerationStructureNV as;
layout(location = 0) rayPayloadNV float payload;

void main()
{
   vec4 col = vec4(0, 0, 0, 1);

   vec3 origin = vec3(float(gl_LaunchIDNV.x)/float(gl_LaunchSizeNV.x), float(gl_LaunchIDNV.y)/float(gl_LaunchSizeNV.y), 1.0);
   vec3 dir = vec3(0.0, 0.0, -1.0);

   traceNV(as, 0, 0xff, 0, 1, 0, origin, 0.0, dir, 1000.0, 0);

   col.y = payload;

   imageStore(image, ivec2(gl_LaunchIDNV.xy), col);
}

Version History

  • Revision 1, 2018-09-11 (Robert Stepinski, Nuno Subtil, Eric Werness)

    • Internal revisions
  • Revision 2, 2018-10-19 (Eric Werness)

    • rename to VK_NV_ray_tracing, add support for callables.
    • too many updates to list
  • Revision 3, 2018-11-20 (Daniel Koch)

    • update to use InstanceId instead of InstanceIndex as implemented.

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.

Synopsis

Documentation

compileDeferredNV Source #

Arguments

:: MonadIO io 
=> Device

device is the logical device containing the ray tracing pipeline.

device must be a valid Device handle

-> Pipeline

pipeline is the ray tracing pipeline object containing the shaders.

pipeline must be a ray tracing pipeline

pipeline must have been created with PIPELINE_CREATE_DEFER_COMPILE_BIT_NV

pipeline must be a valid Pipeline handle

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

-> ("shader" ::: Word32)

shader is the index of the shader to compile.

shader must not have been called as a deferred compile before

-> io () 

createAccelerationStructureNV Source #

Arguments

:: forall (a :: [Type]) io. (Extendss AccelerationStructureCreateInfoNV a, PokeChain a, MonadIO io) 
=> Device

device is the logical device that creates the buffer object.

-> AccelerationStructureCreateInfoNV a

pCreateInfo is a pointer to a AccelerationStructureCreateInfoNV structure containing parameters affecting creation of the acceleration structure.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io AccelerationStructureNV 

vkCreateAccelerationStructureNV - Create a new acceleration structure object

Description

Similarly to other objects in Vulkan, the acceleration structure creation merely creates an object with a specific “shape” as specified by the information in AccelerationStructureInfoNV and compactedSize in pCreateInfo.

Once memory has been bound to the acceleration structure using bindAccelerationStructureMemoryNV, that memory is populated by calls to cmdBuildAccelerationStructureNV and cmdCopyAccelerationStructureNV.

Acceleration structure creation uses the count and type information from the geometries, but does not use the data references in the structures.

Valid Usage (Implicit)

  • device must be a valid Device handle

Return Codes

Success
Failure

See Also

VK_NV_ray_tracing, AccelerationStructureCreateInfoNV, AccelerationStructureNV, AllocationCallbacks, Device

withAccelerationStructureNV :: forall (a :: [Type]) io r. (Extendss AccelerationStructureCreateInfoNV a, PokeChain a, MonadIO io) => Device -> AccelerationStructureCreateInfoNV a -> Maybe AllocationCallbacks -> (io AccelerationStructureNV -> (AccelerationStructureNV -> io ()) -> r) -> r Source #

A convenience wrapper to make a compatible pair of calls to createAccelerationStructureNV and destroyAccelerationStructureNV

To ensure that destroyAccelerationStructureNV is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyAccelerationStructureNV Source #

Arguments

:: MonadIO io 
=> Device

device is the logical device that destroys the buffer.

-> AccelerationStructureNV

accelerationStructure is the acceleration structure to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io () 

vkDestroyAccelerationStructureNV - Destroy an acceleration structure object

Valid Usage

  • All submitted commands that refer to accelerationStructure must have completed execution
  • If AllocationCallbacks were provided when accelerationStructure was created, a compatible set of callbacks must be provided here
  • If no AllocationCallbacks were provided when accelerationStructure was created, pAllocator must be NULL

Valid Usage (Implicit)

  • device must be a valid Device handle
  • If accelerationStructure is not NULL_HANDLE, accelerationStructure must be a valid AccelerationStructureNV handle
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
  • If accelerationStructure is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

  • Host access to accelerationStructure must be externally synchronized

See Also

VK_NV_ray_tracing, AccelerationStructureNV, AllocationCallbacks, Device

getAccelerationStructureMemoryRequirementsNV Source #

Arguments

:: forall (a :: [Type]) io. (Extendss MemoryRequirements2KHR a, PokeChain a, PeekChain a, MonadIO io) 
=> Device

device is the logical device on which the acceleration structure was created.

device must be a valid Device handle

-> AccelerationStructureMemoryRequirementsInfoNV

pInfo is a pointer to a AccelerationStructureMemoryRequirementsInfoNV structure specifying the acceleration structure to get memory requirements for.

pInfo must be a valid pointer to a valid AccelerationStructureMemoryRequirementsInfoNV structure

-> io (MemoryRequirements2KHR a) 

vkGetAccelerationStructureMemoryRequirementsNV - Get acceleration structure memory requirements

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureMemoryRequirementsInfoNV, Device, MemoryRequirements2

bindAccelerationStructureMemoryNV Source #

Arguments

:: MonadIO io 
=> Device

device is the logical device that owns the acceleration structures and memory.

device must be a valid Device handle

-> ("bindInfos" ::: Vector BindAccelerationStructureMemoryInfoNV)

pBindInfos is a pointer to an array of BindAccelerationStructureMemoryInfoNV structures describing acceleration structures and memory to bind.

pBindInfos must be a valid pointer to an array of bindInfoCount valid BindAccelerationStructureMemoryInfoNV structures

-> io () 

cmdCopyAccelerationStructureNV Source #

Arguments

:: MonadIO io 
=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> ("dst" ::: AccelerationStructureNV)

dst is the target acceleration structure for the copy.

-> ("src" ::: AccelerationStructureNV)

src is the source acceleration structure for the copy.

-> CopyAccelerationStructureModeKHR

mode is a CopyAccelerationStructureModeKHR value specifying additional operations to perform during the copy.

-> io () 

vkCmdCopyAccelerationStructureNV - Copy an acceleration structure

Description

Accesses to src and dst must be synchronized with the PIPELINE_STAGE_2_ACCELERATION_STRUCTURE_COPY_BIT_KHR pipeline stage or the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage, and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR or ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR as appropriate.

Valid Usage

Valid Usage (Implicit)

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 LevelsRender Pass ScopeVideo Coding ScopeSupported Queue TypesCommand Type
Primary SecondaryOutside Outside VK_QUEUE_COMPUTE_BIT Action

Conditional Rendering

vkCmdCopyAccelerationStructureNV is not affected by conditional rendering

See Also

VK_NV_ray_tracing, AccelerationStructureNV, CommandBuffer, CopyAccelerationStructureModeKHR

cmdWriteAccelerationStructuresPropertiesNV Source #

Arguments

:: MonadIO io 
=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> ("accelerationStructures" ::: Vector AccelerationStructureNV)

pAccelerationStructures is a pointer to an array of existing previously built acceleration structures.

-> QueryType

queryType is a QueryType value specifying the type of queries managed by the pool.

-> QueryPool

queryPool is the query pool that will manage the results of the query.

-> ("firstQuery" ::: Word32)

firstQuery is the first query index within the query pool that will contain the accelerationStructureCount number of results.

-> io () 

vkCmdWriteAccelerationStructuresPropertiesNV - Write acceleration structure result parameters to query results.

Description

Accesses to any of the acceleration structures listed in pAccelerationStructures must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR.

Valid Usage

  • queryPool must have been created with a queryType matching queryType

Valid Usage (Implicit)

  • pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid AccelerationStructureNV handles
  • queryType must be a valid QueryType value
  • queryPool must be a valid QueryPool handle
  • commandBuffer must be in the recording state
  • The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT operations
  • This command must only be called outside of a render pass instance
  • This command must not be called between suspended render pass instances
  • This command must only be called outside of a video coding scope
  • accelerationStructureCount must be greater than 0
  • Each of commandBuffer, queryPool, and the elements of pAccelerationStructures must have been created, allocated, or retrieved from the same Device

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 LevelsRender Pass ScopeVideo Coding ScopeSupported Queue TypesCommand Type
Primary SecondaryOutside Outside VK_QUEUE_COMPUTE_BIT Action

Conditional Rendering

vkCmdWriteAccelerationStructuresPropertiesNV is not affected by conditional rendering

See Also

VK_NV_ray_tracing, AccelerationStructureNV, CommandBuffer, QueryPool, QueryType

cmdBuildAccelerationStructureNV Source #

Arguments

:: MonadIO io 
=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> AccelerationStructureInfoNV

pInfo contains the shared information for the acceleration structure’s structure.

-> ("instanceData" ::: Buffer)

instanceData is the buffer containing an array of AccelerationStructureInstanceKHR structures defining acceleration structures. This parameter must be NULL for bottom level acceleration structures.

-> ("instanceOffset" ::: DeviceSize)

instanceOffset is the offset in bytes (relative to the start of instanceData) at which the instance data is located.

-> ("update" ::: Bool)

update specifies whether to update the dst acceleration structure with the data in src.

-> ("dst" ::: AccelerationStructureNV)

dst is a pointer to the target acceleration structure for the build.

-> ("src" ::: AccelerationStructureNV)

src is a pointer to an existing acceleration structure that is to be used to update the dst acceleration structure.

-> ("scratch" ::: Buffer)

scratch is the Buffer that will be used as scratch memory for the build.

-> ("scratchOffset" ::: DeviceSize)

scratchOffset is the offset in bytes relative to the start of scratch that will be used as a scratch memory.

-> io () 

vkCmdBuildAccelerationStructureNV - Build an acceleration structure

Description

Accesses to dst, src, and scratch must be synchronized with the PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR pipeline stage and an access type of ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR or ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR.

Valid Usage

Valid Usage (Implicit)

  • pInfo must be a valid pointer to a valid AccelerationStructureInfoNV structure
  • If instanceData is not NULL_HANDLE, instanceData must be a valid Buffer handle
  • dst must be a valid AccelerationStructureNV handle
  • If src is not NULL_HANDLE, src must be a valid AccelerationStructureNV handle
  • scratch must be a valid Buffer handle
  • commandBuffer must be in the recording state
  • The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT operations
  • This command must only be called outside of a render pass instance
  • This command must not be called between suspended render pass instances
  • This command must only be called outside of a video coding scope
  • Each of commandBuffer, dst, instanceData, scratch, and src that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

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 LevelsRender Pass ScopeVideo Coding ScopeSupported Queue TypesCommand Type
Primary SecondaryOutside Outside VK_QUEUE_COMPUTE_BIT Action

Conditional Rendering

vkCmdBuildAccelerationStructureNV is not affected by conditional rendering

See Also

VK_NV_ray_tracing, AccelerationStructureInfoNV, AccelerationStructureNV, Bool32, Buffer, CommandBuffer, DeviceSize

cmdTraceRaysNV Source #

Arguments

:: MonadIO io 
=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> ("raygenShaderBindingTableBuffer" ::: Buffer)

raygenShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the ray generation shader stage.

-> ("raygenShaderBindingOffset" ::: DeviceSize)

raygenShaderBindingOffset is the offset in bytes (relative to raygenShaderBindingTableBuffer) of the ray generation shader being used for the trace.

-> ("missShaderBindingTableBuffer" ::: Buffer)

missShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the miss shader stage.

-> ("missShaderBindingOffset" ::: DeviceSize)

missShaderBindingOffset is the offset in bytes (relative to missShaderBindingTableBuffer) of the miss shader being used for the trace.

-> ("missShaderBindingStride" ::: DeviceSize)

missShaderBindingStride is the size in bytes of each shader binding table record in missShaderBindingTableBuffer.

-> ("hitShaderBindingTableBuffer" ::: Buffer)

hitShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the hit shader stages.

-> ("hitShaderBindingOffset" ::: DeviceSize)

hitShaderBindingOffset is the offset in bytes (relative to hitShaderBindingTableBuffer) of the hit shader group being used for the trace.

-> ("hitShaderBindingStride" ::: DeviceSize)

hitShaderBindingStride is the size in bytes of each shader binding table record in hitShaderBindingTableBuffer.

-> ("callableShaderBindingTableBuffer" ::: Buffer)

callableShaderBindingTableBuffer is the buffer object that holds the shader binding table data for the callable shader stage.

-> ("callableShaderBindingOffset" ::: DeviceSize)

callableShaderBindingOffset is the offset in bytes (relative to callableShaderBindingTableBuffer) of the callable shader being used for the trace.

-> ("callableShaderBindingStride" ::: DeviceSize)

callableShaderBindingStride is the size in bytes of each shader binding table record in callableShaderBindingTableBuffer.

-> ("width" ::: Word32)

width is the width of the ray trace query dimensions.

-> ("height" ::: Word32)

height is height of the ray trace query dimensions.

-> ("depth" ::: Word32)

depth is depth of the ray trace query dimensions.

-> io () 

vkCmdTraceRaysNV - Initialize a ray tracing dispatch

Description

When the command is executed, a ray generation group of width × height × depth rays is assembled.

Valid Usage

Valid Usage (Implicit)

  • raygenShaderBindingTableBuffer must be a valid Buffer handle
  • If missShaderBindingTableBuffer is not NULL_HANDLE, missShaderBindingTableBuffer must be a valid Buffer handle
  • If hitShaderBindingTableBuffer is not NULL_HANDLE, hitShaderBindingTableBuffer must be a valid Buffer handle
  • If callableShaderBindingTableBuffer is not NULL_HANDLE, callableShaderBindingTableBuffer must be a valid Buffer handle
  • commandBuffer must be in the recording state
  • The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT operations
  • This command must only be called outside of a render pass instance
  • This command must not be called between suspended render pass instances
  • This command must only be called outside of a video coding scope
  • Each of callableShaderBindingTableBuffer, commandBuffer, hitShaderBindingTableBuffer, missShaderBindingTableBuffer, and raygenShaderBindingTableBuffer that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

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 LevelsRender Pass ScopeVideo Coding ScopeSupported Queue TypesCommand Type
Primary SecondaryOutside Outside VK_QUEUE_COMPUTE_BIT Action

Conditional Rendering

vkCmdTraceRaysNV is not affected by conditional rendering

See Also

VK_NV_ray_tracing, Buffer, CommandBuffer, DeviceSize

getAccelerationStructureHandleNV Source #

Arguments

:: MonadIO io 
=> Device

device is the logical device that owns the acceleration structures.

device must be a valid Device handle

-> AccelerationStructureNV

accelerationStructure is the acceleration structure.

accelerationStructure must be bound completely and contiguously to a single DeviceMemory object via bindAccelerationStructureMemoryNV

accelerationStructure must be a valid AccelerationStructureNV handle

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

-> ("dataSize" ::: Word64)

dataSize is the size in bytes of the buffer pointed to by pData.

dataSize must be large enough to contain the result of the query, as described above

dataSize must be greater than 0

-> ("data" ::: Ptr ())

pData is a pointer to an application-allocated buffer where the results will be written.

pData must be a valid pointer to an array of dataSize bytes

-> io () 

createRayTracingPipelinesNV Source #

Arguments

:: MonadIO io 
=> Device

device is the logical device that creates the ray tracing pipelines.

-> PipelineCache

pipelineCache is either NULL_HANDLE, indicating that pipeline caching is disabled, or to enable caching, the handle of a valid PipelineCache object. The implementation must not access this object outside of the duration of this command.

-> ("createInfos" ::: Vector (SomeStruct RayTracingPipelineCreateInfoNV))

pCreateInfos is a pointer to an array of RayTracingPipelineCreateInfoNV structures.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io (Result, "pipelines" ::: Vector Pipeline) 

vkCreateRayTracingPipelinesNV - Creates a new ray tracing pipeline object

Description

Pipelines are created and returned as described for Multiple Pipeline Creation.

Valid Usage

Valid Usage (Implicit)

  • device must be a valid Device handle
  • If pipelineCache is not NULL_HANDLE, pipelineCache must be a valid PipelineCache handle
  • pCreateInfos must be a valid pointer to an array of createInfoCount valid RayTracingPipelineCreateInfoNV structures
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
  • pPipelines must be a valid pointer to an array of createInfoCount Pipeline handles
  • createInfoCount must be greater than 0
  • If pipelineCache is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

Success
Failure

See Also

VK_NV_ray_tracing, AllocationCallbacks, Device, Pipeline, PipelineCache, RayTracingPipelineCreateInfoNV

withRayTracingPipelinesNV :: MonadIO io => Device -> PipelineCache -> Vector (SomeStruct RayTracingPipelineCreateInfoNV) -> Maybe AllocationCallbacks -> (io (Result, Vector Pipeline) -> ((Result, Vector Pipeline) -> io ()) -> r) -> r Source #

A convenience wrapper to make a compatible pair of calls to createRayTracingPipelinesNV and destroyPipeline

To ensure that destroyPipeline is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

getRayTracingShaderGroupHandlesNV :: MonadIO io => Device -> Pipeline -> ("firstGroup" ::: Word32) -> ("groupCount" ::: Word32) -> ("dataSize" ::: Word64) -> ("data" ::: Ptr ()) -> io () Source #

data RayTracingShaderGroupCreateInfoNV Source #

VkRayTracingShaderGroupCreateInfoNV - Structure specifying shaders in a shader group

Valid Usage

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, RayTracingPipelineCreateInfoNV, RayTracingShaderGroupTypeKHR, StructureType

Constructors

RayTracingShaderGroupCreateInfoNV 

Fields

Instances

Instances details
Eq RayTracingShaderGroupCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Storable RayTracingShaderGroupCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show RayTracingShaderGroupCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

FromCStruct RayTracingShaderGroupCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

ToCStruct RayTracingShaderGroupCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero RayTracingShaderGroupCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data RayTracingPipelineCreateInfoNV (es :: [Type]) Source #

VkRayTracingPipelineCreateInfoNV - Structure specifying parameters of a newly created ray tracing pipeline

Description

The parameters basePipelineHandle and basePipelineIndex are described in more detail in Pipeline Derivatives.

If the pNext chain includes a PipelineCreateFlags2CreateInfo structure, PipelineCreateFlags2CreateInfo::flags from that structure is used instead of flags from this structure.

Valid Usage

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, Pipeline, PipelineCreateFlags, PipelineLayout, PipelineShaderStageCreateInfo, RayTracingShaderGroupCreateInfoNV, StructureType, createRayTracingPipelinesNV

Constructors

RayTracingPipelineCreateInfoNV 

Fields

Instances

Instances details
Extensible RayTracingPipelineCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

extensibleTypeName :: String Source #

getNext :: forall (es :: [Type]). RayTracingPipelineCreateInfoNV es -> Chain es Source #

setNext :: forall (ds :: [Type]) (es :: [Type]). RayTracingPipelineCreateInfoNV ds -> Chain es -> RayTracingPipelineCreateInfoNV es Source #

extends :: forall e b proxy. Typeable e => proxy e -> (Extends RayTracingPipelineCreateInfoNV e => b) -> Maybe b Source #

Show (Chain es) => Show (RayTracingPipelineCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

(Extendss RayTracingPipelineCreateInfoNV es, PeekChain es) => FromCStruct (RayTracingPipelineCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

(Extendss RayTracingPipelineCreateInfoNV es, PokeChain es) => ToCStruct (RayTracingPipelineCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

es ~ ('[] :: [Type]) => Zero (RayTracingPipelineCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data GeometryTrianglesNV Source #

VkGeometryTrianglesNV - Structure specifying a triangle geometry in a bottom-level acceleration structure

Description

If indexType is INDEX_TYPE_NONE_NV, then this structure describes a set of triangles determined by vertexCount. Otherwise, this structure describes a set of indexed triangles determined by indexCount.

Valid Usage

  • vertexOffset must be less than the size of vertexData

Valid Usage (Implicit)

  • pNext must be NULL
  • If vertexData is not NULL_HANDLE, vertexData must be a valid Buffer handle
  • vertexFormat must be a valid Format value
  • If indexData is not NULL_HANDLE, indexData must be a valid Buffer handle
  • indexType must be a valid IndexType value
  • If transformData is not NULL_HANDLE, transformData must be a valid Buffer handle
  • Each of indexData, transformData, and vertexData that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_NV_ray_tracing, Buffer, DeviceSize, Format, GeometryDataNV, IndexType, StructureType

Constructors

GeometryTrianglesNV 

Fields

Instances

Instances details
Eq GeometryTrianglesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Storable GeometryTrianglesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show GeometryTrianglesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

FromCStruct GeometryTrianglesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

ToCStruct GeometryTrianglesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero GeometryTrianglesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data GeometryAABBNV Source #

VkGeometryAABBNV - Structure specifying axis-aligned bounding box geometry in a bottom-level acceleration structure

Description

The AABB data in memory is six 32-bit floats consisting of the minimum x, y, and z values followed by the maximum x, y, and z values.

Valid Usage

  • offset must be less than the size of aabbData
  • offset must be a multiple of 8
  • stride must be a multiple of 8

Valid Usage (Implicit)

  • pNext must be NULL
  • If aabbData is not NULL_HANDLE, aabbData must be a valid Buffer handle

See Also

VK_NV_ray_tracing, Buffer, DeviceSize, GeometryDataNV, StructureType

Constructors

GeometryAABBNV 

Fields

  • aabbData :: Buffer

    aabbData is the buffer containing axis-aligned bounding box data.

  • numAABBs :: Word32

    numAABBs is the number of AABBs in this geometry.

  • stride :: Word32

    stride is the stride in bytes between AABBs in aabbData.

  • offset :: DeviceSize

    offset is the offset in bytes of the first AABB in aabbData.

Instances

Instances details
Eq GeometryAABBNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Storable GeometryAABBNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show GeometryAABBNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

FromCStruct GeometryAABBNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

ToCStruct GeometryAABBNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero GeometryAABBNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data GeometryDataNV Source #

VkGeometryDataNV - Structure specifying geometry in a bottom-level acceleration structure

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, GeometryAABBNV, GeometryNV, GeometryTrianglesNV

Constructors

GeometryDataNV 

Fields

Instances

Instances details
Storable GeometryDataNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show GeometryDataNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

FromCStruct GeometryDataNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

ToCStruct GeometryDataNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero GeometryDataNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data GeometryNV Source #

VkGeometryNV - Structure specifying a geometry in a bottom-level acceleration structure

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureInfoNV, GeometryDataNV, GeometryFlagsKHR, GeometryTypeKHR, StructureType

Constructors

GeometryNV 

Fields

data AccelerationStructureInfoNV Source #

VkAccelerationStructureInfoNV - Structure specifying the parameters of acceleration structure object

Description

AccelerationStructureInfoNV contains information that is used both for acceleration structure creation with createAccelerationStructureNV and in combination with the actual geometric data to build the acceleration structure with cmdBuildAccelerationStructureNV.

Valid Usage

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureCreateInfoNV, AccelerationStructureTypeKHR, BuildAccelerationStructureFlagsKHR, GeometryNV, StructureType, cmdBuildAccelerationStructureNV

Constructors

AccelerationStructureInfoNV 

Fields

data AccelerationStructureCreateInfoNV (es :: [Type]) Source #

VkAccelerationStructureCreateInfoNV - Structure specifying the parameters of a newly created acceleration structure object

Valid Usage

  • If compactedSize is not 0 then both info.geometryCount and info.instanceCount must be 0

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureInfoNV, DeviceSize, StructureType, createAccelerationStructureNV

Constructors

AccelerationStructureCreateInfoNV 

Fields

Instances

Instances details
Extensible AccelerationStructureCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show (Chain es) => Show (AccelerationStructureCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

(Extendss AccelerationStructureCreateInfoNV es, PeekChain es) => FromCStruct (AccelerationStructureCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

(Extendss AccelerationStructureCreateInfoNV es, PokeChain es) => ToCStruct (AccelerationStructureCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

es ~ ('[] :: [Type]) => Zero (AccelerationStructureCreateInfoNV es) Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data BindAccelerationStructureMemoryInfoNV Source #

VkBindAccelerationStructureMemoryInfoNV - Structure specifying acceleration structure memory binding

Valid Usage

  • accelerationStructure must not already be backed by a memory object

Valid Usage (Implicit)

  • pNext must be NULL
  • accelerationStructure must be a valid AccelerationStructureNV handle
  • memory must be a valid DeviceMemory handle
  • If deviceIndexCount is not 0, pDeviceIndices must be a valid pointer to an array of deviceIndexCount uint32_t values
  • Both of accelerationStructure, and memory must have been created, allocated, or retrieved from the same Device

See Also

VK_NV_ray_tracing, AccelerationStructureNV, DeviceMemory, DeviceSize, StructureType, bindAccelerationStructureMemoryNV

Constructors

BindAccelerationStructureMemoryInfoNV 

Fields

data WriteDescriptorSetAccelerationStructureNV Source #

VkWriteDescriptorSetAccelerationStructureNV - Structure specifying acceleration structure descriptor information

Valid Usage

Valid Usage (Implicit)

  • pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid or NULL_HANDLE AccelerationStructureNV handles
  • accelerationStructureCount must be greater than 0

See Also

VK_NV_ray_tracing, AccelerationStructureNV, StructureType

Constructors

WriteDescriptorSetAccelerationStructureNV 

Fields

data AccelerationStructureMemoryRequirementsInfoNV Source #

VkAccelerationStructureMemoryRequirementsInfoNV - Structure specifying acceleration to query for memory requirements

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureMemoryRequirementsTypeNV, AccelerationStructureNV, StructureType, getAccelerationStructureMemoryRequirementsNV

Constructors

AccelerationStructureMemoryRequirementsInfoNV 

Fields

Instances

Instances details
Eq AccelerationStructureMemoryRequirementsInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Storable AccelerationStructureMemoryRequirementsInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show AccelerationStructureMemoryRequirementsInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

FromCStruct AccelerationStructureMemoryRequirementsInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

ToCStruct AccelerationStructureMemoryRequirementsInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero AccelerationStructureMemoryRequirementsInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

data PhysicalDeviceRayTracingPropertiesNV Source #

VkPhysicalDeviceRayTracingPropertiesNV - Properties of the physical device for ray tracing

Description

Due to the fact that the geometry, instance, and triangle counts are specified at acceleration structure creation as 32-bit values, maxGeometryCount, maxInstanceCount, and maxTriangleCount must not exceed 232-1.

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

Limits specified by this structure must match those specified with the same name in PhysicalDeviceAccelerationStructurePropertiesKHR and PhysicalDeviceRayTracingPipelinePropertiesKHR.

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, StructureType

Constructors

PhysicalDeviceRayTracingPropertiesNV 

Fields

Instances

Instances details
Eq PhysicalDeviceRayTracingPropertiesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Storable PhysicalDeviceRayTracingPropertiesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show PhysicalDeviceRayTracingPropertiesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

FromCStruct PhysicalDeviceRayTracingPropertiesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

ToCStruct PhysicalDeviceRayTracingPropertiesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero PhysicalDeviceRayTracingPropertiesNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

newtype AccelerationStructureMemoryRequirementsTypeNV Source #

VkAccelerationStructureMemoryRequirementsTypeNV - Acceleration structure memory requirement type

Description

See Also

VK_NV_ray_tracing, AccelerationStructureMemoryRequirementsInfoNV

Instances

Instances details
Eq AccelerationStructureMemoryRequirementsTypeNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Ord AccelerationStructureMemoryRequirementsTypeNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Storable AccelerationStructureMemoryRequirementsTypeNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Read AccelerationStructureMemoryRequirementsTypeNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Show AccelerationStructureMemoryRequirementsTypeNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Zero AccelerationStructureMemoryRequirementsTypeNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_ray_tracing

type NV_RAY_TRACING_EXTENSION_NAME = "VK_NV_ray_tracing" Source #

newtype AccelerationStructureNV Source #

Instances

Instances details
Eq AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Ord AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Storable AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Show AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

HasObjectType AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

IsHandle AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Zero AccelerationStructureNV Source # 
Instance details

Defined in Vulkan.Extensions.Handles

data AabbPositionsKHR Source #

VkAabbPositionsKHR - Structure specifying two opposing corners of an axis-aligned bounding box

Valid Usage

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing

Constructors

AabbPositionsKHR 

Fields

  • minX :: Float

    minX is the x position of one opposing corner of a bounding box.

    minX must be less than or equal to maxX

  • minY :: Float

    minY is the y position of one opposing corner of a bounding box.

    minY must be less than or equal to maxY

  • minZ :: Float

    minZ is the z position of one opposing corner of a bounding box.

    minZ must be less than or equal to maxZ

  • maxX :: Float

    maxX is the x position of the other opposing corner of a bounding box.

  • maxY :: Float

    maxY is the y position of the other opposing corner of a bounding box.

  • maxZ :: Float

    maxZ is the z position of the other opposing corner of a bounding box.

Instances

Instances details
Eq AabbPositionsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable AabbPositionsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show AabbPositionsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

FromCStruct AabbPositionsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

ToCStruct AabbPositionsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero AabbPositionsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

data TransformMatrixKHR Source #

VkTransformMatrixKHR - Structure specifying a 3x4 affine transformation matrix

Valid Usage

  • The first three columns of matrix must define an invertible 3x3 matrix

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureInstanceKHR, AccelerationStructureMatrixMotionInstanceNV, VkPartitionedAccelerationStructureWriteInstanceDataNV

Instances

Instances details
Eq TransformMatrixKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable TransformMatrixKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show TransformMatrixKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

FromCStruct TransformMatrixKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

ToCStruct TransformMatrixKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero TransformMatrixKHR Source #

The Identity Matrix

Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

data AccelerationStructureInstanceKHR Source #

VkAccelerationStructureInstanceKHR - Structure specifying a single acceleration structure instance for building into an acceleration structure geometry

Description

The C language specification does not define the ordering of bit-fields, but in practice, this structure produces the correct layout with existing compilers. The intended bit pattern is for the following:

If a compiler produces code that diverges from that pattern, applications must employ another method to set values according to the correct bit pattern.

Valid Usage (Implicit)

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureMotionInstanceDataNV, GeometryInstanceFlagsKHR, TransformMatrixKHR

Constructors

AccelerationStructureInstanceKHR 

Fields

Instances

Instances details
Storable AccelerationStructureInstanceKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show AccelerationStructureInstanceKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

FromCStruct AccelerationStructureInstanceKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

ToCStruct AccelerationStructureInstanceKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero AccelerationStructureInstanceKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

getRayTracingShaderGroupHandlesKHR Source #

Arguments

:: MonadIO io 
=> Device

device is the logical device containing the ray tracing pipeline.

-> Pipeline

pipeline is the ray tracing pipeline object containing the shaders.

-> ("firstGroup" ::: Word32)

firstGroup is the index of the first group to retrieve a handle for from the RayTracingPipelineCreateInfoKHR::pGroups or RayTracingPipelineCreateInfoNV::pGroups array.

-> ("groupCount" ::: Word32)

groupCount is the number of shader handles to retrieve.

-> ("dataSize" ::: Word64)

dataSize is the size in bytes of the buffer pointed to by pData.

-> ("data" ::: Ptr ())

pData is a pointer to an application-allocated buffer where the results will be written.

-> io () 

vkGetRayTracingShaderGroupHandlesKHR - Query ray tracing pipeline shader group handles

Description

On success, an array of groupCount shader handles will be written to pData, with each element being of size PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleSize.

If pipeline was created with PIPELINE_CREATE_LIBRARY_BIT_KHR and the pipelineLibraryGroupHandles feature is enabled applications can query group handles from that pipeline, even if the pipeline is a library and is never bound to a command buffer. These group handles remain bitwise identical for any pipeline which references the pipeline library. Group indices are assigned as-if the pipeline was created without PIPELINE_CREATE_LIBRARY_BIT_KHR.

Valid Usage

  • pipeline must be a ray tracing pipeline

Valid Usage (Implicit)

  • device must be a valid Device handle
  • pipeline must be a valid Pipeline handle
  • pData must be a valid pointer to an array of dataSize bytes
  • dataSize must be greater than 0
  • pipeline must have been created, allocated, or retrieved from device

Return Codes

Success
Failure

See Also

VK_KHR_ray_tracing_pipeline, VK_NV_ray_tracing, Device, Pipeline

newtype DebugReportObjectTypeEXT Source #

VkDebugReportObjectTypeEXT - Specify the type of an object handle

Description

'

DebugReportObjectTypeEXTVulkan Handle Type
DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXTUnknown/Undefined Handle
DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXTInstance
DEBUG_REPORT_OBJECT_TYPE_PHYSICAL_DEVICE_EXTPhysicalDevice
DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXTDevice
DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXTQueue
DEBUG_REPORT_OBJECT_TYPE_SEMAPHORE_EXTSemaphore
DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXTCommandBuffer
DEBUG_REPORT_OBJECT_TYPE_FENCE_EXTFence
DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXTDeviceMemory
DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXTBuffer
DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXTImage
DEBUG_REPORT_OBJECT_TYPE_EVENT_EXTEvent
DEBUG_REPORT_OBJECT_TYPE_QUERY_POOL_EXTQueryPool
DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXTBufferView
DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXTImageView
DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXTShaderModule
DEBUG_REPORT_OBJECT_TYPE_PIPELINE_CACHE_EXTPipelineCache
DEBUG_REPORT_OBJECT_TYPE_PIPELINE_LAYOUT_EXTPipelineLayout
DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXTRenderPass
DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXTPipeline
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXTDescriptorSetLayout
DEBUG_REPORT_OBJECT_TYPE_SAMPLER_EXTSampler
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXTDescriptorPool
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXTDescriptorSet
DEBUG_REPORT_OBJECT_TYPE_FRAMEBUFFER_EXTFramebuffer
DEBUG_REPORT_OBJECT_TYPE_COMMAND_POOL_EXTCommandPool
DEBUG_REPORT_OBJECT_TYPE_SURFACE_KHR_EXTSurfaceKHR
DEBUG_REPORT_OBJECT_TYPE_SWAPCHAIN_KHR_EXTSwapchainKHR
DEBUG_REPORT_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT_EXTDebugReportCallbackEXT
DEBUG_REPORT_OBJECT_TYPE_DISPLAY_KHR_EXTDisplayKHR
DEBUG_REPORT_OBJECT_TYPE_DISPLAY_MODE_KHR_EXTDisplayModeKHR
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_EXTDescriptorUpdateTemplate

DebugReportObjectTypeEXT and Vulkan Handle Relationship

The primary expected use of ERROR_VALIDATION_FAILED_EXT is for validation layer testing to prevent invalid commands from reaching the ICD. It is not expected that an application would see this error code during normal use of the validation layers. If an application returns TRUE in DebugUtilsMessengerCallbackDataEXT, the validation layers will return this error code instead of passing the command down the dispatch chain.

See Also

PFN_vkDebugReportCallbackEXT, VK_EXT_debug_marker, VK_EXT_debug_report, DebugMarkerObjectNameInfoEXT, DebugMarkerObjectTagInfoEXT, debugReportMessageEXT

Bundled Patterns

pattern DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_NV_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_BUFFER_COLLECTION_FUCHSIA_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_COMMAND_POOL_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_CUDA_FUNCTION_NV_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_CUDA_MODULE_NV_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_CU_FUNCTION_NVX_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_CU_MODULE_NVX_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DISPLAY_KHR_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_DISPLAY_MODE_KHR_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_EVENT_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_FENCE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_FRAMEBUFFER_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_PHYSICAL_DEVICE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_PIPELINE_CACHE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_PIPELINE_LAYOUT_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_QUERY_POOL_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_SAMPLER_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_SEMAPHORE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_SURFACE_KHR_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_SWAPCHAIN_KHR_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT :: DebugReportObjectTypeEXT 
pattern DEBUG_REPORT_OBJECT_TYPE_VALIDATION_CACHE_EXT_EXT :: DebugReportObjectTypeEXT 

Instances

Instances details
Eq DebugReportObjectTypeEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_debug_report

Ord DebugReportObjectTypeEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_debug_report

Storable DebugReportObjectTypeEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_debug_report

Read DebugReportObjectTypeEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_debug_report

Show DebugReportObjectTypeEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_debug_report

Zero DebugReportObjectTypeEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_debug_report

newtype GeometryInstanceFlagBitsKHR Source #

VkGeometryInstanceFlagBitsKHR - Instance flag bits

Description

GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR and GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR must not be used in the same flag.

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, GeometryInstanceFlagsKHR

Instances

Instances details
Bits GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(.&.) :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR #

(.|.) :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR #

xor :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR #

complement :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR #

shift :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

rotate :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

zeroBits :: GeometryInstanceFlagBitsKHR #

bit :: Int -> GeometryInstanceFlagBitsKHR #

setBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

clearBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

complementBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

testBit :: GeometryInstanceFlagBitsKHR -> Int -> Bool #

bitSizeMaybe :: GeometryInstanceFlagBitsKHR -> Maybe Int #

bitSize :: GeometryInstanceFlagBitsKHR -> Int #

isSigned :: GeometryInstanceFlagBitsKHR -> Bool #

shiftL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

unsafeShiftL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

shiftR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

unsafeShiftR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

rotateL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

rotateR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR #

popCount :: GeometryInstanceFlagBitsKHR -> Int #

FiniteBits GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Eq GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Ord GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Read GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero GeometryInstanceFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

newtype GeometryFlagBitsKHR Source #

VkGeometryFlagBitsKHR - Bitmask specifying additional parameters for a geometry

Description

  • GEOMETRY_OPAQUE_BIT_KHR specifies that this geometry does not invoke the any-hit shaders even if present in a hit group.
  • GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_KHR specifies that the implementation must only call the any-hit shader a single time for each primitive in this geometry. If this bit is absent an implementation may invoke the any-hit shader more than once for this geometry.

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, GeometryFlagsKHR

Instances

Instances details
Bits GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

FiniteBits GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Eq GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Ord GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Read GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero GeometryFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

newtype BuildAccelerationStructureFlagBitsKHR Source #

VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds

Description

BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR and BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR may take more time and memory than a normal build, and so should only be used when those features are needed.

BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR and BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR are allowed to be used together. In that case, the result of the compaction copy is used as the source of a build with mode of BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR to perform the compacted update.

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, BuildAccelerationStructureFlagsKHR

Instances

Instances details
Bits BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(.&.) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR #

(.|.) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR #

xor :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR #

complement :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR #

shift :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

rotate :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

zeroBits :: BuildAccelerationStructureFlagBitsKHR #

bit :: Int -> BuildAccelerationStructureFlagBitsKHR #

setBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

clearBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

complementBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

testBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> Bool #

bitSizeMaybe :: BuildAccelerationStructureFlagBitsKHR -> Maybe Int #

bitSize :: BuildAccelerationStructureFlagBitsKHR -> Int #

isSigned :: BuildAccelerationStructureFlagBitsKHR -> Bool #

shiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

unsafeShiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

shiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

unsafeShiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

rotateL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

rotateR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR #

popCount :: BuildAccelerationStructureFlagBitsKHR -> Int #

FiniteBits BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Eq BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Ord BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Read BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero BuildAccelerationStructureFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

newtype CopyAccelerationStructureModeKHR Source #

VkCopyAccelerationStructureModeKHR - Acceleration structure copy mode

Description

  • COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR creates a direct copy of the acceleration structure specified in src into the one specified by dst. The dst acceleration structure must have been created with the same parameters as src. If src contains references to other acceleration structures, dst will reference the same acceleration structures.

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, CopyAccelerationStructureInfoKHR, CopyAccelerationStructureToMemoryInfoKHR, CopyMemoryToAccelerationStructureInfoKHR, cmdCopyAccelerationStructureNV

Instances

Instances details
Eq CopyAccelerationStructureModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Ord CopyAccelerationStructureModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable CopyAccelerationStructureModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Read CopyAccelerationStructureModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show CopyAccelerationStructureModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero CopyAccelerationStructureModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

newtype AccelerationStructureTypeKHR Source #

VkAccelerationStructureTypeKHR - Type of acceleration structure

Description

  • ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR is a bottom-level acceleration structure containing the AABBs or geometry to be intersected.
  • ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR is an acceleration structure whose type is determined at build time used for special circumstances. In these cases, the acceleration structure type is not known at creation time, but must be specified at build time as either top or bottom.

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureCreateInfoKHR, AccelerationStructureInfoNV

Instances

Instances details
Eq AccelerationStructureTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Ord AccelerationStructureTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable AccelerationStructureTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Read AccelerationStructureTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show AccelerationStructureTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero AccelerationStructureTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

newtype GeometryTypeKHR Source #

VkGeometryTypeKHR - Enum specifying which type of geometry is provided

Description

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureGeometryKHR, GeometryNV

Constructors

GeometryTypeKHR Int32 

Instances

Instances details
Eq GeometryTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Ord GeometryTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Storable GeometryTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Read GeometryTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Show GeometryTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Zero GeometryTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

newtype RayTracingShaderGroupTypeKHR Source #

VkRayTracingShaderGroupTypeKHR - Shader group types

Description

For current group types, the hit group type could be inferred from the presence or absence of the intersection shader, but we provide the type explicitly for future hit groups that do not have that property.

See Also

VK_KHR_ray_tracing_pipeline, VK_NV_ray_tracing, RayTracingShaderGroupCreateInfoKHR, RayTracingShaderGroupCreateInfoNV

Instances

Instances details
Eq RayTracingShaderGroupTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Ord RayTracingShaderGroupTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Storable RayTracingShaderGroupTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Read RayTracingShaderGroupTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Show RayTracingShaderGroupTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Zero RayTracingShaderGroupTypeKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

type SHADER_UNUSED_KHR = 4294967295 Source #

pattern SHADER_UNUSED_KHR :: Word32 Source #

VK_SHADER_UNUSED_KHR - Sentinel for an unused shader index

See Also

VK_KHR_ray_tracing_pipeline, VK_NV_ray_tracing