Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Name

VK_KHR_ray_tracing_pipeline - device extension

VK_KHR_ray_tracing_pipeline

Name String

VK_KHR_ray_tracing_pipeline

Extension Type

Device extension

Registered Extension Number

348

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.1
• Requires VK_KHR_spirv_1_4
• Requires VK_KHR_acceleration_structure

Contact

• Daniel Koch https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_ray_tracing_pipeline:%20&body=@dgkoch%20

Other Extension Metadata

Last Modified Date

2020-11-12

Interactions and External Dependencies

• This extension requires SPV_KHR_ray_tracing
• This extension provides API support for GLSL_EXT_ray_tracing
• This extension interacts with Vulkan 1.2 and VK_KHR_vulkan_memory_model, adding the shader-call-related relation of invocations, shader-call-order partial order of dynamic instances of instructions, and the ShaderCallKHR scope.
• This extension interacts with VK_KHR_pipeline_library, enabling pipeline libraries to be used with ray tracing pipelines and enabling usage of RayTracingPipelineInterfaceCreateInfoKHR.

Contributors

• Matthäus Chajdas, AMD
• Greg Grebe, AMD
• Nicolai Hähnle, AMD
• Tobias Hector, AMD
• Dave Oldcorn, AMD
• Skyler Saleh, AMD
• Mathieu Robart, Arm
• Marius Bjorge, Arm
• Tom Olson, Arm
• Sebastian Tafuri, EA
• Henrik Rydgard, Embark
• Juan Cañada, Epic Games
• Patrick Kelly, Epic Games
• Yuriy O’Donnell, Epic Games
• Michael Doggett, Facebook/Oculus
• Andrew Garrard, Imagination
• Don Scorgie, Imagination
• Dae Kim, Imagination
• Joshua Barczak, Intel
• Slawek Grajewski, Intel
• Jeff Bolz, NVIDIA
• Pascal Gautron, NVIDIA
• Daniel Koch, NVIDIA
• Christoph Kubisch, NVIDIA
• Ashwin Lele, NVIDIA
• Robert Stepinski, NVIDIA
• Martin Stich, NVIDIA
• Nuno Subtil, NVIDIA
• Eric Werness, NVIDIA
• Jon Leech, Khronos
• Jeroen van Schijndel, OTOY
• Juul Joosten, OTOY
• Alex Bourd, Qualcomm
• Roman Larionov, Qualcomm
• David McAllister, Qualcomm
• Spencer Fricke, Samsung
• Lewis Gordon, Samsung
• Ralph Potter, Samsung
• Jasper Bekkers, Traverse Research
• Jesse Barker, Unity
• Baldur Karlsson, Valve

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:

• A new ray tracing pipeline type with new shader domains: ray generation, intersection, any-hit, closest hit, miss, and callable
• A shader binding indirection table to link shader groups with acceleration structure items
• Trace ray commands which initiates the ray pipeline traversal and invocation of the various new shader domains depending on which traversal conditions are met

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

• SPV_KHR_ray_tracing

New Commands

• cmdSetRayTracingPipelineStackSizeKHR

• cmdTraceRaysIndirectKHR
• cmdTraceRaysKHR
• createRayTracingPipelinesKHR
• getRayTracingCaptureReplayShaderGroupHandlesKHR
• getRayTracingShaderGroupHandlesKHR
• getRayTracingShaderGroupStackSizeKHR

New Structures

• RayTracingPipelineCreateInfoKHR

• RayTracingPipelineInterfaceCreateInfoKHR
• RayTracingShaderGroupCreateInfoKHR
• StridedDeviceAddressRegionKHR
• TraceRaysIndirectCommandKHR

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceRayTracingPipelineFeaturesKHR

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceRayTracingPipelinePropertiesKHR

New Enums

• RayTracingShaderGroupTypeKHR

• ShaderGroupShaderKHR

New Enum Constants

• KHR_RAY_TRACING_PIPELINE_EXTENSION_NAME

• KHR_RAY_TRACING_PIPELINE_SPEC_VERSION
• SHADER_UNUSED_KHR

• Extending BufferUsageFlagBits:

  • BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR

• Extending DynamicState:

  • DYNAMIC_STATE_RAY_TRACING_PIPELINE_STACK_SIZE_KHR

• Extending PipelineBindPoint:

  • PIPELINE_BIND_POINT_RAY_TRACING_KHR

• Extending PipelineCreateFlagBits:

  • PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
  • PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
  • PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
  • PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
  • PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR
  • PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
  • PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR

• Extending PipelineStageFlagBits:

  • PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR

• Extending ShaderStageFlagBits:

  • SHADER_STAGE_ANY_HIT_BIT_KHR
  • SHADER_STAGE_CALLABLE_BIT_KHR
  • SHADER_STAGE_CLOSEST_HIT_BIT_KHR
  • SHADER_STAGE_INTERSECTION_BIT_KHR
  • SHADER_STAGE_MISS_BIT_KHR
  • SHADER_STAGE_RAYGEN_BIT_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_FEATURES_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_PROPERTIES_KHR
  • STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_KHR
  • STRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHR
  • STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_KHR

New or Modified Built-In Variables

• LaunchIdKHR

• LaunchSizeKHR
• WorldRayOriginKHR
• WorldRayDirectionKHR
• ObjectRayOriginKHR
• ObjectRayDirectionKHR
• RayTminKHR
• RayTmaxKHR
• InstanceCustomIndexKHR
• InstanceId
• ObjectToWorldKHR
• WorldToObjectKHR
• HitKindKHR
• IncomingRayFlagsKHR
• RayGeometryIndexKHR
• (modified)PrimitiveId

New SPIR-V Capabilities

• RayTracingKHR

• RayTraversalPrimitiveCullingKHR

Issues

1. How does this extension differ from VK_NV_ray_tracing?

DISCUSSION:

The following is a summary of the main functional differences between VK_KHR_ray_tracing_pipeline and VK_NV_ray_tracing:

• added support for indirect ray tracing (cmdTraceRaysIndirectKHR)

• uses SPV_KHR_ray_tracing instead of SPV_NV_ray_tracing

  • refer to KHR SPIR-V enums instead of NV SPIR-V enums (which are functionally equivalent and aliased to the same values).
  • added RayGeometryIndexKHR built-in
• removed vkCompileDeferredNV compilation functionality and replaced with deferred host operations interactions for ray tracing
• added PhysicalDeviceRayTracingPipelineFeaturesKHR structure

• extended PhysicalDeviceRayTracingPipelinePropertiesKHR structure

  • renamed maxRecursionDepth to maxRayRecursionDepth and it has a minimum of 1 instead of 31
  • require shaderGroupHandleSize to be 32 bytes
  • added maxRayDispatchInvocationCount, shaderGroupHandleAlignment and maxRayHitAttributeSize
• reworked geometry structures so they could be better shared between device, host, and indirect builds
• changed SBT parameters to a structure and added size (StridedDeviceAddressRegionKHR)
• add parameter for requesting memory requirements for host and/or device build
• added pipeline library support for ray tracing
• added watertightness guarantees
• added no-null-shader pipeline flags (VK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_*_SHADERS_BIT_KHR)
• added memory model interactions with ray tracing and define how subgroups work and can be repacked

1. Can you give a more detailed comparision of differences and similarities between VK_NV_ray_tracing and VK_KHR_ray_tracing_pipeline?

DISCUSSION:

The following is a more detailed comparision of which commands, structures, and enums are aliased, changed, or removed.

• Aliased functionality — enums, structures, and commands that are considered equivalent:

  • RayTracingShaderGroupTypeNV ↔ RayTracingShaderGroupTypeKHR
  • getRayTracingShaderGroupHandlesNV ↔ getRayTracingShaderGroupHandlesKHR

• Changed enums, structures, and commands:

  • RayTracingShaderGroupCreateInfoNV → RayTracingShaderGroupCreateInfoKHR (added pShaderGroupCaptureReplayHandle)
  • RayTracingPipelineCreateInfoNV → RayTracingPipelineCreateInfoKHR (changed type of pGroups, added libraries, pLibraryInterface, and pDynamicState)
  • PhysicalDeviceRayTracingPropertiesNV → VkPhysicalDeviceRayTracingPropertiesKHR (renamed maxTriangleCount to maxPrimitiveCount, added shaderGroupHandleCaptureReplaySize)
  • cmdTraceRaysNV → cmdTraceRaysKHR (params to struct)
  • createRayTracingPipelinesNV → createRayTracingPipelinesKHR (different struct, changed functionality)

• Added enums, structures and commands:

  • PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR, PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR to PipelineCreateFlagBits
  • PhysicalDeviceRayTracingPipelineFeaturesKHR structure
  • DeviceOrHostAddressKHR and DeviceOrHostAddressConstKHR unions
  • PipelineLibraryCreateInfoKHR struct
  • RayTracingPipelineInterfaceCreateInfoKHR struct
  • StridedDeviceAddressRegionKHR struct
  • cmdTraceRaysIndirectKHR command and TraceRaysIndirectCommandKHR struct
  • getRayTracingCaptureReplayShaderGroupHandlesKHR (shader group capture/replay)
  • cmdSetRayTracingPipelineStackSizeKHR and getRayTracingShaderGroupStackSizeKHR commands for stack size control

• Functionality removed:

  • PIPELINE_CREATE_DEFER_COMPILE_BIT_NV
  • compileDeferredNV command (replaced with VK_KHR_deferred_host_operations)

1. What are the changes between the public provisional (VK_KHR_ray_tracing v8) release and the internal provisional (VK_KHR_ray_tracing v9) release?

• Require Vulkan 1.1 and SPIR-V 1.4
• Added interactions with Vulkan 1.2 and VK_KHR_vulkan_memory_model

• added creation time capture and replay flags

  • added PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR to PipelineCreateFlagBits
• replace VkStridedBufferRegionKHR with StridedDeviceAddressRegionKHR and change cmdTraceRaysKHR, cmdTraceRaysIndirectKHR, to take these for the shader binding table and use device addresses instead of buffers.
• require the shader binding table buffers to have the VK_BUFFER_USAGE_RAY_TRACING_BIT_KHR set
• make VK_KHR_pipeline_library an interaction instead of required extension
• rename the libraries member of RayTracingPipelineCreateInfoKHR to pLibraryInfo and make it a pointer
• make VK_KHR_deferred_host_operations an interaction instead of a required extension (later went back on this)

• added explicit stack size management for ray tracing pipelines

  • removed the maxCallableSize member of RayTracingPipelineInterfaceCreateInfoKHR
  • added the pDynamicState member to RayTracingPipelineCreateInfoKHR
  • added DYNAMIC_STATE_RAY_TRACING_PIPELINE_STACK_SIZE_KHR dynamic state for ray tracing pipelines
  • added getRayTracingShaderGroupStackSizeKHR and cmdSetRayTracingPipelineStackSizeKHR commands
  • added ShaderGroupShaderKHR enum
• Added maxRayDispatchInvocationCount limit to PhysicalDeviceRayTracingPipelinePropertiesKHR
• Added shaderGroupHandleAlignment property to PhysicalDeviceRayTracingPipelinePropertiesKHR
• Added maxRayHitAttributeSize property to PhysicalDeviceRayTracingPipelinePropertiesKHR

• Clarify deferred host ops for pipeline creation

  • DeferredOperationKHR is now a top-level parameter for createRayTracingPipelinesKHR
  • removed VkDeferredOperationInfoKHR structure
  • change deferred host creation/return parameter behavior such that the implementation can modify such parameters until the deferred host operation completes
  • VK_KHR_deferred_host_operations is required again

1. What are the changes between the internal provisional (VK_KHR_ray_tracing v9) release and the final (VK_KHR_acceleration_structure v11 / VK_KHR_ray_tracing_pipeline v1) release?

• refactor VK_KHR_ray_tracing into 3 extensions, enabling implementation flexibility and decoupling ray query support from ray pipelines:

  • VK_KHR_acceleration_structure (for acceleration structure operations)
  • VK_KHR_ray_tracing_pipeline (for ray tracing pipeline and shader stages)
  • VK_KHR_ray_query (for ray queries in existing shader stages)

• Require Volatile for the following builtins in the ray generation, closest hit, miss, intersection, and callable shader stages:

  • SubgroupSize, SubgroupLocalInvocationId, SubgroupEqMask, SubgroupGeMask, SubgroupGtMask, SubgroupLeMask, SubgroupLtMask
  • SMIDNV, WarpIDNV

• clarify buffer usage flags for ray tracing

  • BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR is added as an alias of BUFFER_USAGE_RAY_TRACING_BIT_NV and is required on shader binding table buffers
  • BUFFER_USAGE_STORAGE_BUFFER_BIT is used in VK_KHR_acceleration_structure for scratchData
• rename maxRecursionDepth to maxRayPipelineRecursionDepth (pipeline creation) and maxRayRecursionDepth (limit) to reduce confusion
• Add queryable maxRayHitAttributeSize limit and rename members of RayTracingPipelineInterfaceCreateInfoKHR to maxPipelineRayPayloadSize and maxPipelineRayHitAttributeSize for clarity
• Update SPIRV capabilities to use RayTracingKHR
• extension is no longer provisional
• define synchronization requirements for indirect trace rays and indirect buffer

1. This extension adds gl_InstanceID for the intersection, any-hit, and closest hit shaders, but in KHR_vulkan_glsl, gl_InstanceID is replaced with gl_InstanceIndex. Which should be used for Vulkan in this extension?

RESOLVED: This extension uses gl_InstanceID and maps it to InstanceId in SPIR-V. It is acknowledged that this is different than other shader stages in Vulkan. There are two main reasons for the difference here:

• symmetry with gl_PrimitiveID which is also available in these shaders
• there is no “baseInstance” relevant for these shaders, and so ID makes it more obvious that this is zero-based.

Sample Code

Example ray generation GLSL shader

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

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

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

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

   col.y = payload;

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

Version History

• Revision 1, 2020-11-12 (Mathieu Robart, Daniel Koch, Eric Werness, Tobias Hector)

  • Decomposition of the specification, from VK_KHR_ray_tracing to VK_KHR_ray_tracing_pipeline (#1918,!3912)
  • require certain subgroup and sm_shader_builtin shader builtins to be decorated as volatile in the ray generation, closest hit, miss, intersection, and callable stages (#1924,!3903,!3954)
  • clarify buffer usage flags for ray tracing (#2181,!3939)
  • rename maxRecursionDepth to maxRayPipelineRecursionDepth and maxRayRecursionDepth (#2203,!3937)
  • add queriable maxRayHitAttributeSize and rename members of VkRayTracingPipelineInterfaceCreateInfoKHR (#2102,!3966)
  • update to use RayTracingKHR SPIR-V capability
  • add VUs for matching hit group type against geometry type (#2245,!3994)
  • require RayTMaxKHR be volatile in intersection shaders (#2268,!4030)
  • add numerical limits for ray parameters (#2235,!3960)
  • fix SBT indexing rules for device addresses (#2308,!4079)
  • relax formula for ray intersection candidate determination (#2322,!4080)
  • add more details on ShaderRecordBufferKHR variables (#2230,!4083)
  • clarify valid bits for InstanceCustomIndexKHR (GLSL/GLSL#19,!4128)
  • allow at most one IncomingRayPayloadKHR, IncomingCallableDataKHR, and HitAttributeKHR (!4129)
  • add minimum for maxShaderGroupStride (#2353,!4131)
  • require VK_KHR_pipeline_library extension to be supported (#2348,!4135)
  • clarify meaning of 'geometry index' (#2272,!4137)
  • restrict traces to TLAS (#2239,!4141)
  • add note about maxPipelineRayPayloadSize (#2383,!4172)
  • do not require raygen shader in pipeline libraries (!4185)
  • define sync for indirect trace rays and indirect buffer (#2407,!4208)

See Also

SHADER_UNUSED_KHR, PhysicalDeviceRayTracingPipelineFeaturesKHR, PhysicalDeviceRayTracingPipelinePropertiesKHR, RayTracingPipelineCreateInfoKHR, RayTracingPipelineInterfaceCreateInfoKHR, RayTracingShaderGroupCreateInfoKHR, RayTracingShaderGroupTypeKHR, ShaderGroupShaderKHR, StridedDeviceAddressRegionKHR, TraceRaysIndirectCommandKHR, cmdSetRayTracingPipelineStackSizeKHR, cmdTraceRaysIndirectKHR, cmdTraceRaysKHR, createRayTracingPipelinesKHR, getRayTracingCaptureReplayShaderGroupHandlesKHR, getRayTracingShaderGroupHandlesKHR, getRayTracingShaderGroupStackSizeKHR

Document Notes

For more information, see the Vulkan Specification

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

Documentation

cmdTraceRaysKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("raygenShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pRaygenShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the ray generation shader stage.

-> ("missShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pMissShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the miss shader stage.

-> ("hitShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pHitShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the hit shader stage.

-> ("callableShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pCallableShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the callable shader stage.

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

vkCmdTraceRaysKHR - Initialize a ray tracing dispatch

Description

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

Valid Usage

• If a Sampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

• If a Sampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a ImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a ImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• Any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a ImageViewType and format that supports cubic filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by getPhysicalDeviceImageFormatProperties2
• Any ImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a ImageViewType and format that supports cubic filtering together with minmax filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by getPhysicalDeviceImageFormatProperties2
• Any Image created with a ImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a SamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For each set n that is statically used by the Pipeline bound to the pipeline bind point used by this command, a descriptor set must have been bound to n at the same pipeline bind point, with a PipelineLayout that is compatible for set n, with the PipelineLayout used to create the current Pipeline, as described in ???
• For each push constant that is statically used by the Pipeline bound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with a PipelineLayout that is compatible for push constants, with the PipelineLayout used to create the current Pipeline, as described in ???
• Descriptors in each bound descriptor set, specified via cmdBindDescriptorSets, must be valid if they are statically used by the Pipeline bound to the pipeline bind point used by this command
• A valid pipeline must be bound to the pipeline bind point used by this command
• If the Pipeline object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set or inherited for commandBuffer, and done so after any previously bound pipeline with the corresponding state not specified as dynamic
• There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the Pipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used to sample from any Image with a ImageView of the type IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values, in any shader stage
• If the robust buffer access feature is not enabled, and if the Pipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robust buffer access feature is not enabled, and if the Pipeline object bound to the pipeline bind point used by this command accesses a storage buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If commandBuffer is an unprotected command buffer, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If a ImageView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format.
• If a BufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format.
• If a ImageView with a Format that has a 64-bit channel width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64.
• If a ImageView with a Format that has a channel width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32.
• If a BufferView with a Format that has a 64-bit channel width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64.
• If a BufferView with a Format that has a channel width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32.
• If the sparseImageInt64Atomics feature is not enabled, Image objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command.
• If the sparseImageInt64Atomics feature is not enabled, Buffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command.
• Any shader group handle referenced by this call must have been queried from the currently bound ray tracing pipeline
• This command must not cause a shader call instruction to be executed from a shader invocation with a recursion depth greater than the value of maxPipelineRayRecursionDepth used to create the bound ray tracing pipeline
• If the buffer from which pRayGenShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pRayGenShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pRayGenShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The size member of pRayGenShaderBindingTable must be equal to its stride member
• If the buffer from which pMissShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pMissShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pMissShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The stride member of pMissShaderBindingTable must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• The stride member of pMissShaderBindingTable must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the buffer from which pHitShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pHitShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pHitShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The stride member of pHitShaderBindingTable must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• The stride member of pHitShaderBindingTable must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the buffer from which pCallableShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pCallableShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pCallableShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The stride member of pCallableShaderBindingTable must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• The stride member of pCallableShaderBindingTable must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, the deviceAddress member of pHitShaderBindingTable must not be zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, the deviceAddress member of pHitShaderBindingTable must not be zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, the shader group handle identified by pMissShaderBindingTable must contain a valid miss shader
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, entries in pHitShaderBindingTable accessed as a result of this command in order to execute an any-hit shader must not be set to zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, entries in pHitShaderBindingTable accessed as a result of this command in order to execute a closest hit shader must not be set to zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, entries in pHitShaderBindingTable accessed as a result of this command in order to execute an intersection shader must not be set to zero
• Any non-zero hit group entries in pHitShaderBindingTable accessed by this call from a geometry with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR must have been created with RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR
• Any non-zero hit group entries in pHitShaderBindingTable accessed by this call from a geometry with a geometryType of GEOMETRY_TYPE_AABBS_KHR must have been created with RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR
• commandBuffer must not be a protected command buffer
• width must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0] × PhysicalDeviceLimits::maxComputeWorkGroupSize[0]
• height must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1] × PhysicalDeviceLimits::maxComputeWorkGroupSize[1]
• depth must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2] × PhysicalDeviceLimits::maxComputeWorkGroupSize[2]
• width × height × depth must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayDispatchInvocationCount

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pRaygenShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• pMissShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• pHitShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• pCallableShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance

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	Outside	Compute

See Also

CommandBuffer, StridedDeviceAddressRegionKHR

getRayTracingShaderGroupHandlesKHR

Arguments

:: forall io. 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 a user-allocated buffer where the results will be written.

-> io ()

vkGetRayTracingShaderGroupHandlesKHR - Query ray tracing pipeline shader group handles

Valid Usage

• pipeline must be a ray tracing pipeline

• firstGroup must be less than the number of shader groups in pipeline
• The sum of firstGroup and groupCount must be less than or equal to the number of shader groups in pipeline
• dataSize must be at least PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleSize × groupCount
• pipeline must have not been created with PIPELINE_CREATE_LIBRARY_BIT_KHR

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

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, Pipeline

getRayTracingCaptureReplayShaderGroupHandlesKHR

Arguments

:: forall io. 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 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 a user-allocated buffer where the results will be written.

-> io ()

vkGetRayTracingCaptureReplayShaderGroupHandlesKHR - Query ray tracing capture replay pipeline shader group handles

Valid Usage

• pipeline must be a ray tracing pipeline

• firstGroup must be less than the number of shader groups in pipeline
• The sum of firstGroup and groupCount must be less than or equal to the number of shader groups in pipeline
• dataSize must be at least PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleCaptureReplaySize × groupCount
• PhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplay must be enabled to call this function
• pipeline must have been created with a flags that included PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR

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

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, Pipeline

createRayTracingPipelinesKHR

Arguments

:: forall io. MonadIO io

=> Device

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

-> DeferredOperationKHR

deferredOperation is NULL_HANDLE or the handle of a valid DeferredOperationKHR request deferral object for this command.

-> PipelineCache

pipelineCache is either NULL_HANDLE, indicating that pipeline caching is disabled, or the handle of a valid pipeline cache object, in which case use of that cache is enabled for the duration of the command.

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

pCreateInfos is a pointer to an array of RayTracingPipelineCreateInfoKHR structures.

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

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

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

vkCreateRayTracingPipelinesKHR - Creates a new ray tracing pipeline object

Description

The ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS error is returned if the implementation is unable to re-use the shader group handles provided in RayTracingShaderGroupCreateInfoKHR::pShaderGroupCaptureReplayHandle when PhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplay is enabled.

Valid Usage

• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and the basePipelineIndex member of that same element is not -1, basePipelineIndex must be less than the index into pCreateInfos that corresponds to that element

• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline must have been created with the PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
• flags must not contain the PIPELINE_CREATE_DISPATCH_BASE flag
• If pipelineCache was created with PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host access to pipelineCache must be externally synchronized
• If deferredOperation is not NULL_HANDLE, it must be a valid DeferredOperationKHR object
• Any previous deferred operation that was associated with deferredOperation must be complete
• The rayTracingPipeline feature must be enabled
• If deferredOperation is not NULL_HANDLE, the flags member of elements of pCreateInfos must not include PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT

Valid Usage (Implicit)

• device must be a valid Device handle

• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid DeferredOperationKHR 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 RayTracingPipelineCreateInfoKHR 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 deferredOperation is a valid handle, it must have been created, allocated, or retrieved from device
• If pipelineCache is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR
• PIPELINE_COMPILE_REQUIRED_EXT

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS

See Also

AllocationCallbacks, DeferredOperationKHR, Device, Pipeline, PipelineCache, RayTracingPipelineCreateInfoKHR

withRayTracingPipelinesKHR :: forall io r. MonadIO io => Device -> DeferredOperationKHR -> PipelineCache -> Vector (SomeStruct RayTracingPipelineCreateInfoKHR) -> Maybe AllocationCallbacks -> (io (Result, Vector Pipeline) -> ((Result, Vector Pipeline) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createRayTracingPipelinesKHR 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.

cmdTraceRaysIndirectKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("raygenShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pRaygenShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the ray generation shader stage.

-> ("missShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pMissShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the miss shader stage.

-> ("hitShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pHitShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the hit shader stage.

-> ("callableShaderBindingTable" ::: StridedDeviceAddressRegionKHR)

pCallableShaderBindingTable is a StridedDeviceAddressRegionKHR that holds the shader binding table data for the callable shader stage.

-> ("indirectDeviceAddress" ::: DeviceAddress)

indirectDeviceAddress is a buffer device address which is a pointer to a TraceRaysIndirectCommandKHR structure containing the trace ray parameters.

-> io ()

vkCmdTraceRaysIndirectKHR - Initialize an indirect ray tracing dispatch

Description

cmdTraceRaysIndirectKHR behaves similarly to cmdTraceRaysKHR except that the ray trace query dimensions are read by the device from indirectDeviceAddress during execution.

Valid Usage

• If a Sampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

• If a Sampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a ImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a ImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• Any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a ImageViewType and format that supports cubic filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by getPhysicalDeviceImageFormatProperties2
• Any ImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a ImageViewType and format that supports cubic filtering together with minmax filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by getPhysicalDeviceImageFormatProperties2
• Any Image created with a ImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a SamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For each set n that is statically used by the Pipeline bound to the pipeline bind point used by this command, a descriptor set must have been bound to n at the same pipeline bind point, with a PipelineLayout that is compatible for set n, with the PipelineLayout used to create the current Pipeline, as described in ???
• For each push constant that is statically used by the Pipeline bound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with a PipelineLayout that is compatible for push constants, with the PipelineLayout used to create the current Pipeline, as described in ???
• Descriptors in each bound descriptor set, specified via cmdBindDescriptorSets, must be valid if they are statically used by the Pipeline bound to the pipeline bind point used by this command
• A valid pipeline must be bound to the pipeline bind point used by this command
• If the Pipeline object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set or inherited for commandBuffer, and done so after any previously bound pipeline with the corresponding state not specified as dynamic
• There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the Pipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used to sample from any Image with a ImageView of the type IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values, in any shader stage
• If the robust buffer access feature is not enabled, and if the Pipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robust buffer access feature is not enabled, and if the Pipeline object bound to the pipeline bind point used by this command accesses a storage buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If commandBuffer is an unprotected command buffer, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If a ImageView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format.
• If a BufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format.
• If a ImageView with a Format that has a 64-bit channel width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64.
• If a ImageView with a Format that has a channel width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32.
• If a BufferView with a Format that has a 64-bit channel width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64.
• If a BufferView with a Format that has a channel width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32.
• If the sparseImageInt64Atomics feature is not enabled, Image objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command.
• If the sparseImageInt64Atomics feature is not enabled, Buffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command.
• Any shader group handle referenced by this call must have been queried from the currently bound ray tracing pipeline
• This command must not cause a shader call instruction to be executed from a shader invocation with a recursion depth greater than the value of maxPipelineRayRecursionDepth used to create the bound ray tracing pipeline
• If the buffer from which pRayGenShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pRayGenShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pRayGenShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The size member of pRayGenShaderBindingTable must be equal to its stride member
• If the buffer from which pMissShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pMissShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pMissShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The stride member of pMissShaderBindingTable must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• The stride member of pMissShaderBindingTable must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the buffer from which pHitShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pHitShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pHitShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The stride member of pHitShaderBindingTable must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• The stride member of pHitShaderBindingTable must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the buffer from which pCallableShaderBindingTable->deviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which the pCallableShaderBindingTable->deviceAddress is queried must have been created with the BUFFER_USAGE_SHADER_BINDING_TABLE_BIT_KHR usage flag
• pCallableShaderBindingTable->deviceAddress must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupBaseAlignment
• The stride member of pCallableShaderBindingTable must be a multiple of PhysicalDeviceRayTracingPipelinePropertiesKHR::shaderGroupHandleAlignment
• The stride member of pCallableShaderBindingTable must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxShaderGroupStride
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, the deviceAddress member of pHitShaderBindingTable must not be zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, the deviceAddress member of pHitShaderBindingTable must not be zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, the shader group handle identified by pMissShaderBindingTable must contain a valid miss shader
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, entries in pHitShaderBindingTable accessed as a result of this command in order to execute an any-hit shader must not be set to zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, entries in pHitShaderBindingTable accessed as a result of this command in order to execute a closest hit shader must not be set to zero
• If the currently bound ray tracing pipeline was created with flags that included PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, entries in pHitShaderBindingTable accessed as a result of this command in order to execute an intersection shader must not be set to zero
• Any non-zero hit group entries in pHitShaderBindingTable accessed by this call from a geometry with a geometryType of GEOMETRY_TYPE_TRIANGLES_KHR must have been created with RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR
• Any non-zero hit group entries in pHitShaderBindingTable accessed by this call from a geometry with a geometryType of GEOMETRY_TYPE_AABBS_KHR must have been created with RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR
• If the buffer from which indirectDeviceAddress was queried is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer from which indirectDeviceAddress was queried must have been created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• indirectDeviceAddress must be a multiple of 4
• commandBuffer must not be a protected command buffer
• All device addresses between indirectDeviceAddress and indirectDeviceAddress + sizeof(TraceRaysIndirectCommandKHR) - 1 must be in the buffer device address range of the same buffer
• The ::rayTracingPipelineTraceRaysIndirect feature must be enabled

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pRaygenShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• pMissShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• pHitShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• pCallableShaderBindingTable must be a valid pointer to a valid StridedDeviceAddressRegionKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance

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	Outside	Compute

See Also

CommandBuffer, DeviceAddress, StridedDeviceAddressRegionKHR

getRayTracingShaderGroupStackSizeKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device containing the ray tracing pipeline.

-> Pipeline

pipeline is the ray tracing pipeline object containing the shaders groups.

-> ("group" ::: Word32)

group is the index of the shader group to query.

-> ShaderGroupShaderKHR

groupShader is the type of shader from the group to query.

-> io DeviceSize

vkGetRayTracingShaderGroupStackSizeKHR - Query ray tracing pipeline shader group shader stack size

Description

The return value is the ray tracing pipeline stack size in bytes for the specified shader as called from the specified shader group.

Valid Usage

• pipeline must be a ray tracing pipeline

• The value of group must be less than the number of shader groups in pipeline
• The shader identified by groupShader in group must not be SHADER_UNUSED_KHR

Valid Usage (Implicit)

• device must be a valid Device handle

• pipeline must be a valid Pipeline handle
• groupShader must be a valid ShaderGroupShaderKHR value
• pipeline must have been created, allocated, or retrieved from device

See Also

Device, Pipeline, ShaderGroupShaderKHR

cmdSetRayTracingPipelineStackSizeKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("pipelineStackSize" ::: Word32)

pipelineStackSize is the stack size to use for subsequent ray tracing trace commands.

-> io ()

vkCmdSetRayTracingPipelineStackSizeKHR - Set the dynamic stack size for a ray tracing pipeline

Description

See Ray Tracing Pipeline Stack for more on computing pipelineStackSize.

Valid Usage

• pipelineStackSize must be large enough for any dynamic execution through the shaders in the ray tracing pipeline used by a subsequent trace call

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 compute operations
• This command must only be called outside of a render pass instance

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	Outside	Compute

See Also

CommandBuffer

data RayTracingShaderGroupCreateInfoKHR

VkRayTracingShaderGroupCreateInfoKHR - Structure specifying shaders in a shader group

Valid Usage

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR then generalShader must be a valid index into RayTracingPipelineCreateInfoKHR::pStages referring to a shader of SHADER_STAGE_RAYGEN_BIT_KHR, SHADER_STAGE_MISS_BIT_KHR, or SHADER_STAGE_CALLABLE_BIT_KHR

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR then closestHitShader, anyHitShader, and intersectionShader must be SHADER_UNUSED_KHR
• If type is RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR then intersectionShader must be a valid index into RayTracingPipelineCreateInfoKHR::pStages referring to a shader of SHADER_STAGE_INTERSECTION_BIT_KHR
• If type is RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR then intersectionShader must be SHADER_UNUSED_KHR
• closestHitShader must be either SHADER_UNUSED_KHR or a valid index into RayTracingPipelineCreateInfoKHR::pStages referring to a shader of SHADER_STAGE_CLOSEST_HIT_BIT_KHR
• anyHitShader must be either SHADER_UNUSED_KHR or a valid index into RayTracingPipelineCreateInfoKHR::pStages referring to a shader of SHADER_STAGE_ANY_HIT_BIT_KHR
• If PhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplayMixed is FALSE then pShaderGroupCaptureReplayHandle must not be provided if it has not been provided on a previous call to ray tracing pipeline creation
• If PhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplayMixed is FALSE then the caller must guarantee that no ray tracing pipeline creation commands with pShaderGroupCaptureReplayHandle provided execute simultaneously with ray tracing pipeline creation commands without pShaderGroupCaptureReplayHandle provided

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_KHR

• pNext must be NULL
• type must be a valid RayTracingShaderGroupTypeKHR value

See Also

RayTracingPipelineCreateInfoKHR, RayTracingShaderGroupTypeKHR, StructureType

Constructors

RayTracingShaderGroupCreateInfoKHR

Fields

• type' :: RayTracingShaderGroupTypeKHR

  type is the type of hit group specified in this structure.

• generalShader :: Word32

  generalShader is the index of the ray generation, miss, or callable shader from RayTracingPipelineCreateInfoKHR::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR, and SHADER_UNUSED_KHR otherwise.

• closestHitShader :: Word32

  closestHitShader is the optional index of the closest hit shader from RayTracingPipelineCreateInfoKHR::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, and SHADER_UNUSED_KHR otherwise.

• anyHitShader :: Word32

  anyHitShader is the optional index of the any-hit shader from RayTracingPipelineCreateInfoKHR::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, and SHADER_UNUSED_KHR otherwise.

• intersectionShader :: Word32

  intersectionShader is the index of the intersection shader from RayTracingPipelineCreateInfoKHR::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, and SHADER_UNUSED_KHR otherwise.

• shaderGroupCaptureReplayHandle :: Ptr ()

  pShaderGroupCaptureReplayHandle is an optional pointer to replay information for this shader group. Ignored if PhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplay is FALSE.

Instances

Show RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> RayTracingShaderGroupCreateInfoKHR -> ShowS

show :: RayTracingShaderGroupCreateInfoKHR -> String

showList :: [RayTracingShaderGroupCreateInfoKHR] -> ShowS

Storable RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: RayTracingShaderGroupCreateInfoKHR -> Int

alignment :: RayTracingShaderGroupCreateInfoKHR -> Int

peekElemOff :: Ptr RayTracingShaderGroupCreateInfoKHR -> Int -> IO RayTracingShaderGroupCreateInfoKHR

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

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

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

peek :: Ptr RayTracingShaderGroupCreateInfoKHR -> IO RayTracingShaderGroupCreateInfoKHR

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

FromCStruct RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr RayTracingShaderGroupCreateInfoKHR -> IO RayTracingShaderGroupCreateInfoKHR

ToCStruct RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

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

pokeCStruct :: Ptr RayTracingShaderGroupCreateInfoKHR -> RayTracingShaderGroupCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr RayTracingShaderGroupCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: RayTracingShaderGroupCreateInfoKHR

data RayTracingPipelineCreateInfoKHR (es :: [Type])

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

Description

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

When PIPELINE_CREATE_LIBRARY_BIT_KHR is specified, this pipeline defines a pipeline library which cannot be bound as a ray tracing pipeline directly. Instead, pipeline libraries define common shaders and shader groups which can be included in future pipeline creation.

If pipeline libraries are included in pLibraryInfo, shaders defined in those libraries are treated as if they were defined as additional entries in pStages, appended in the order they appear in the pLibraries array and in the pStages array when those libraries were defined.

When referencing shader groups in order to obtain a shader group handle, groups defined in those libraries are treated as if they were defined as additional entries in pGroups, appended in the order they appear in the pLibraries array and in the pGroups array when those libraries were defined. The shaders these groups reference are set when the pipeline library is created, referencing those specified in the pipeline library, not in the pipeline that includes it.

The default stack size for a pipeline if DYNAMIC_STATE_RAY_TRACING_PIPELINE_STACK_SIZE_KHR is not provided is computed as described in Ray Tracing Pipeline Stack.

Valid Usage

• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is -1, basePipelineHandle must be a valid handle to a ray tracing Pipeline

• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is NULL_HANDLE, basePipelineIndex must be a valid index into the calling command’s pCreateInfos parameter
• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is not -1, basePipelineHandle must be NULL_HANDLE
• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is not NULL_HANDLE, basePipelineIndex must be -1
• The shader code for the entry points identified by pStages, and the rest of the state identified by this structure must adhere to the pipeline linking rules described in the Shader Interfaces chapter
• layout must be consistent with all shaders specified in pStages
• The number of resources in layout accessible to each shader stage that is used by the pipeline must be less than or equal to PhysicalDeviceLimits::maxPerStageResources
• flags must not include PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
• If the pipelineCreationCacheControl feature is not enabled, flags must not include PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT
• If flags does not include PIPELINE_CREATE_LIBRARY_BIT_KHR, the stage member of at least one element of pStages, including those implicitly added by pLibraryInfo, must be SHADER_STAGE_RAYGEN_BIT_KHR
• maxPipelineRayRecursionDepth must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayRecursionDepth
• If flags includes PIPELINE_CREATE_LIBRARY_BIT_KHR, pLibraryInterface must not be NULL
• If pLibraryInfo is not NULL and its libraryCount member is greater than 0, its pLibraryInterface member must not be NULL
• Each element of pLibraryInfo->pLibraries must have been created with the value of maxPipelineRayRecursionDepth equal to that in this pipeline
• If pLibraryInfo is not NULL, each element of its pLibraries member must have been created with a layout that is compatible with the layout in this pipeline
• If pLibraryInfo is not NULL, each element of its pLibraries member must have been created with values of the maxPipelineRayPayloadSize and maxPipelineRayHitAttributeSize members of pLibraryInterface equal to those in this pipeline
• If flags includes PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR bit set
• If flags includes PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR bit set
• If flags includes PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR bit set
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR bit set
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR bit set
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR bit set
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, each element of pLibraryInfo->pLibraries must have been created with the PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR bit set
• If the VK_KHR_pipeline_library extension is not enabled, pLibraryInfo and pLibraryInterface must be NULL.
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, for any element of pGroups with a type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, the anyHitShader of that element must not be SHADER_UNUSED_KHR
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, for any element of pGroups with a type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, the closestHitShader of that element must not be SHADER_UNUSED_KHR
• If the rayTraversalPrimitiveCulling feature is not enabled, flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
• If the rayTraversalPrimitiveCulling feature is not enabled, flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
• If flags includes PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR, rayTracingPipelineShaderGroupHandleCaptureReplay must be enabled
• If PhysicalDeviceRayTracingPipelineFeaturesKHR::rayTracingPipelineShaderGroupHandleCaptureReplay is TRUE and the pShaderGroupCaptureReplayHandle member of any element of pGroups is not NULL, flags must include PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR
• If pLibraryInfo is not NULL and its libraryCount is 0, stageCount must not be 0
• If pLibraryInfo is not NULL and its libraryCount is 0, groupCount must not be 0
• Any element of the pDynamicStates member of pDynamicState must be DYNAMIC_STATE_RAY_TRACING_PIPELINE_STACK_SIZE_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of PipelineCreationFeedbackCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of PipelineCreateFlagBits values
• If stageCount is not 0, pStages must be a valid pointer to an array of stageCount valid PipelineShaderStageCreateInfo structures
• If groupCount is not 0, pGroups must be a valid pointer to an array of groupCount valid RayTracingShaderGroupCreateInfoKHR structures
• If pLibraryInfo is not NULL, pLibraryInfo must be a valid pointer to a valid PipelineLibraryCreateInfoKHR structure
• If pLibraryInterface is not NULL, pLibraryInterface must be a valid pointer to a valid RayTracingPipelineInterfaceCreateInfoKHR structure
• If pDynamicState is not NULL, pDynamicState must be a valid pointer to a valid PipelineDynamicStateCreateInfo structure
• layout must be a valid PipelineLayout handle
• Both of basePipelineHandle, and layout that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

Pipeline, PipelineCreateFlags, PipelineDynamicStateCreateInfo, PipelineLayout, PipelineLibraryCreateInfoKHR, PipelineShaderStageCreateInfo, RayTracingPipelineInterfaceCreateInfoKHR, RayTracingShaderGroupCreateInfoKHR, StructureType, createRayTracingPipelinesKHR

Constructors

RayTracingPipelineCreateInfoKHR

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: PipelineCreateFlags

  flags is a bitmask of PipelineCreateFlagBits specifying how the pipeline will be generated.

• stages :: Vector (SomeStruct PipelineShaderStageCreateInfo)

  pStages is a pointer to an array of stageCount PipelineShaderStageCreateInfo structures describing the set of the shader stages to be included in the ray tracing pipeline.

• groups :: Vector RayTracingShaderGroupCreateInfoKHR

  pGroups is a pointer to an array of groupCount RayTracingShaderGroupCreateInfoKHR structures describing the set of the shader stages to be included in each shader group in the ray tracing pipeline.

• maxPipelineRayRecursionDepth :: Word32

  maxPipelineRayRecursionDepth is the maximum recursion depth of shaders executed by this pipeline.

• libraryInfo :: Maybe PipelineLibraryCreateInfoKHR

  pLibraryInfo is a pointer to a PipelineLibraryCreateInfoKHR structure defining pipeline libraries to include.

• libraryInterface :: Maybe RayTracingPipelineInterfaceCreateInfoKHR

  pLibraryInterface is a pointer to a RayTracingPipelineInterfaceCreateInfoKHR structure defining additional information when using pipeline libraries.

• dynamicState :: Maybe PipelineDynamicStateCreateInfo

  pDynamicState is a pointer to a PipelineDynamicStateCreateInfo structure, and is used to indicate which properties of the pipeline state object are dynamic and can be changed independently of the pipeline state. This can be NULL, which means no state in the pipeline is considered dynamic.

• layout :: PipelineLayout

  layout is the description of binding locations used by both the pipeline and descriptor sets used with the pipeline.

• basePipelineHandle :: Pipeline

  basePipelineHandle is a pipeline to derive from.

• basePipelineIndex :: Int32

  basePipelineIndex is an index into the pCreateInfos parameter to use as a pipeline to derive from.

Instances

Extensible RayTracingPipelineCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). RayTracingPipelineCreateInfoKHR es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). RayTracingPipelineCreateInfoKHR ds -> Chain es -> RayTracingPipelineCreateInfoKHR es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends RayTracingPipelineCreateInfoKHR e => b) -> Maybe b

Show (Chain es) => Show (RayTracingPipelineCreateInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> RayTracingPipelineCreateInfoKHR es -> ShowS

show :: RayTracingPipelineCreateInfoKHR es -> String

showList :: [RayTracingPipelineCreateInfoKHR es] -> ShowS

(Extendss RayTracingPipelineCreateInfoKHR es, PeekChain es) => FromCStruct (RayTracingPipelineCreateInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr (RayTracingPipelineCreateInfoKHR es) -> IO (RayTracingPipelineCreateInfoKHR es)

(Extendss RayTracingPipelineCreateInfoKHR es, PokeChain es) => ToCStruct (RayTracingPipelineCreateInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

withCStruct :: RayTracingPipelineCreateInfoKHR es -> (Ptr (RayTracingPipelineCreateInfoKHR es) -> IO b) -> IO b

pokeCStruct :: Ptr (RayTracingPipelineCreateInfoKHR es) -> RayTracingPipelineCreateInfoKHR es -> IO b -> IO b

withZeroCStruct :: (Ptr (RayTracingPipelineCreateInfoKHR es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (RayTracingPipelineCreateInfoKHR es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (RayTracingPipelineCreateInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: RayTracingPipelineCreateInfoKHR es

data PhysicalDeviceRayTracingPipelineFeaturesKHR

VkPhysicalDeviceRayTracingPipelineFeaturesKHR - Structure describing the ray tracing features that can be supported by an implementation

Members

This structure describes the following features:

Description

• sType is the type of this structure.

• pNext is NULL or a pointer to a structure extending this structure.
• rayTracingPipeline indicates whether the implementation supports the ray tracing pipeline functionality. See Ray Tracing.
• rayTracingPipelineShaderGroupHandleCaptureReplay indicates whether the implementation supports saving and reusing shader group handles, e.g. for trace capture and replay.
• rayTracingPipelineShaderGroupHandleCaptureReplayMixed indicates whether the implementation supports reuse of shader group handles being arbitrarily mixed with creation of non-reused shader group handles. If this is FALSE, all reused shader group handles must be specified before any non-reused handles may be created.
• rayTracingPipelineTraceRaysIndirect indicates whether the implementation supports indirect trace ray commands, e.g. cmdTraceRaysIndirectKHR.
• rayTraversalPrimitiveCulling indicates whether the implementation supports primitive culling during ray traversal.

If the PhysicalDeviceRayTracingPipelineFeaturesKHR 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. PhysicalDeviceRayTracingPipelineFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage

• If rayTracingPipelineShaderGroupHandleCaptureReplayMixed is TRUE, rayTracingPipelineShaderGroupHandleCaptureReplay must also be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PIPELINE_FEATURES_KHR

See Also

Bool32, StructureType

Constructors

PhysicalDeviceRayTracingPipelineFeaturesKHR

Fields

• rayTracingPipeline :: Bool
• rayTracingPipelineShaderGroupHandleCaptureReplay :: Bool
• rayTracingPipelineShaderGroupHandleCaptureReplayMixed :: Bool
• rayTracingPipelineTraceRaysIndirect :: Bool
• rayTraversalPrimitiveCulling :: Bool

Instances

Eq PhysicalDeviceRayTracingPipelineFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: PhysicalDeviceRayTracingPipelineFeaturesKHR -> PhysicalDeviceRayTracingPipelineFeaturesKHR -> Bool

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

Show PhysicalDeviceRayTracingPipelineFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> PhysicalDeviceRayTracingPipelineFeaturesKHR -> ShowS

show :: PhysicalDeviceRayTracingPipelineFeaturesKHR -> String

showList :: [PhysicalDeviceRayTracingPipelineFeaturesKHR] -> ShowS

Storable PhysicalDeviceRayTracingPipelineFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: PhysicalDeviceRayTracingPipelineFeaturesKHR -> Int

alignment :: PhysicalDeviceRayTracingPipelineFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceRayTracingPipelineFeaturesKHR -> Int -> IO PhysicalDeviceRayTracingPipelineFeaturesKHR

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

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

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

peek :: Ptr PhysicalDeviceRayTracingPipelineFeaturesKHR -> IO PhysicalDeviceRayTracingPipelineFeaturesKHR

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

FromCStruct PhysicalDeviceRayTracingPipelineFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr PhysicalDeviceRayTracingPipelineFeaturesKHR -> IO PhysicalDeviceRayTracingPipelineFeaturesKHR

ToCStruct PhysicalDeviceRayTracingPipelineFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

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

pokeCStruct :: Ptr PhysicalDeviceRayTracingPipelineFeaturesKHR -> PhysicalDeviceRayTracingPipelineFeaturesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceRayTracingPipelineFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceRayTracingPipelineFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: PhysicalDeviceRayTracingPipelineFeaturesKHR

data PhysicalDeviceRayTracingPipelinePropertiesKHR

VkPhysicalDeviceRayTracingPipelinePropertiesKHR - Properties of the physical device for ray tracing

Description

If the PhysicalDeviceRayTracingPipelinePropertiesKHR 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 PhysicalDeviceRayTracingPropertiesNV.

Valid Usage (Implicit)

See Also

StructureType

Constructors

PhysicalDeviceRayTracingPipelinePropertiesKHR

Fields

• shaderGroupHandleSize :: Word32

  shaderGroupHandleSize is the size in bytes of the shader header.

• maxRayRecursionDepth :: Word32

  maxRayRecursionDepth is the maximum number of levels of ray recursion allowed in a trace command.

• maxShaderGroupStride :: Word32

  maxShaderGroupStride is the maximum stride in bytes allowed between shader groups in the shader binding table.

• shaderGroupBaseAlignment :: Word32

  shaderGroupBaseAlignment is the required alignment in bytes for the base of the shader binding table.

• shaderGroupHandleCaptureReplaySize :: Word32

  shaderGroupHandleCaptureReplaySize is the number of bytes for the information required to do capture and replay for shader group handles.

• maxRayDispatchInvocationCount :: Word32

  maxRayDispatchInvocationCount is the maximum number of ray generation shader invocations which may be produced by a single cmdTraceRaysIndirectKHR or cmdTraceRaysKHR command.

• shaderGroupHandleAlignment :: Word32

  shaderGroupHandleAlignment is the required alignment in bytes for each shader binding table entry.

• maxRayHitAttributeSize :: Word32

  maxRayHitAttributeSize is the maximum size in bytes for a ray attribute structure

Instances

Eq PhysicalDeviceRayTracingPipelinePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: PhysicalDeviceRayTracingPipelinePropertiesKHR -> PhysicalDeviceRayTracingPipelinePropertiesKHR -> Bool

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

Show PhysicalDeviceRayTracingPipelinePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> PhysicalDeviceRayTracingPipelinePropertiesKHR -> ShowS

show :: PhysicalDeviceRayTracingPipelinePropertiesKHR -> String

showList :: [PhysicalDeviceRayTracingPipelinePropertiesKHR] -> ShowS

Storable PhysicalDeviceRayTracingPipelinePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: PhysicalDeviceRayTracingPipelinePropertiesKHR -> Int

alignment :: PhysicalDeviceRayTracingPipelinePropertiesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceRayTracingPipelinePropertiesKHR -> Int -> IO PhysicalDeviceRayTracingPipelinePropertiesKHR

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

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

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

peek :: Ptr PhysicalDeviceRayTracingPipelinePropertiesKHR -> IO PhysicalDeviceRayTracingPipelinePropertiesKHR

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

FromCStruct PhysicalDeviceRayTracingPipelinePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr PhysicalDeviceRayTracingPipelinePropertiesKHR -> IO PhysicalDeviceRayTracingPipelinePropertiesKHR

ToCStruct PhysicalDeviceRayTracingPipelinePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

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

pokeCStruct :: Ptr PhysicalDeviceRayTracingPipelinePropertiesKHR -> PhysicalDeviceRayTracingPipelinePropertiesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceRayTracingPipelinePropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceRayTracingPipelinePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: PhysicalDeviceRayTracingPipelinePropertiesKHR

data StridedDeviceAddressRegionKHR

VkStridedDeviceAddressRegionKHR - Structure specifying a region of device addresses with a stride

Valid Usage

• If size is not zero, all addresses between deviceAddress and deviceAddress + size - 1 must be in the buffer device address range of the same buffer

• If size is not zero, stride must be less than or equal to the size of the buffer from which deviceAddress was queried

See Also

DeviceAddress, DeviceSize, cmdTraceRaysIndirectKHR, cmdTraceRaysKHR

Constructors

StridedDeviceAddressRegionKHR

Fields

• deviceAddress :: DeviceAddress

  deviceAddress is the device address (as returned by the getBufferDeviceAddress command) at which the region starts, or zero if the region is unused.

• stride :: DeviceSize

  stride is the byte stride between consecutive elements.

• size :: DeviceSize

  size is the size in bytes of the region starting at deviceAddress.

Instances

Eq StridedDeviceAddressRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: StridedDeviceAddressRegionKHR -> StridedDeviceAddressRegionKHR -> Bool

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

Show StridedDeviceAddressRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> StridedDeviceAddressRegionKHR -> ShowS

show :: StridedDeviceAddressRegionKHR -> String

showList :: [StridedDeviceAddressRegionKHR] -> ShowS

Storable StridedDeviceAddressRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: StridedDeviceAddressRegionKHR -> Int

alignment :: StridedDeviceAddressRegionKHR -> Int

peekElemOff :: Ptr StridedDeviceAddressRegionKHR -> Int -> IO StridedDeviceAddressRegionKHR

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

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

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

peek :: Ptr StridedDeviceAddressRegionKHR -> IO StridedDeviceAddressRegionKHR

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

FromCStruct StridedDeviceAddressRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr StridedDeviceAddressRegionKHR -> IO StridedDeviceAddressRegionKHR

ToCStruct StridedDeviceAddressRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

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

pokeCStruct :: Ptr StridedDeviceAddressRegionKHR -> StridedDeviceAddressRegionKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr StridedDeviceAddressRegionKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero StridedDeviceAddressRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: StridedDeviceAddressRegionKHR

data TraceRaysIndirectCommandKHR

VkTraceRaysIndirectCommandKHR - Structure specifying the parameters of an indirect trace ray command

Description

The members of TraceRaysIndirectCommandKHR have the same meaning as the similarly named parameters of cmdTraceRaysKHR.

Valid Usage

See Also

No cross-references are available

Constructors

TraceRaysIndirectCommandKHR

Fields

• width :: Word32

  width is the width of the ray trace query dimensions.

  width must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0] × PhysicalDeviceLimits::maxComputeWorkGroupSize[0]

  width × height × depth must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayDispatchInvocationCount

• height :: Word32

  height is height of the ray trace query dimensions.

  height must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1] × PhysicalDeviceLimits::maxComputeWorkGroupSize[1]

• depth :: Word32

  depth is depth of the ray trace query dimensions.

  depth must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2] × PhysicalDeviceLimits::maxComputeWorkGroupSize[2]

Instances

Eq TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: TraceRaysIndirectCommandKHR -> TraceRaysIndirectCommandKHR -> Bool

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

Show TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> TraceRaysIndirectCommandKHR -> ShowS

show :: TraceRaysIndirectCommandKHR -> String

showList :: [TraceRaysIndirectCommandKHR] -> ShowS

Storable TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: TraceRaysIndirectCommandKHR -> Int

alignment :: TraceRaysIndirectCommandKHR -> Int

peekElemOff :: Ptr TraceRaysIndirectCommandKHR -> Int -> IO TraceRaysIndirectCommandKHR

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

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

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

peek :: Ptr TraceRaysIndirectCommandKHR -> IO TraceRaysIndirectCommandKHR

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

FromCStruct TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr TraceRaysIndirectCommandKHR -> IO TraceRaysIndirectCommandKHR

ToCStruct TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

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

pokeCStruct :: Ptr TraceRaysIndirectCommandKHR -> TraceRaysIndirectCommandKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr TraceRaysIndirectCommandKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: TraceRaysIndirectCommandKHR

data RayTracingPipelineInterfaceCreateInfoKHR

VkRayTracingPipelineInterfaceCreateInfoKHR - Structure specifying additional interface information when using libraries

Description

maxPipelineRayPayloadSize is calculated as the maximum number of bytes used by any block declared in the RayPayloadKHR or IncomingRayPayloadKHR storage classes. maxPipelineRayHitAttributeSize is calculated as the maximum number of bytes used by any block declared in the HitAttributeKHR storage class. As variables in these storage classes do not have explicit offsets, the size should be calculated as if each variable has a scalar alignment equal to the largest scalar alignment of any of the block’s members.

Note

There is no explicit upper limit for maxPipelineRayPayloadSize, but in practice it should be kept as small as possible. Similar to invocation local memory, it must be allocated for each shader invocation and for devices which support many simultaneous invocations, this storage can rapidly be exhausted, resulting in failure.

Valid Usage (Implicit)

See Also

RayTracingPipelineCreateInfoKHR, StructureType

Constructors

RayTracingPipelineInterfaceCreateInfoKHR

Fields

• maxPipelineRayPayloadSize :: Word32

  maxPipelineRayPayloadSize is the maximum payload size in bytes used by any shader in the pipeline.

• maxPipelineRayHitAttributeSize :: Word32

  maxPipelineRayHitAttributeSize is the maximum attribute structure size in bytes used by any shader in the pipeline.

  maxPipelineRayHitAttributeSize must be less than or equal to PhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayHitAttributeSize

Instances

Eq RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: RayTracingPipelineInterfaceCreateInfoKHR -> RayTracingPipelineInterfaceCreateInfoKHR -> Bool

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

Show RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> RayTracingPipelineInterfaceCreateInfoKHR -> ShowS

show :: RayTracingPipelineInterfaceCreateInfoKHR -> String

showList :: [RayTracingPipelineInterfaceCreateInfoKHR] -> ShowS

Storable RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: RayTracingPipelineInterfaceCreateInfoKHR -> Int

alignment :: RayTracingPipelineInterfaceCreateInfoKHR -> Int

peekElemOff :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> Int -> IO RayTracingPipelineInterfaceCreateInfoKHR

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

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

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

peek :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> IO RayTracingPipelineInterfaceCreateInfoKHR

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

FromCStruct RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

peekCStruct :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> IO RayTracingPipelineInterfaceCreateInfoKHR

ToCStruct RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

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

pokeCStruct :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> RayTracingPipelineInterfaceCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: RayTracingPipelineInterfaceCreateInfoKHR

newtype RayTracingShaderGroupTypeKHR

VkRayTracingShaderGroupTypeKHR - Shader group types

Description

Note

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

RayTracingShaderGroupCreateInfoKHR, RayTracingShaderGroupCreateInfoNV

Constructors

RayTracingShaderGroupTypeKHR Int32

Bundled Patterns

pattern RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR :: RayTracingShaderGroupTypeKHR

RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR indicates a shader group with a single SHADER_STAGE_RAYGEN_BIT_KHR, SHADER_STAGE_MISS_BIT_KHR, or SHADER_STAGE_CALLABLE_BIT_KHR shader in it.

pattern RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR :: RayTracingShaderGroupTypeKHR

RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR specifies a shader group that only hits triangles and must not contain an intersection shader, only closest hit and any-hit shaders.

pattern RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR :: RayTracingShaderGroupTypeKHR

RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR specifies a shader group that only intersects with custom geometry and must contain an intersection shader and may contain closest hit and any-hit shaders.

Instances

Eq RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> Bool

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

Ord RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

compare :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> Ordering

(<) :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> Bool

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

(>) :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> Bool

(>=) :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> Bool

max :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR

min :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR

Read RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

readsPrec :: Int -> ReadS RayTracingShaderGroupTypeKHR

readList :: ReadS [RayTracingShaderGroupTypeKHR]

readPrec :: ReadPrec RayTracingShaderGroupTypeKHR

readListPrec :: ReadPrec [RayTracingShaderGroupTypeKHR]

Show RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> RayTracingShaderGroupTypeKHR -> ShowS

show :: RayTracingShaderGroupTypeKHR -> String

showList :: [RayTracingShaderGroupTypeKHR] -> ShowS

Storable RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: RayTracingShaderGroupTypeKHR -> Int

alignment :: RayTracingShaderGroupTypeKHR -> Int

peekElemOff :: Ptr RayTracingShaderGroupTypeKHR -> Int -> IO RayTracingShaderGroupTypeKHR

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

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

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

peek :: Ptr RayTracingShaderGroupTypeKHR -> IO RayTracingShaderGroupTypeKHR

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

Zero RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: RayTracingShaderGroupTypeKHR

newtype ShaderGroupShaderKHR

VkShaderGroupShaderKHR - Shader group shaders

See Also

getRayTracingShaderGroupStackSizeKHR

Constructors

ShaderGroupShaderKHR Int32

Bundled Patterns

pattern SHADER_GROUP_SHADER_GENERAL_KHR :: ShaderGroupShaderKHR

SHADER_GROUP_SHADER_GENERAL_KHR uses the shader specified in the group with RayTracingShaderGroupCreateInfoKHR::generalShader

pattern SHADER_GROUP_SHADER_CLOSEST_HIT_KHR :: ShaderGroupShaderKHR

SHADER_GROUP_SHADER_CLOSEST_HIT_KHR uses the shader specified in the group with RayTracingShaderGroupCreateInfoKHR::closestHitShader

pattern SHADER_GROUP_SHADER_ANY_HIT_KHR :: ShaderGroupShaderKHR

SHADER_GROUP_SHADER_ANY_HIT_KHR uses the shader specified in the group with RayTracingShaderGroupCreateInfoKHR::anyHitShader

pattern SHADER_GROUP_SHADER_INTERSECTION_KHR :: ShaderGroupShaderKHR

SHADER_GROUP_SHADER_INTERSECTION_KHR uses the shader specified in the group with RayTracingShaderGroupCreateInfoKHR::intersectionShader

Instances

Eq ShaderGroupShaderKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

(==) :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> Bool

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

Ord ShaderGroupShaderKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

compare :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> Ordering

(<) :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> Bool

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

(>) :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> Bool

(>=) :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> Bool

max :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> ShaderGroupShaderKHR

min :: ShaderGroupShaderKHR -> ShaderGroupShaderKHR -> ShaderGroupShaderKHR

Read ShaderGroupShaderKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

readsPrec :: Int -> ReadS ShaderGroupShaderKHR

readList :: ReadS [ShaderGroupShaderKHR]

readPrec :: ReadPrec ShaderGroupShaderKHR

readListPrec :: ReadPrec [ShaderGroupShaderKHR]

Show ShaderGroupShaderKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

showsPrec :: Int -> ShaderGroupShaderKHR -> ShowS

show :: ShaderGroupShaderKHR -> String

showList :: [ShaderGroupShaderKHR] -> ShowS

Storable ShaderGroupShaderKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

sizeOf :: ShaderGroupShaderKHR -> Int

alignment :: ShaderGroupShaderKHR -> Int

peekElemOff :: Ptr ShaderGroupShaderKHR -> Int -> IO ShaderGroupShaderKHR

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

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

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

peek :: Ptr ShaderGroupShaderKHR -> IO ShaderGroupShaderKHR

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

Zero ShaderGroupShaderKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: ShaderGroupShaderKHR

type KHR_RAY_TRACING_PIPELINE_SPEC_VERSION = 1

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

type KHR_RAY_TRACING_PIPELINE_EXTENSION_NAME = "VK_KHR_ray_tracing_pipeline"

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

newtype DeferredOperationKHR

VkDeferredOperationKHR - A deferred operation

Description

This handle refers to a tracking structure which manages the execution state for a deferred command.

See Also

buildAccelerationStructuresKHR, copyAccelerationStructureKHR, copyAccelerationStructureToMemoryKHR, copyMemoryToAccelerationStructureKHR, createDeferredOperationKHR, createRayTracingPipelinesKHR, deferredOperationJoinKHR, destroyDeferredOperationKHR, getDeferredOperationMaxConcurrencyKHR, getDeferredOperationResultKHR

Constructors

DeferredOperationKHR Word64

Instances

Eq DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: DeferredOperationKHR -> DeferredOperationKHR -> Bool

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

Ord DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: DeferredOperationKHR -> DeferredOperationKHR -> Ordering

(<) :: DeferredOperationKHR -> DeferredOperationKHR -> Bool

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

(>) :: DeferredOperationKHR -> DeferredOperationKHR -> Bool

(>=) :: DeferredOperationKHR -> DeferredOperationKHR -> Bool

max :: DeferredOperationKHR -> DeferredOperationKHR -> DeferredOperationKHR

min :: DeferredOperationKHR -> DeferredOperationKHR -> DeferredOperationKHR

Show DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DeferredOperationKHR -> ShowS

show :: DeferredOperationKHR -> String

showList :: [DeferredOperationKHR] -> ShowS

Storable DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: DeferredOperationKHR -> Int

alignment :: DeferredOperationKHR -> Int

peekElemOff :: Ptr DeferredOperationKHR -> Int -> IO DeferredOperationKHR

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

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

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

peek :: Ptr DeferredOperationKHR -> IO DeferredOperationKHR

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

Zero DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DeferredOperationKHR

HasObjectType DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DeferredOperationKHR -> (ObjectType, Word64)

IsHandle DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

data PipelineLibraryCreateInfoKHR

VkPipelineLibraryCreateInfoKHR - Structure specifying pipeline libraries to use when creating a pipeline

Valid Usage

• Each element of pLibraries must have been created with PIPELINE_CREATE_LIBRARY_BIT_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR

• pNext must be NULL
• If libraryCount is not 0, pLibraries must be a valid pointer to an array of libraryCount valid Pipeline handles

See Also

Pipeline, RayTracingPipelineCreateInfoKHR, StructureType

Constructors

PipelineLibraryCreateInfoKHR

Fields

• libraries :: Vector Pipeline

  pLibraries is a pointer to an array of Pipeline structures specifying pipeline libraries to use when creating a pipeline.

Instances

Show PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

showsPrec :: Int -> PipelineLibraryCreateInfoKHR -> ShowS

show :: PipelineLibraryCreateInfoKHR -> String

showList :: [PipelineLibraryCreateInfoKHR] -> ShowS

FromCStruct PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

peekCStruct :: Ptr PipelineLibraryCreateInfoKHR -> IO PipelineLibraryCreateInfoKHR

ToCStruct PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

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

pokeCStruct :: Ptr PipelineLibraryCreateInfoKHR -> PipelineLibraryCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PipelineLibraryCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

zero :: PipelineLibraryCreateInfoKHR

type SHADER_UNUSED_KHR = 4294967295

pattern SHADER_UNUSED_KHR :: Word32