Vulkan.Extensions.VK_NV_ray_tracing

Name

VK_NV_ray_tracing - device extension

VK_NV_ray_tracing

Name String

VK_NV_ray_tracing

Extension Type

Device extension

Registered Extension Number

166

Revision

3

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2 to be enabled for any device-level functionality
• Requires VK_KHR_get_memory_requirements2 to be enabled for any device-level functionality

Contact

• Eric Werness @ewerness-nv%0A*Here describe the issue or question you have about the VK_NV_ray_tracing extension*

Other Extension Metadata

Last Modified Date

2018-11-20

Interactions and External Dependencies

• This extension requires SPV_NV_ray_tracing
• This extension provides API support for GL_NV_ray_tracing

Contributors

• Eric Werness, NVIDIA
• Ashwin Lele, NVIDIA
• Robert Stepinski, NVIDIA
• Nuno Subtil, NVIDIA
• Christoph Kubisch, NVIDIA
• Martin Stich, NVIDIA
• Daniel Koch, NVIDIA
• Jeff Bolz, NVIDIA
• Joshua Barczak, Intel
• Tobias Hector, AMD
• Henrik Rydgard, NVIDIA
• Pascal Gautron, NVIDIA

Description

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

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

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

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

• SPV_NV_ray_tracing

New Object Types

• AccelerationStructureNV

New Commands

• bindAccelerationStructureMemoryNV

• cmdBuildAccelerationStructureNV
• cmdCopyAccelerationStructureNV
• cmdTraceRaysNV
• cmdWriteAccelerationStructuresPropertiesNV
• compileDeferredNV
• createAccelerationStructureNV
• createRayTracingPipelinesNV
• destroyAccelerationStructureNV
• getAccelerationStructureHandleNV
• getAccelerationStructureMemoryRequirementsNV
• getRayTracingShaderGroupHandlesNV

New Structures

• AabbPositionsNV

• AccelerationStructureCreateInfoNV
• AccelerationStructureInfoNV
• AccelerationStructureInstanceNV
• AccelerationStructureMemoryRequirementsInfoNV
• BindAccelerationStructureMemoryInfoNV
• GeometryAABBNV
• GeometryDataNV
• GeometryNV
• GeometryTrianglesNV
• MemoryRequirements2KHR
• RayTracingPipelineCreateInfoNV
• RayTracingShaderGroupCreateInfoNV
• TransformMatrixNV

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceRayTracingPropertiesNV

• Extending WriteDescriptorSet:

  • WriteDescriptorSetAccelerationStructureNV

New Enums

• AccelerationStructureMemoryRequirementsTypeNV

• AccelerationStructureTypeNV
• BuildAccelerationStructureFlagBitsNV
• CopyAccelerationStructureModeNV
• GeometryFlagBitsNV
• GeometryInstanceFlagBitsNV
• GeometryTypeNV
• RayTracingShaderGroupTypeNV

New Bitmasks

• BuildAccelerationStructureFlagsNV

• GeometryFlagsNV
• GeometryInstanceFlagsNV

New Enum Constants

• NV_RAY_TRACING_EXTENSION_NAME

• NV_RAY_TRACING_SPEC_VERSION
• SHADER_UNUSED_NV

• Extending AccelerationStructureTypeKHR:

  • ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV
  • ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NV

• Extending AccessFlagBits:

  • ACCESS_ACCELERATION_STRUCTURE_READ_BIT_NV
  • ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_NV

• Extending BufferUsageFlagBits:

  • BUFFER_USAGE_RAY_TRACING_BIT_NV

• Extending BuildAccelerationStructureFlagBitsKHR:

  • BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_NV
  • BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_NV
  • BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_NV
  • BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NV
  • BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NV

• Extending CopyAccelerationStructureModeKHR:

  • COPY_ACCELERATION_STRUCTURE_MODE_CLONE_NV
  • COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_NV

• Extending DebugReportObjectTypeEXT:

  • DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_NV_EXT

• Extending DescriptorType:

  • DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV

• Extending GeometryFlagBitsKHR:

  • GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_NV
  • GEOMETRY_OPAQUE_BIT_NV

• Extending GeometryInstanceFlagBitsKHR:

  • GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_NV
  • GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_NV
  • GEOMETRY_INSTANCE_TRIANGLE_CULL_DISABLE_BIT_NV
  • GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_NV

• Extending GeometryTypeKHR:

  • GEOMETRY_TYPE_AABBS_NV
  • GEOMETRY_TYPE_TRIANGLES_NV

• Extending IndexType:

  • INDEX_TYPE_NONE_NV

• Extending ObjectType:

  • OBJECT_TYPE_ACCELERATION_STRUCTURE_NV

• Extending PipelineBindPoint:

  • PIPELINE_BIND_POINT_RAY_TRACING_NV

• Extending PipelineCreateFlagBits:

  • PIPELINE_CREATE_DEFER_COMPILE_BIT_NV

• Extending PipelineStageFlagBits:

  • PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_NV
  • PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_NV

• Extending QueryType:

  • QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_NV

• Extending RayTracingShaderGroupTypeKHR:

  • RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV
  • RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV
  • RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV

• Extending ShaderStageFlagBits:

  • SHADER_STAGE_ANY_HIT_BIT_NV
  • SHADER_STAGE_CALLABLE_BIT_NV
  • SHADER_STAGE_CLOSEST_HIT_BIT_NV
  • SHADER_STAGE_INTERSECTION_BIT_NV
  • SHADER_STAGE_MISS_BIT_NV
  • SHADER_STAGE_RAYGEN_BIT_NV

• Extending StructureType:

  • STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_NV
  • STRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NV
  • STRUCTURE_TYPE_ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_INFO_NV
  • STRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NV
  • STRUCTURE_TYPE_GEOMETRY_AABB_NV
  • STRUCTURE_TYPE_GEOMETRY_NV
  • STRUCTURE_TYPE_GEOMETRY_TRIANGLES_NV
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_PROPERTIES_NV
  • STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NV
  • STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_NV
  • STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_NV

New or Modified Built-In Variables

• LaunchIdNV

• LaunchSizeNV
• WorldRayOriginNV
• WorldRayDirectionNV
• ObjectRayOriginNV
• ObjectRayDirectionNV
• RayTminNV
• RayTmaxNV
• InstanceCustomIndexNV
• InstanceId
• ObjectToWorldNV
• WorldToObjectNV
• HitTNV
• HitKindNV
• IncomingRayFlagsNV
• (modified)PrimitiveId

New SPIR-V Capabilities

• RayTracingNV

Issues

1) Are there issues?

RESOLVED: Yes.

Sample Code

Example ray generation GLSL shader

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

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

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

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

   col.y = payload;

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

Version History

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

  • Internal revisions

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

  • rename to VK_NV_ray_tracing, add support for callables.
  • too many updates to list

• Revision 3, 2018-11-20 (Daniel Koch)

  • update to use InstanceId instead of InstanceIndex as implemented.

See Also

SHADER_UNUSED_NV, AabbPositionsNV, AccelerationStructureCreateInfoNV, AccelerationStructureInfoNV, AccelerationStructureInstanceNV, AccelerationStructureMemoryRequirementsInfoNV, AccelerationStructureMemoryRequirementsTypeNV, AccelerationStructureNV, AccelerationStructureTypeNV, BindAccelerationStructureMemoryInfoNV, BuildAccelerationStructureFlagBitsNV, BuildAccelerationStructureFlagsNV, CopyAccelerationStructureModeNV, GeometryAABBNV, GeometryDataNV, GeometryFlagBitsNV, GeometryFlagsNV, GeometryInstanceFlagBitsNV, GeometryInstanceFlagsNV, GeometryNV, GeometryTrianglesNV, GeometryTypeNV, MemoryRequirements2KHR, PhysicalDeviceRayTracingPropertiesNV, RayTracingPipelineCreateInfoNV, RayTracingShaderGroupCreateInfoNV, RayTracingShaderGroupTypeNV, TransformMatrixNV, WriteDescriptorSetAccelerationStructureNV, bindAccelerationStructureMemoryNV, cmdBuildAccelerationStructureNV, cmdCopyAccelerationStructureNV, cmdTraceRaysNV, cmdWriteAccelerationStructuresPropertiesNV, compileDeferredNV, createAccelerationStructureNV, createRayTracingPipelinesNV, destroyAccelerationStructureNV, getAccelerationStructureHandleNV, getAccelerationStructureMemoryRequirementsNV, getRayTracingShaderGroupHandlesNV

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

compileDeferredNV

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device containing the ray tracing pipeline.

device must be a valid Device handle

-> Pipeline

pipeline is the ray tracing pipeline object containing the shaders.

pipeline must be a ray tracing pipeline

pipeline must have been created with PIPELINE_CREATE_DEFER_COMPILE_BIT_NV

pipeline must be a valid Pipeline handle

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

-> ("shader" ::: Word32)

shader is the index of the shader to compile.

shader must not have been called as a deferred compile before

-> io ()

vkCompileDeferredNV - Deferred compilation of shaders

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_NV_ray_tracing, Device, Pipeline

createAccelerationStructureNV

Arguments

:: forall a io. (Extendss AccelerationStructureCreateInfoNV a, PokeChain a, MonadIO io)

=> Device

device is the logical device that creates the buffer object.

-> AccelerationStructureCreateInfoNV a

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

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

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

-> io AccelerationStructureNV

vkCreateAccelerationStructureNV - Create a new acceleration structure object

Description

Similarly to other objects in Vulkan, the acceleration structure creation merely creates an object with a specific “shape” as specified by the information in AccelerationStructureInfoNV and compactedSize in pCreateInfo. Populating the data in the object after allocating and binding memory is done with cmdBuildAccelerationStructureNV and cmdCopyAccelerationStructureNV.

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

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid AccelerationStructureCreateInfoNV structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pAccelerationStructure must be a valid pointer to a AccelerationStructureNV handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_NV_ray_tracing, AccelerationStructureCreateInfoNV, AccelerationStructureNV, AllocationCallbacks, Device

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

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

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

destroyAccelerationStructureNV

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the buffer.

-> AccelerationStructureNV

accelerationStructure is the acceleration structure to destroy.

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

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

-> io ()

vkDestroyAccelerationStructureNV - Destroy an acceleration structure object

Valid Usage

• All submitted commands that refer to accelerationStructure must have completed execution

• If AllocationCallbacks were provided when accelerationStructure was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when accelerationStructure was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

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

Host Synchronization

• Host access to accelerationStructure must be externally synchronized

See Also

VK_NV_ray_tracing, AccelerationStructureNV, AllocationCallbacks, Device

getAccelerationStructureMemoryRequirementsNV

Arguments

:: forall a io. (Extendss MemoryRequirements2KHR a, PokeChain a, PeekChain a, MonadIO io)

=> Device

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

device must be a valid Device handle

-> AccelerationStructureMemoryRequirementsInfoNV

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

pInfo must be a valid pointer to a valid AccelerationStructureMemoryRequirementsInfoNV structure

-> io (MemoryRequirements2KHR a)

vkGetAccelerationStructureMemoryRequirementsNV - Get acceleration structure memory requirements

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureMemoryRequirementsInfoNV, Device, MemoryRequirements2KHR

bindAccelerationStructureMemoryNV

Arguments

:: forall io. MonadIO io

=> Device

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

device must be a valid Device handle

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

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

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

-> io ()

vkBindAccelerationStructureMemoryNV - Bind acceleration structure memory

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_NV_ray_tracing, BindAccelerationStructureMemoryInfoNV, Device

cmdCopyAccelerationStructureNV

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("dst" ::: AccelerationStructureNV)

dst is the target acceleration structure for the copy.

-> ("src" ::: AccelerationStructureNV)

src is the source acceleration structure for the copy.

-> CopyAccelerationStructureModeKHR

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

-> io ()

vkCmdCopyAccelerationStructureNV - Copy an acceleration structure

Description

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

Valid Usage

• mode must be COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR or COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR

• The source acceleration structure src must have been constructed prior to the execution of this command
• If mode is COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR, src must have been constructed with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR in the build
• The buffer used to create src must be bound to device memory
• The buffer used to create dst must be bound to device memory
• The range of memory backing dst that is accessed by this command must not overlap the memory backing src that is accessed by this command
• dst must be bound completely and contiguously to a single DeviceMemory object via bindAccelerationStructureMemoryNV

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• dst must be a valid AccelerationStructureNV handle
• src must be a valid AccelerationStructureNV handle
• mode must be a valid CopyAccelerationStructureModeKHR value
• 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
• This command must only be called outside of a video coding scope
• Each of commandBuffer, dst, and src must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	Compute	Action

See Also

VK_NV_ray_tracing, AccelerationStructureNV, CommandBuffer, CopyAccelerationStructureModeKHR

cmdWriteAccelerationStructuresPropertiesNV

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

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

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

-> QueryType

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

-> QueryPool

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

-> ("firstQuery" ::: Word32)

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

-> io ()

vkCmdWriteAccelerationStructuresPropertiesNV - Write acceleration structure result parameters to query results.

Description

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

Valid Usage

• queryPool must have been created with a queryType matching queryType

• The queries identified by queryPool and firstQuery must be unavailable
• accelerationStructure must be bound completely and contiguously to a single DeviceMemory object via bindAccelerationStructureMemoryNV
• All acceleration structures in pAccelerationStructures must have been built prior to the execution of this command
• All acceleration structures in pAccelerationStructures must have been built with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_NV
• queryType must be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_NV

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	Compute	Action

See Also

VK_NV_ray_tracing, AccelerationStructureNV, CommandBuffer, QueryPool, QueryType

cmdBuildAccelerationStructureNV

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> AccelerationStructureInfoNV

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

-> ("instanceData" ::: Buffer)

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

-> ("instanceOffset" ::: DeviceSize)

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

-> ("update" ::: Bool)

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

-> ("dst" ::: AccelerationStructureNV)

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

-> ("src" ::: AccelerationStructureNV)

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

-> ("scratch" ::: Buffer)

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

-> ("scratchOffset" ::: DeviceSize)

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

-> io ()

vkCmdBuildAccelerationStructureNV - Build an acceleration structure

Description

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

Valid Usage

• geometryCount must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxGeometryCount

• dst must have been created with compatible AccelerationStructureInfoNV where AccelerationStructureInfoNV::type and AccelerationStructureInfoNV::flags are identical, AccelerationStructureInfoNV::instanceCount and AccelerationStructureInfoNV::geometryCount for dst are greater than or equal to the build size and each geometry in AccelerationStructureInfoNV::pGeometries for dst has greater than or equal to the number of vertices, indices, and AABBs
• If update is TRUE, src must not be NULL_HANDLE
• If update is TRUE, src must have previously been constructed with BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_NV set in AccelerationStructureInfoNV::flags in the original build
• If update is FALSE, the size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with AccelerationStructureMemoryRequirementsInfoNV::accelerationStructure set to dst and AccelerationStructureMemoryRequirementsInfoNV::type set to ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV must be less than or equal to the size of scratch minus scratchOffset
• If update is TRUE, the size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with AccelerationStructureMemoryRequirementsInfoNV::accelerationStructure set to dst and AccelerationStructureMemoryRequirementsInfoNV::type set to ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV must be less than or equal to the size of scratch minus scratchOffset
• scratch must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
• If instanceData is not NULL_HANDLE, instanceData must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
• Each AccelerationStructureInstanceKHR::accelerationStructureReference value in instanceData must be a valid device address containing a value obtained from getAccelerationStructureHandleNV
• If update is TRUE, then objects that were previously active must not be made inactive as per https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#acceleration-structure-inactive-prims
• If update is TRUE, then objects that were previously inactive must not be made active as per https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#acceleration-structure-inactive-prims
• If update is TRUE, the src and dst objects must either be the same object or not have any memory aliasing
• dst must be bound completely and contiguously to a single DeviceMemory object via bindAccelerationStructureMemoryNV

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	Compute	Action

See Also

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

cmdTraceRaysNV

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("raygenShaderBindingTableBuffer" ::: Buffer)

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

-> ("raygenShaderBindingOffset" ::: DeviceSize)

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

-> ("missShaderBindingTableBuffer" ::: Buffer)

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

-> ("missShaderBindingOffset" ::: DeviceSize)

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

-> ("missShaderBindingStride" ::: DeviceSize)

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

-> ("hitShaderBindingTableBuffer" ::: Buffer)

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

-> ("hitShaderBindingOffset" ::: DeviceSize)

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

-> ("hitShaderBindingStride" ::: DeviceSize)

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

-> ("callableShaderBindingTableBuffer" ::: Buffer)

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

-> ("callableShaderBindingOffset" ::: DeviceSize)

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

-> ("callableShaderBindingStride" ::: DeviceSize)

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

-> ("width" ::: Word32)

width is the width of the ray trace query dimensions.

-> ("height" ::: Word32)

height is height of the ray trace query dimensions.

-> ("depth" ::: Word32)

depth is depth of the ray trace query dimensions.

-> io ()

vkCmdTraceRaysNV - Initialize a ray tracing dispatch

Description

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

Valid Usage

• 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 sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_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 any ImageView being written as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• For any ImageView being read as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For any BufferView being written as a storage texel buffer where the image format field of the OpTypeImage is Unknown, the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any BufferView being read as a storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• 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 ???
• If the maintenance4 feature is not enabled, then 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 and the bound Pipeline was not created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the Pipeline bound to the pipeline bind point were specified via cmdBindDescriptorSets, the bound Pipeline must have been created without PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via cmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by the Pipeline bound to the pipeline bind point used by this command and the bound Pipeline was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the Pipeline bound to the pipeline bind point were specified via cmdSetDescriptorBufferOffsetsEXT, the bound Pipeline must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If a descriptor is dynamically used with a Pipeline created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• 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 (if the VK_NV_inherited_viewport_scissor extension is enabled) 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 any stage of the Pipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXT or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXT for uniformBuffers, and the robustBufferAccess feature is not enabled, that stage 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 any stage of the Pipeline object bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXT or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXT for storageBuffers, and the robustBufferAccess feature is not enabled, that stage 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 and protectedNoFault is not supported, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler or ImageView object that enables sampler Y′CBCR conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler or ImageView object that enables sampler Y′CBCR conversion, that object must not use the ConstOffset and Offset operands
• If a ImageView is accessed as a result of this command, then the image view’s viewType must match the Dim operand of the OpTypeImage as described in ???
• If a ImageView is accessed as a result of this command, then the image view’s format must match the numeric format from the Sampled Type operand of the OpTypeImage as described in the SPIR-V Sampled Type column of the ??? table
• 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 component 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 component 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 component 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 component 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
• If OpImageWeightedSampleQCOM is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_SAMPLED_IMAGE_BIT_QCOM
• If OpImageWeightedSampleQCOM uses a ImageView as a sample weight image as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_IMAGE_BIT_QCOM
• If OpImageBoxFilterQCOM is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BOX_FILTER_SAMPLED_BIT_QCOM
• If OpImageBlockMatchSSDQCOM is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM or OpImageBlockMatchSSDQCOM is used to read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• If OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a Sampler as a result of this command, then the sampler must have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If any command other than OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a Sampler as a result of this command, then the sampler must not have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• Any shader invocation executed by this command must terminate
• Any shader group handle referenced by this call must have been queried from the currently bound ray tracing pipeline
• commandBuffer must not be a protected command buffer
• This command must not cause a pipeline trace ray instruction to be executed from a shader invocation with a recursion depth greater than the value of maxRecursionDepth used to create the bound ray tracing pipeline
• If raygenShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• raygenShaderBindingOffset must be less than the size of raygenShaderBindingTableBuffer
• raygenShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• If missShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• missShaderBindingOffset must be less than the size of missShaderBindingTableBuffer
• missShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• If hitShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• hitShaderBindingOffset must be less than the size of hitShaderBindingTableBuffer
• hitShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• If callableShaderBindingTableBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• callableShaderBindingOffset must be less than the size of callableShaderBindingTableBuffer
• callableShaderBindingOffset must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupBaseAlignment
• missShaderBindingStride must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupHandleSize
• hitShaderBindingStride must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupHandleSize
• callableShaderBindingStride must be a multiple of PhysicalDeviceRayTracingPropertiesNV::shaderGroupHandleSize
• missShaderBindingStride must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxShaderGroupStride
• hitShaderBindingStride must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxShaderGroupStride
• callableShaderBindingStride must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxShaderGroupStride
• width must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
• height must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
• depth must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2]

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	Compute	Action

See Also

VK_NV_ray_tracing, Buffer, CommandBuffer, DeviceSize

getAccelerationStructureHandleNV

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the acceleration structures.

device must be a valid Device handle

-> AccelerationStructureNV

accelerationStructure is the acceleration structure.

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

accelerationStructure must be a valid AccelerationStructureNV handle

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

-> ("dataSize" ::: Word64)

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

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

dataSize must be greater than 0

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

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

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

-> io ()

vkGetAccelerationStructureHandleNV - Get opaque acceleration structure handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_NV_ray_tracing, AccelerationStructureNV, Device

createRayTracingPipelinesNV

Arguments

:: forall io. MonadIO io

=> Device

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

-> PipelineCache

pipelineCache is either NULL_HANDLE, indicating that pipeline caching is disabled, or 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 RayTracingPipelineCreateInfoNV))

pCreateInfos is a pointer to an array of RayTracingPipelineCreateInfoNV structures.

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

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

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

vkCreateRayTracingPipelinesNV - Creates a new ray tracing pipeline object

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, host access to pipelineCache must be externally synchronized

Valid Usage (Implicit)

• device must be a valid Device handle

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

Return Codes

Success

• SUCCESS
• PIPELINE_COMPILE_REQUIRED_EXT

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

VK_NV_ray_tracing, AllocationCallbacks, Device, Pipeline, PipelineCache, RayTracingPipelineCreateInfoNV

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

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

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

pattern SHADER_STAGE_RAYGEN_BIT_NV :: ShaderStageFlagBits

pattern SHADER_STAGE_ANY_HIT_BIT_NV :: ShaderStageFlagBits

pattern SHADER_STAGE_CLOSEST_HIT_BIT_NV :: ShaderStageFlagBits

pattern SHADER_STAGE_MISS_BIT_NV :: ShaderStageFlagBits

pattern SHADER_STAGE_INTERSECTION_BIT_NV :: ShaderStageFlagBits

pattern SHADER_STAGE_CALLABLE_BIT_NV :: ShaderStageFlagBits

pattern PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_NV :: PipelineStageFlagBits

pattern PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_NV :: PipelineStageFlagBits

pattern BUFFER_USAGE_RAY_TRACING_BIT_NV :: BufferUsageFlagBits

pattern PIPELINE_BIND_POINT_RAY_TRACING_NV :: PipelineBindPoint

pattern ACCESS_ACCELERATION_STRUCTURE_READ_BIT_NV :: AccessFlagBits

pattern ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_NV :: AccessFlagBits

pattern INDEX_TYPE_NONE_NV :: IndexType

pattern RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV :: RayTracingShaderGroupTypeKHR

pattern RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV :: RayTracingShaderGroupTypeKHR

pattern RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV :: RayTracingShaderGroupTypeKHR

pattern GEOMETRY_TYPE_TRIANGLES_NV :: GeometryTypeKHR

pattern GEOMETRY_TYPE_AABBS_NV :: GeometryTypeKHR

pattern ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NV :: AccelerationStructureTypeKHR

pattern ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV :: AccelerationStructureTypeKHR

pattern GEOMETRY_OPAQUE_BIT_NV :: GeometryFlagBitsKHR

pattern GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_NV :: GeometryFlagBitsKHR

pattern GEOMETRY_INSTANCE_TRIANGLE_CULL_DISABLE_BIT_NV :: GeometryInstanceFlagBitsKHR

pattern GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_NV :: GeometryInstanceFlagBitsKHR

pattern GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_NV :: GeometryInstanceFlagBitsKHR

pattern GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_NV :: GeometryInstanceFlagBitsKHR

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

pattern BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

pattern COPY_ACCELERATION_STRUCTURE_MODE_CLONE_NV :: CopyAccelerationStructureModeKHR

pattern COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_NV :: CopyAccelerationStructureModeKHR

pattern SHADER_UNUSED_NV :: Word32

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

data RayTracingShaderGroupCreateInfoNV

VkRayTracingShaderGroupCreateInfoNV - Structure specifying shaders in a shader group

Valid Usage

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV then generalShader must be a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_RAYGEN_BIT_NV, SHADER_STAGE_MISS_BIT_NV, or SHADER_STAGE_CALLABLE_BIT_NV

• If type is RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV then closestHitShader, anyHitShader, and intersectionShader must be SHADER_UNUSED_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV then intersectionShader must be a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_INTERSECTION_BIT_NV
• If type is RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV then intersectionShader must be SHADER_UNUSED_NV
• closestHitShader must be either SHADER_UNUSED_NV or a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_CLOSEST_HIT_BIT_NV
• anyHitShader must be either SHADER_UNUSED_NV or a valid index into RayTracingPipelineCreateInfoNV::pStages referring to a shader of SHADER_STAGE_ANY_HIT_BIT_NV

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_NV

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

See Also

VK_NV_ray_tracing, RayTracingPipelineCreateInfoNV, RayTracingShaderGroupTypeKHR, StructureType

Constructors

RayTracingShaderGroupCreateInfoNV

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 RayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV, and SHADER_UNUSED_NV otherwise.

• closestHitShader :: Word32

  closestHitShader is the optional index of the closest hit shader from RayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.

• anyHitShader :: Word32

  anyHitShader is the optional index of the any-hit shader from RayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.

• intersectionShader :: Word32

  intersectionShader is the index of the intersection shader from RayTracingPipelineCreateInfoNV::pStages in the group if the shader group has type of RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV, and SHADER_UNUSED_NV otherwise.

Instances

Storable RayTracingShaderGroupCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: RayTracingShaderGroupCreateInfoNV -> Int

alignment :: RayTracingShaderGroupCreateInfoNV -> Int

peekElemOff :: Ptr RayTracingShaderGroupCreateInfoNV -> Int -> IO RayTracingShaderGroupCreateInfoNV

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

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

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

peek :: Ptr RayTracingShaderGroupCreateInfoNV -> IO RayTracingShaderGroupCreateInfoNV

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

Show RayTracingShaderGroupCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> RayTracingShaderGroupCreateInfoNV -> ShowS

show :: RayTracingShaderGroupCreateInfoNV -> String

showList :: [RayTracingShaderGroupCreateInfoNV] -> ShowS

Eq RayTracingShaderGroupCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

(==) :: RayTracingShaderGroupCreateInfoNV -> RayTracingShaderGroupCreateInfoNV -> Bool

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

FromCStruct RayTracingShaderGroupCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr RayTracingShaderGroupCreateInfoNV -> IO RayTracingShaderGroupCreateInfoNV

ToCStruct RayTracingShaderGroupCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr RayTracingShaderGroupCreateInfoNV -> RayTracingShaderGroupCreateInfoNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr RayTracingShaderGroupCreateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero RayTracingShaderGroupCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: RayTracingShaderGroupCreateInfoNV

data RayTracingPipelineCreateInfoNV (es :: [Type])

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

Description

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

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 or PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT
• The stage member of at least one element of pStages must be SHADER_STAGE_RAYGEN_BIT_KHR
• flags must not include PIPELINE_CREATE_LIBRARY_BIT_KHR
• maxRecursionDepth must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxRecursionDepth
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_ALLOW_MOTION_BIT_NV
• flags must not include both PIPELINE_CREATE_DEFER_COMPILE_BIT_NV and PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT at the same time
• If PipelineCreationFeedbackCreateInfo::pipelineStageCreationFeedbackCount is not 0, it must be equal to stageCount
• The stage value in all pStages elements must be one of SHADER_STAGE_RAYGEN_BIT_KHR, SHADER_STAGE_ANY_HIT_BIT_KHR, SHADER_STAGE_CLOSEST_HIT_BIT_KHR, SHADER_STAGE_MISS_BIT_KHR, SHADER_STAGE_INTERSECTION_BIT_KHR, or SHADER_STAGE_CALLABLE_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_OPACITY_MICROMAP_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NV

• pNext must be NULL or a pointer to a valid instance of PipelineCreationFeedbackCreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of PipelineCreateFlagBits values
• pStages must be a valid pointer to an array of stageCount valid PipelineShaderStageCreateInfo structures
• pGroups must be a valid pointer to an array of groupCount valid RayTracingShaderGroupCreateInfoNV structures
• layout must be a valid PipelineLayout handle
• stageCount must be greater than 0
• groupCount must be greater than 0
• 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

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

Constructors

RayTracingPipelineCreateInfoNV

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 PipelineShaderStageCreateInfo structures specifying the set of the shader stages to be included in the ray tracing pipeline.

• groups :: Vector RayTracingShaderGroupCreateInfoNV

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

• maxRecursionDepth :: Word32

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

• 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 RayTracingPipelineCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

extensibleTypeName :: String

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

setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). RayTracingPipelineCreateInfoNV ds -> Chain es -> RayTracingPipelineCreateInfoNV es

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

Show (Chain es) => Show (RayTracingPipelineCreateInfoNV es)

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> RayTracingPipelineCreateInfoNV es -> ShowS

show :: RayTracingPipelineCreateInfoNV es -> String

showList :: [RayTracingPipelineCreateInfoNV es] -> ShowS

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

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

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

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: RayTracingPipelineCreateInfoNV es

data GeometryTrianglesNV

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

Description

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

Valid Usage

• vertexOffset must be less than the size of vertexData

• vertexOffset must be a multiple of the component size of vertexFormat
• vertexFormat must be one of FORMAT_R32G32B32_SFLOAT, FORMAT_R32G32_SFLOAT, FORMAT_R16G16B16_SFLOAT, FORMAT_R16G16_SFLOAT, FORMAT_R16G16_SNORM, or FORMAT_R16G16B16_SNORM
• vertexStride must be less than or equal to 232-1
• indexOffset must be less than the size of indexData
• indexOffset must be a multiple of the element size of indexType
• indexType must be INDEX_TYPE_UINT16, INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_NV
• indexData must be NULL_HANDLE if indexType is INDEX_TYPE_NONE_NV
• indexData must be a valid Buffer handle if indexType is not INDEX_TYPE_NONE_NV
• indexCount must be 0 if indexType is INDEX_TYPE_NONE_NV
• transformOffset must be less than the size of transformData
• transformOffset must be a multiple of 16

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_GEOMETRY_TRIANGLES_NV

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

See Also

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

Constructors

GeometryTrianglesNV

Fields

• vertexData :: Buffer

  vertexData is the buffer containing vertex data for this geometry.

• vertexOffset :: DeviceSize

  vertexOffset is the offset in bytes within vertexData containing vertex data for this geometry.

• vertexCount :: Word32

  vertexCount is the number of valid vertices.

• vertexStride :: DeviceSize

  vertexStride is the stride in bytes between each vertex.

• vertexFormat :: Format

  vertexFormat is a Format describing the format of each vertex element.

• indexData :: Buffer

  indexData is the buffer containing index data for this geometry.

• indexOffset :: DeviceSize

  indexOffset is the offset in bytes within indexData containing index data for this geometry.

• indexCount :: Word32

  indexCount is the number of indices to include in this geometry.

• indexType :: IndexType

  indexType is a IndexType describing the format of each index.

• transformData :: Buffer

  transformData is an optional buffer containing an TransformMatrixNV structure defining a transformation to be applied to this geometry.

• transformOffset :: DeviceSize

  transformOffset is the offset in bytes in transformData of the transform information described above.

Instances

Storable GeometryTrianglesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: GeometryTrianglesNV -> Int

alignment :: GeometryTrianglesNV -> Int

peekElemOff :: Ptr GeometryTrianglesNV -> Int -> IO GeometryTrianglesNV

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

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

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

peek :: Ptr GeometryTrianglesNV -> IO GeometryTrianglesNV

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

Show GeometryTrianglesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> GeometryTrianglesNV -> ShowS

show :: GeometryTrianglesNV -> String

showList :: [GeometryTrianglesNV] -> ShowS

Eq GeometryTrianglesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

(==) :: GeometryTrianglesNV -> GeometryTrianglesNV -> Bool

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

FromCStruct GeometryTrianglesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr GeometryTrianglesNV -> IO GeometryTrianglesNV

ToCStruct GeometryTrianglesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr GeometryTrianglesNV -> GeometryTrianglesNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr GeometryTrianglesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero GeometryTrianglesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: GeometryTrianglesNV

data GeometryAABBNV

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

Description

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

Valid Usage

• offset must be less than the size of aabbData

• offset must be a multiple of 8
• stride must be a multiple of 8

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_GEOMETRY_AABB_NV

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

See Also

VK_NV_ray_tracing, Buffer, DeviceSize, GeometryDataNV, StructureType

Constructors

GeometryAABBNV

Fields

• aabbData :: Buffer

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

• numAABBs :: Word32

  numAABBs is the number of AABBs in this geometry.

• stride :: Word32

  stride is the stride in bytes between AABBs in aabbData.

• offset :: DeviceSize

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

Instances

Storable GeometryAABBNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: GeometryAABBNV -> Int

alignment :: GeometryAABBNV -> Int

peekElemOff :: Ptr GeometryAABBNV -> Int -> IO GeometryAABBNV

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

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

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

peek :: Ptr GeometryAABBNV -> IO GeometryAABBNV

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

Show GeometryAABBNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> GeometryAABBNV -> ShowS

show :: GeometryAABBNV -> String

showList :: [GeometryAABBNV] -> ShowS

Eq GeometryAABBNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

(==) :: GeometryAABBNV -> GeometryAABBNV -> Bool

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

FromCStruct GeometryAABBNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr GeometryAABBNV -> IO GeometryAABBNV

ToCStruct GeometryAABBNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr GeometryAABBNV -> GeometryAABBNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr GeometryAABBNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero GeometryAABBNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: GeometryAABBNV

data GeometryDataNV

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

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, GeometryAABBNV, GeometryNV, GeometryTrianglesNV

Constructors

GeometryDataNV

Fields

• triangles :: GeometryTrianglesNV

  triangles contains triangle data if GeometryNV::geometryType is GEOMETRY_TYPE_TRIANGLES_NV.

  triangles must be a valid GeometryTrianglesNV structure

• aabbs :: GeometryAABBNV

  aabbs contains axis-aligned bounding box data if GeometryNV::geometryType is GEOMETRY_TYPE_AABBS_NV.

  aabbs must be a valid GeometryAABBNV structure

Instances

Storable GeometryDataNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: GeometryDataNV -> Int

alignment :: GeometryDataNV -> Int

peekElemOff :: Ptr GeometryDataNV -> Int -> IO GeometryDataNV

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

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

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

peek :: Ptr GeometryDataNV -> IO GeometryDataNV

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

Show GeometryDataNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> GeometryDataNV -> ShowS

show :: GeometryDataNV -> String

showList :: [GeometryDataNV] -> ShowS

FromCStruct GeometryDataNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr GeometryDataNV -> IO GeometryDataNV

ToCStruct GeometryDataNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr GeometryDataNV -> GeometryDataNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr GeometryDataNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero GeometryDataNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: GeometryDataNV

data GeometryNV

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

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureInfoNV, GeometryDataNV, GeometryFlagsKHR, GeometryTypeKHR, StructureType

Constructors

GeometryNV

Fields

• geometryType :: GeometryTypeKHR

  geometryType specifies the GeometryTypeKHR which this geometry refers to.

  geometryType must be GEOMETRY_TYPE_TRIANGLES_NV or GEOMETRY_TYPE_AABBS_NV

  geometryType must be a valid GeometryTypeKHR value

• geometry :: GeometryDataNV

  geometry contains the geometry data as described in GeometryDataNV.

  geometry must be a valid GeometryDataNV structure

• flags :: GeometryFlagsKHR

  flags has GeometryFlagBitsKHR describing options for this geometry.

  flags must be a valid combination of GeometryFlagBitsKHR values

Instances

Storable GeometryNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: GeometryNV -> Int

alignment :: GeometryNV -> Int

peekElemOff :: Ptr GeometryNV -> Int -> IO GeometryNV

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

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

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

peek :: Ptr GeometryNV -> IO GeometryNV

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

Show GeometryNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> GeometryNV -> ShowS

show :: GeometryNV -> String

showList :: [GeometryNV] -> ShowS

FromCStruct GeometryNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr GeometryNV -> IO GeometryNV

ToCStruct GeometryNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr GeometryNV -> GeometryNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr GeometryNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero GeometryNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: GeometryNV

data AccelerationStructureInfoNV

VkAccelerationStructureInfoNV - Structure specifying the parameters of acceleration structure object

Description

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

Valid Usage

• geometryCount must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxGeometryCount

• instanceCount must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxInstanceCount
• The total number of triangles in all geometries must be less than or equal to PhysicalDeviceRayTracingPropertiesNV::maxTriangleCount
• If type is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NV then geometryCount must be 0
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV then instanceCount must be 0
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV then the geometryType member of each geometry in pGeometries must be the same
• type must not be ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR
• If flags has the BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NV bit set, then it must not have the BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NV bit set
• scratch must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
• If instanceData is not NULL_HANDLE, instanceData must have been created with BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NV

• pNext must be NULL
• type must be a valid AccelerationStructureTypeNV value
• flags must be a valid combination of BuildAccelerationStructureFlagBitsNV values
• If geometryCount is not 0, pGeometries must be a valid pointer to an array of geometryCount valid GeometryNV structures

See Also

VK_NV_ray_tracing, AccelerationStructureCreateInfoNV, AccelerationStructureTypeNV, BuildAccelerationStructureFlagsNV, GeometryNV, StructureType, cmdBuildAccelerationStructureNV

Constructors

AccelerationStructureInfoNV

Fields

• type' :: AccelerationStructureTypeNV

  type is a AccelerationStructureTypeNV value specifying the type of acceleration structure that will be created.

• flags :: BuildAccelerationStructureFlagsNV

  flags is a bitmask of BuildAccelerationStructureFlagBitsNV specifying additional parameters of the acceleration structure.

• instanceCount :: Word32

  instanceCount specifies the number of instances that will be in the new acceleration structure.

• geometries :: Vector GeometryNV

  pGeometries is a pointer to an array of geometryCount GeometryNV structures containing the scene data being passed into the acceleration structure.

Instances

Show AccelerationStructureInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureInfoNV -> ShowS

show :: AccelerationStructureInfoNV -> String

showList :: [AccelerationStructureInfoNV] -> ShowS

FromCStruct AccelerationStructureInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureInfoNV -> IO AccelerationStructureInfoNV

ToCStruct AccelerationStructureInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureInfoNV -> AccelerationStructureInfoNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: AccelerationStructureInfoNV

data AccelerationStructureCreateInfoNV (es :: [Type])

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

Valid Usage

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_NV

• pNext must be NULL or a pointer to a valid instance of OpaqueCaptureDescriptorDataCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• info must be a valid AccelerationStructureInfoNV structure

See Also

VK_NV_ray_tracing, AccelerationStructureInfoNV, DeviceSize, StructureType, createAccelerationStructureNV

Constructors

AccelerationStructureCreateInfoNV

Fields

• next :: Chain es

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

• compactedSize :: DeviceSize

  compactedSize is the size from the result of cmdWriteAccelerationStructuresPropertiesNV if this acceleration structure is going to be the target of a compacting copy.

• info :: AccelerationStructureInfoNV

  info is the AccelerationStructureInfoNV structure specifying further parameters of the created acceleration structure.

Instances

Extensible AccelerationStructureCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

extensibleTypeName :: String

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

setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). AccelerationStructureCreateInfoNV ds -> Chain es -> AccelerationStructureCreateInfoNV es

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

Show (Chain es) => Show (AccelerationStructureCreateInfoNV es)

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureCreateInfoNV es -> ShowS

show :: AccelerationStructureCreateInfoNV es -> String

showList :: [AccelerationStructureCreateInfoNV es] -> ShowS

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

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

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

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: AccelerationStructureCreateInfoNV es

data BindAccelerationStructureMemoryInfoNV

VkBindAccelerationStructureMemoryInfoNV - Structure specifying acceleration structure memory binding

Valid Usage

• accelerationStructure must not already be backed by a memory object

• memoryOffset must be less than the size of memory
• memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV
• memoryOffset must be an integer multiple of the alignment member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV
• The size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsNV with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV must be less than or equal to the size of memory minus memoryOffset

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_ACCELERATION_STRUCTURE_MEMORY_INFO_NV

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

See Also

VK_NV_ray_tracing, AccelerationStructureNV, DeviceMemory, DeviceSize, StructureType, bindAccelerationStructureMemoryNV

Constructors

BindAccelerationStructureMemoryInfoNV

Fields

• accelerationStructure :: AccelerationStructureNV

  accelerationStructure is the acceleration structure to be attached to memory.

• memory :: DeviceMemory

  memory is a DeviceMemory object describing the device memory to attach.

• memoryOffset :: DeviceSize

  memoryOffset is the start offset of the region of memory that is to be bound to the acceleration structure. The number of bytes returned in the MemoryRequirements::size member in memory, starting from memoryOffset bytes, will be bound to the specified acceleration structure.

• deviceIndices :: Vector Word32

  pDeviceIndices is a pointer to an array of device indices.

Instances

Show BindAccelerationStructureMemoryInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> BindAccelerationStructureMemoryInfoNV -> ShowS

show :: BindAccelerationStructureMemoryInfoNV -> String

showList :: [BindAccelerationStructureMemoryInfoNV] -> ShowS

FromCStruct BindAccelerationStructureMemoryInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr BindAccelerationStructureMemoryInfoNV -> IO BindAccelerationStructureMemoryInfoNV

ToCStruct BindAccelerationStructureMemoryInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr BindAccelerationStructureMemoryInfoNV -> BindAccelerationStructureMemoryInfoNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BindAccelerationStructureMemoryInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BindAccelerationStructureMemoryInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: BindAccelerationStructureMemoryInfoNV

data WriteDescriptorSetAccelerationStructureNV

VkWriteDescriptorSetAccelerationStructureNV - Structure specifying acceleration structure descriptor information

Valid Usage

• accelerationStructureCount must be equal to descriptorCount in the extended structure

• Each acceleration structure in pAccelerationStructures must have been created with ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR
• If the nullDescriptor feature is not enabled, each member of pAccelerationStructures must not be NULL_HANDLE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_NV

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

See Also

VK_NV_ray_tracing, AccelerationStructureNV, StructureType

Constructors

WriteDescriptorSetAccelerationStructureNV

Fields

• accelerationStructures :: Vector AccelerationStructureNV

  pAccelerationStructures is a pointer to an array of AccelerationStructureNV structures specifying the acceleration structures to update.

Instances

Show WriteDescriptorSetAccelerationStructureNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> WriteDescriptorSetAccelerationStructureNV -> ShowS

show :: WriteDescriptorSetAccelerationStructureNV -> String

showList :: [WriteDescriptorSetAccelerationStructureNV] -> ShowS

FromCStruct WriteDescriptorSetAccelerationStructureNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr WriteDescriptorSetAccelerationStructureNV -> IO WriteDescriptorSetAccelerationStructureNV

ToCStruct WriteDescriptorSetAccelerationStructureNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr WriteDescriptorSetAccelerationStructureNV -> WriteDescriptorSetAccelerationStructureNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr WriteDescriptorSetAccelerationStructureNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero WriteDescriptorSetAccelerationStructureNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: WriteDescriptorSetAccelerationStructureNV

data AccelerationStructureMemoryRequirementsInfoNV

VkAccelerationStructureMemoryRequirementsInfoNV - Structure specifying acceleration to query for memory requirements

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, AccelerationStructureMemoryRequirementsTypeNV, AccelerationStructureNV, StructureType, getAccelerationStructureMemoryRequirementsNV

Constructors

AccelerationStructureMemoryRequirementsInfoNV

Fields

• type' :: AccelerationStructureMemoryRequirementsTypeNV

  type selects the type of memory requirement being queried. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV returns the memory requirements for the object itself. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV returns the memory requirements for the scratch memory when doing a build. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV returns the memory requirements for the scratch memory when doing an update.

  type must be a valid AccelerationStructureMemoryRequirementsTypeNV value

• accelerationStructure :: AccelerationStructureNV

  accelerationStructure is the acceleration structure to be queried for memory requirements.

  accelerationStructure must be a valid AccelerationStructureNV handle

Instances

Storable AccelerationStructureMemoryRequirementsInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: AccelerationStructureMemoryRequirementsInfoNV -> Int

alignment :: AccelerationStructureMemoryRequirementsInfoNV -> Int

peekElemOff :: Ptr AccelerationStructureMemoryRequirementsInfoNV -> Int -> IO AccelerationStructureMemoryRequirementsInfoNV

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

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

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

peek :: Ptr AccelerationStructureMemoryRequirementsInfoNV -> IO AccelerationStructureMemoryRequirementsInfoNV

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

Show AccelerationStructureMemoryRequirementsInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureMemoryRequirementsInfoNV -> ShowS

show :: AccelerationStructureMemoryRequirementsInfoNV -> String

showList :: [AccelerationStructureMemoryRequirementsInfoNV] -> ShowS

Eq AccelerationStructureMemoryRequirementsInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

(==) :: AccelerationStructureMemoryRequirementsInfoNV -> AccelerationStructureMemoryRequirementsInfoNV -> Bool

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

FromCStruct AccelerationStructureMemoryRequirementsInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureMemoryRequirementsInfoNV -> IO AccelerationStructureMemoryRequirementsInfoNV

ToCStruct AccelerationStructureMemoryRequirementsInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureMemoryRequirementsInfoNV -> AccelerationStructureMemoryRequirementsInfoNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureMemoryRequirementsInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureMemoryRequirementsInfoNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: AccelerationStructureMemoryRequirementsInfoNV

data PhysicalDeviceRayTracingPropertiesNV

VkPhysicalDeviceRayTracingPropertiesNV - Properties of the physical device for ray tracing

Description

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

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

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

Valid Usage (Implicit)

See Also

VK_NV_ray_tracing, StructureType

Constructors

PhysicalDeviceRayTracingPropertiesNV

Fields

• shaderGroupHandleSize :: Word32

  shaderGroupHandleSize is the size in bytes of the shader header.

• maxRecursionDepth :: Word32

  maxRecursionDepth is the maximum number of levels of 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.

• maxGeometryCount :: Word64

  maxGeometryCount is the maximum number of geometries in the bottom level acceleration structure.

• maxInstanceCount :: Word64

  maxInstanceCount is the maximum number of instances in the top level acceleration structure.

• maxTriangleCount :: Word64

  maxTriangleCount is the maximum number of triangles in all geometries in the bottom level acceleration structure.

• maxDescriptorSetAccelerationStructures :: Word32

  maxDescriptorSetAccelerationStructures is the maximum number of acceleration structure descriptors that are allowed in a descriptor set.

Instances

Storable PhysicalDeviceRayTracingPropertiesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: PhysicalDeviceRayTracingPropertiesNV -> Int

alignment :: PhysicalDeviceRayTracingPropertiesNV -> Int

peekElemOff :: Ptr PhysicalDeviceRayTracingPropertiesNV -> Int -> IO PhysicalDeviceRayTracingPropertiesNV

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

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

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

peek :: Ptr PhysicalDeviceRayTracingPropertiesNV -> IO PhysicalDeviceRayTracingPropertiesNV

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

Show PhysicalDeviceRayTracingPropertiesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> PhysicalDeviceRayTracingPropertiesNV -> ShowS

show :: PhysicalDeviceRayTracingPropertiesNV -> String

showList :: [PhysicalDeviceRayTracingPropertiesNV] -> ShowS

Eq PhysicalDeviceRayTracingPropertiesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

(==) :: PhysicalDeviceRayTracingPropertiesNV -> PhysicalDeviceRayTracingPropertiesNV -> Bool

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

FromCStruct PhysicalDeviceRayTracingPropertiesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

peekCStruct :: Ptr PhysicalDeviceRayTracingPropertiesNV -> IO PhysicalDeviceRayTracingPropertiesNV

ToCStruct PhysicalDeviceRayTracingPropertiesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

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

pokeCStruct :: Ptr PhysicalDeviceRayTracingPropertiesNV -> PhysicalDeviceRayTracingPropertiesNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceRayTracingPropertiesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceRayTracingPropertiesNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: PhysicalDeviceRayTracingPropertiesNV

newtype AccelerationStructureMemoryRequirementsTypeNV

VkAccelerationStructureMemoryRequirementsTypeNV - Acceleration structure memory requirement type

See Also

VK_NV_ray_tracing, AccelerationStructureMemoryRequirementsInfoNV

Constructors

AccelerationStructureMemoryRequirementsTypeNV Int32

Bundled Patterns

pattern ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV :: AccelerationStructureMemoryRequirementsTypeNV

ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_NV requests the memory requirement for the AccelerationStructureNV backing store.

pattern ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV :: AccelerationStructureMemoryRequirementsTypeNV

ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV requests the memory requirement for scratch space during the initial build.

pattern ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV :: AccelerationStructureMemoryRequirementsTypeNV

ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV requests the memory requirement for scratch space during an update.

Instances

Storable AccelerationStructureMemoryRequirementsTypeNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

sizeOf :: AccelerationStructureMemoryRequirementsTypeNV -> Int

alignment :: AccelerationStructureMemoryRequirementsTypeNV -> Int

peekElemOff :: Ptr AccelerationStructureMemoryRequirementsTypeNV -> Int -> IO AccelerationStructureMemoryRequirementsTypeNV

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

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

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

peek :: Ptr AccelerationStructureMemoryRequirementsTypeNV -> IO AccelerationStructureMemoryRequirementsTypeNV

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

Read AccelerationStructureMemoryRequirementsTypeNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

readsPrec :: Int -> ReadS AccelerationStructureMemoryRequirementsTypeNV

readList :: ReadS [AccelerationStructureMemoryRequirementsTypeNV]

readPrec :: ReadPrec AccelerationStructureMemoryRequirementsTypeNV

readListPrec :: ReadPrec [AccelerationStructureMemoryRequirementsTypeNV]

Show AccelerationStructureMemoryRequirementsTypeNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureMemoryRequirementsTypeNV -> ShowS

show :: AccelerationStructureMemoryRequirementsTypeNV -> String

showList :: [AccelerationStructureMemoryRequirementsTypeNV] -> ShowS

Eq AccelerationStructureMemoryRequirementsTypeNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

(==) :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> Bool

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

Ord AccelerationStructureMemoryRequirementsTypeNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

compare :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> Ordering

(<) :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> Bool

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

(>) :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> Bool

(>=) :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> Bool

max :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV

min :: AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV -> AccelerationStructureMemoryRequirementsTypeNV

Zero AccelerationStructureMemoryRequirementsTypeNV

Defined in Vulkan.Extensions.VK_NV_ray_tracing

Methods

zero :: AccelerationStructureMemoryRequirementsTypeNV

type GeometryFlagsNV = GeometryFlagsKHR

type GeometryInstanceFlagsNV = GeometryInstanceFlagsKHR

type BuildAccelerationStructureFlagsNV = BuildAccelerationStructureFlagsKHR

type GeometryFlagBitsNV = GeometryFlagBitsKHR

type GeometryInstanceFlagBitsNV = GeometryInstanceFlagBitsKHR

type BuildAccelerationStructureFlagBitsNV = BuildAccelerationStructureFlagBitsKHR

type CopyAccelerationStructureModeNV = CopyAccelerationStructureModeKHR

type AccelerationStructureTypeNV = AccelerationStructureTypeKHR

type GeometryTypeNV = GeometryTypeKHR

type RayTracingShaderGroupTypeNV = RayTracingShaderGroupTypeKHR

type AabbPositionsNV = AabbPositionsKHR

type TransformMatrixNV = TransformMatrixKHR

type AccelerationStructureInstanceNV = AccelerationStructureInstanceKHR

type NV_RAY_TRACING_SPEC_VERSION = 3

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

type NV_RAY_TRACING_EXTENSION_NAME = "VK_NV_ray_tracing"

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

newtype AccelerationStructureNV

VkAccelerationStructureNV - Opaque handle to an acceleration structure object

See Also

VK_NV_ray_tracing, AccelerationStructureCaptureDescriptorDataInfoEXT, AccelerationStructureMemoryRequirementsInfoNV, BindAccelerationStructureMemoryInfoNV, WriteDescriptorSetAccelerationStructureNV, cmdBuildAccelerationStructureNV, cmdCopyAccelerationStructureNV, cmdWriteAccelerationStructuresPropertiesNV, createAccelerationStructureNV, destroyAccelerationStructureNV, getAccelerationStructureHandleNV

Constructors

AccelerationStructureNV Word64

Instances

Storable AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: AccelerationStructureNV -> Int

alignment :: AccelerationStructureNV -> Int

peekElemOff :: Ptr AccelerationStructureNV -> Int -> IO AccelerationStructureNV

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

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

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

peek :: Ptr AccelerationStructureNV -> IO AccelerationStructureNV

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

Show AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> AccelerationStructureNV -> ShowS

show :: AccelerationStructureNV -> String

showList :: [AccelerationStructureNV] -> ShowS

Eq AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Methods

(==) :: AccelerationStructureNV -> AccelerationStructureNV -> Bool

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

Ord AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Methods

compare :: AccelerationStructureNV -> AccelerationStructureNV -> Ordering

(<) :: AccelerationStructureNV -> AccelerationStructureNV -> Bool

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

(>) :: AccelerationStructureNV -> AccelerationStructureNV -> Bool

(>=) :: AccelerationStructureNV -> AccelerationStructureNV -> Bool

max :: AccelerationStructureNV -> AccelerationStructureNV -> AccelerationStructureNV

min :: AccelerationStructureNV -> AccelerationStructureNV -> AccelerationStructureNV

HasObjectType AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: AccelerationStructureNV -> (ObjectType, Word64)

IsHandle AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Zero AccelerationStructureNV

Defined in Vulkan.Extensions.Handles

Methods

zero :: AccelerationStructureNV

data AabbPositionsKHR

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

Valid Usage

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing

Constructors

AabbPositionsKHR

Fields

• minX :: Float

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

  minX must be less than or equal to maxX

• minY :: Float

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

  minY must be less than or equal to maxY

• minZ :: Float

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

  minZ must be less than or equal to maxZ

• maxX :: Float

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

• maxY :: Float

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

• maxZ :: Float

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

Instances

Storable AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: AabbPositionsKHR -> Int

alignment :: AabbPositionsKHR -> Int

peekElemOff :: Ptr AabbPositionsKHR -> Int -> IO AabbPositionsKHR

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

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

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

peek :: Ptr AabbPositionsKHR -> IO AabbPositionsKHR

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

Show AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> AabbPositionsKHR -> ShowS

show :: AabbPositionsKHR -> String

showList :: [AabbPositionsKHR] -> ShowS

Eq AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: AabbPositionsKHR -> AabbPositionsKHR -> Bool

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

FromCStruct AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

peekCStruct :: Ptr AabbPositionsKHR -> IO AabbPositionsKHR

ToCStruct AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

pokeCStruct :: Ptr AabbPositionsKHR -> AabbPositionsKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AabbPositionsKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: AabbPositionsKHR

data TransformMatrixKHR

VkTransformMatrixKHR - Structure specifying a 3x4 affine transformation matrix

Valid Usage

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

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureInstanceKHR, AccelerationStructureMatrixMotionInstanceNV

Constructors

TransformMatrixKHR

Fields

• matrixRow0 :: (Float, Float, Float, Float)
• matrixRow1 :: (Float, Float, Float, Float)
• matrixRow2 :: (Float, Float, Float, Float)

Instances

Storable TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: TransformMatrixKHR -> Int

alignment :: TransformMatrixKHR -> Int

peekElemOff :: Ptr TransformMatrixKHR -> Int -> IO TransformMatrixKHR

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

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

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

peek :: Ptr TransformMatrixKHR -> IO TransformMatrixKHR

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

Show TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> TransformMatrixKHR -> ShowS

show :: TransformMatrixKHR -> String

showList :: [TransformMatrixKHR] -> ShowS

Eq TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: TransformMatrixKHR -> TransformMatrixKHR -> Bool

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

FromCStruct TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

peekCStruct :: Ptr TransformMatrixKHR -> IO TransformMatrixKHR

ToCStruct TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

pokeCStruct :: Ptr TransformMatrixKHR -> TransformMatrixKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr TransformMatrixKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero TransformMatrixKHR

The Identity Matrix

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: TransformMatrixKHR

data AccelerationStructureInstanceKHR

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

Description

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

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

Valid Usage (Implicit)

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureMotionInstanceDataNV, GeometryInstanceFlagsKHR, TransformMatrixKHR

Constructors

AccelerationStructureInstanceKHR

Fields

• transform :: TransformMatrixKHR

  transform is a TransformMatrixKHR structure describing a transformation to be applied to the acceleration structure.

• instanceCustomIndex :: Word32

  instanceCustomIndex is a 24-bit user-specified index value accessible to ray shaders in the InstanceCustomIndexKHR built-in.

  instanceCustomIndex and mask occupy the same memory as if a single uint32_t was specified in their place

  • instanceCustomIndex occupies the 24 least significant bits of that memory
  • mask occupies the 8 most significant bits of that memory
• mask :: Word32

  mask is an 8-bit visibility mask for the geometry. The instance may only be hit if Cull Mask & instance.mask != 0

• instanceShaderBindingTableRecordOffset :: Word32

  instanceShaderBindingTableRecordOffset is a 24-bit offset used in calculating the hit shader binding table index.

  instanceShaderBindingTableRecordOffset and flags occupy the same memory as if a single uint32_t was specified in their place

  • instanceShaderBindingTableRecordOffset occupies the 24 least significant bits of that memory
  • flags occupies the 8 most significant bits of that memory
• flags :: GeometryInstanceFlagsKHR

  flags is an 8-bit mask of GeometryInstanceFlagBitsKHR values to apply to this instance.

  flags must be a valid combination of GeometryInstanceFlagBitsKHR values

• accelerationStructureReference :: Word64

  accelerationStructureReference is either:

  • a device address containing the value obtained from getAccelerationStructureDeviceAddressKHR or getAccelerationStructureHandleNV (used by device operations which reference acceleration structures) or,
  • a AccelerationStructureKHR object (used by host operations which reference acceleration structures).

Instances

Storable AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: AccelerationStructureInstanceKHR -> Int

alignment :: AccelerationStructureInstanceKHR -> Int

peekElemOff :: Ptr AccelerationStructureInstanceKHR -> Int -> IO AccelerationStructureInstanceKHR

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

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

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

peek :: Ptr AccelerationStructureInstanceKHR -> IO AccelerationStructureInstanceKHR

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

Show AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> AccelerationStructureInstanceKHR -> ShowS

show :: AccelerationStructureInstanceKHR -> String

showList :: [AccelerationStructureInstanceKHR] -> ShowS

FromCStruct AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

peekCStruct :: Ptr AccelerationStructureInstanceKHR -> IO AccelerationStructureInstanceKHR

ToCStruct AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

pokeCStruct :: Ptr AccelerationStructureInstanceKHR -> AccelerationStructureInstanceKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureInstanceKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: AccelerationStructureInstanceKHR

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 not have 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

VK_KHR_ray_tracing_pipeline, VK_NV_ray_tracing, Device, Pipeline

newtype DebugReportObjectTypeEXT

VkDebugReportObjectTypeEXT - Specify the type of an object handle

Description

'

DebugReportObjectTypeEXT	Vulkan Handle Type
DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT	Unknown/Undefined Handle
DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXT	Instance
DEBUG_REPORT_OBJECT_TYPE_PHYSICAL_DEVICE_EXT	PhysicalDevice
DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT	Device
DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXT	Queue
DEBUG_REPORT_OBJECT_TYPE_SEMAPHORE_EXT	Semaphore
DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT	CommandBuffer
DEBUG_REPORT_OBJECT_TYPE_FENCE_EXT	Fence
DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT	DeviceMemory
DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT	Buffer
DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT	Image
DEBUG_REPORT_OBJECT_TYPE_EVENT_EXT	Event
DEBUG_REPORT_OBJECT_TYPE_QUERY_POOL_EXT	QueryPool
DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT	BufferView
DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT	ImageView
DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT	ShaderModule
DEBUG_REPORT_OBJECT_TYPE_PIPELINE_CACHE_EXT	PipelineCache
DEBUG_REPORT_OBJECT_TYPE_PIPELINE_LAYOUT_EXT	PipelineLayout
DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT	RenderPass
DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXT	Pipeline
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT	DescriptorSetLayout
DEBUG_REPORT_OBJECT_TYPE_SAMPLER_EXT	Sampler
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT	DescriptorPool
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT	DescriptorSet
DEBUG_REPORT_OBJECT_TYPE_FRAMEBUFFER_EXT	Framebuffer
DEBUG_REPORT_OBJECT_TYPE_COMMAND_POOL_EXT	CommandPool
DEBUG_REPORT_OBJECT_TYPE_SURFACE_KHR_EXT	SurfaceKHR
DEBUG_REPORT_OBJECT_TYPE_SWAPCHAIN_KHR_EXT	SwapchainKHR
DEBUG_REPORT_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT_EXT	DebugReportCallbackEXT
DEBUG_REPORT_OBJECT_TYPE_DISPLAY_KHR_EXT	DisplayKHR
DEBUG_REPORT_OBJECT_TYPE_DISPLAY_MODE_KHR_EXT	DisplayModeKHR
DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_EXT	DescriptorUpdateTemplate

DebugReportObjectTypeEXT and Vulkan Handle Relationship

Note

The primary expected use of ERROR_VALIDATION_FAILED_EXT is for validation layer testing. It is not expected that an application would see this error code during normal use of the validation layers.

See Also

VK_EXT_debug_marker, VK_EXT_debug_report, DebugMarkerObjectNameInfoEXT, DebugMarkerObjectTagInfoEXT, debugReportMessageEXT

Constructors

DebugReportObjectTypeEXT Int32

Bundled Patterns

pattern DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_PHYSICAL_DEVICE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_SEMAPHORE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_FENCE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_EVENT_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_QUERY_POOL_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_PIPELINE_CACHE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_PIPELINE_LAYOUT_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_SAMPLER_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_FRAMEBUFFER_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_COMMAND_POOL_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_SURFACE_KHR_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_SWAPCHAIN_KHR_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DISPLAY_KHR_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DISPLAY_MODE_KHR_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_VALIDATION_CACHE_EXT_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_BUFFER_COLLECTION_FUCHSIA_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_NV_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_CU_FUNCTION_NVX_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_CU_MODULE_NVX_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_EXT :: DebugReportObjectTypeEXT

Instances

Storable DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

sizeOf :: DebugReportObjectTypeEXT -> Int

alignment :: DebugReportObjectTypeEXT -> Int

peekElemOff :: Ptr DebugReportObjectTypeEXT -> Int -> IO DebugReportObjectTypeEXT

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

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

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

peek :: Ptr DebugReportObjectTypeEXT -> IO DebugReportObjectTypeEXT

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

Read DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

readsPrec :: Int -> ReadS DebugReportObjectTypeEXT

readList :: ReadS [DebugReportObjectTypeEXT]

readPrec :: ReadPrec DebugReportObjectTypeEXT

readListPrec :: ReadPrec [DebugReportObjectTypeEXT]

Show DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

showsPrec :: Int -> DebugReportObjectTypeEXT -> ShowS

show :: DebugReportObjectTypeEXT -> String

showList :: [DebugReportObjectTypeEXT] -> ShowS

Eq DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

(==) :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> Bool

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

Ord DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

compare :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> Ordering

(<) :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> Bool

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

(>) :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> Bool

(>=) :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> Bool

max :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT

min :: DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT -> DebugReportObjectTypeEXT

Zero DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

zero :: DebugReportObjectTypeEXT

newtype GeometryInstanceFlagBitsKHR

VkGeometryInstanceFlagBitsKHR - Instance flag bits

Description

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

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, GeometryInstanceFlagsKHR

Constructors

GeometryInstanceFlagBitsKHR Flags

Bundled Patterns

pattern GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR :: GeometryInstanceFlagBitsKHR

GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR disables face culling for this instance.

pattern GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR :: GeometryInstanceFlagBitsKHR

GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR indicates that the facing determination for geometry in this instance is inverted. Because the facing is determined in object space, an instance transform does not change the winding, but a geometry transform does.

pattern GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR :: GeometryInstanceFlagBitsKHR

GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR causes this instance to act as though GEOMETRY_OPAQUE_BIT_KHR were specified on all geometries referenced by this instance. This behavior can be overridden by the SPIR-V NoOpaqueKHR ray flag.

pattern GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR :: GeometryInstanceFlagBitsKHR

GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR causes this instance to act as though GEOMETRY_OPAQUE_BIT_KHR were not specified on all geometries referenced by this instance. This behavior can be overridden by the SPIR-V OpaqueKHR ray flag.

pattern GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_EXT :: GeometryInstanceFlagBitsKHR

pattern GEOMETRY_INSTANCE_FORCE_OPACITY_MICROMAP_2_STATE_EXT :: GeometryInstanceFlagBitsKHR

Instances

Storable GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: GeometryInstanceFlagBitsKHR -> Int

alignment :: GeometryInstanceFlagBitsKHR -> Int

peekElemOff :: Ptr GeometryInstanceFlagBitsKHR -> Int -> IO GeometryInstanceFlagBitsKHR

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

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

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

peek :: Ptr GeometryInstanceFlagBitsKHR -> IO GeometryInstanceFlagBitsKHR

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

Bits GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

xor :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

complement :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

shift :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

rotate :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

zeroBits :: GeometryInstanceFlagBitsKHR

bit :: Int -> GeometryInstanceFlagBitsKHR

setBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

clearBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

complementBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

testBit :: GeometryInstanceFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: GeometryInstanceFlagBitsKHR -> Maybe Int

bitSize :: GeometryInstanceFlagBitsKHR -> Int

isSigned :: GeometryInstanceFlagBitsKHR -> Bool

shiftL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

unsafeShiftL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

shiftR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

unsafeShiftR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

rotateL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

rotateR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

popCount :: GeometryInstanceFlagBitsKHR -> Int

FiniteBits GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

finiteBitSize :: GeometryInstanceFlagBitsKHR -> Int

countLeadingZeros :: GeometryInstanceFlagBitsKHR -> Int

countTrailingZeros :: GeometryInstanceFlagBitsKHR -> Int

Read GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS GeometryInstanceFlagBitsKHR

readList :: ReadS [GeometryInstanceFlagBitsKHR]

readPrec :: ReadPrec GeometryInstanceFlagBitsKHR

readListPrec :: ReadPrec [GeometryInstanceFlagBitsKHR]

Show GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> GeometryInstanceFlagBitsKHR -> ShowS

show :: GeometryInstanceFlagBitsKHR -> String

showList :: [GeometryInstanceFlagBitsKHR] -> ShowS

Eq GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> Bool

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

Ord GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> Ordering

(<) :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> Bool

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

(>) :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> Bool

(>=) :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> Bool

max :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

min :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

Zero GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: GeometryInstanceFlagBitsKHR

type GeometryInstanceFlagsKHR = GeometryInstanceFlagBitsKHR

newtype GeometryFlagBitsKHR

VkGeometryFlagBitsKHR - Bitmask specifying additional parameters for a geometry

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, GeometryFlagsKHR

Constructors

GeometryFlagBitsKHR Flags

Bundled Patterns

pattern GEOMETRY_OPAQUE_BIT_KHR :: GeometryFlagBitsKHR

GEOMETRY_OPAQUE_BIT_KHR indicates that this geometry does not invoke the any-hit shaders even if present in a hit group.

pattern GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_KHR :: GeometryFlagBitsKHR

GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT_KHR indicates that the implementation must only call the any-hit shader a single time for each primitive in this geometry. If this bit is absent an implementation may invoke the any-hit shader more than once for this geometry.

Instances

Storable GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: GeometryFlagBitsKHR -> Int

alignment :: GeometryFlagBitsKHR -> Int

peekElemOff :: Ptr GeometryFlagBitsKHR -> Int -> IO GeometryFlagBitsKHR

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

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

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

peek :: Ptr GeometryFlagBitsKHR -> IO GeometryFlagBitsKHR

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

Bits GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(.&.) :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> GeometryFlagBitsKHR

(.|.) :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> GeometryFlagBitsKHR

xor :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> GeometryFlagBitsKHR

complement :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR

shift :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

rotate :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

zeroBits :: GeometryFlagBitsKHR

bit :: Int -> GeometryFlagBitsKHR

setBit :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

clearBit :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

complementBit :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

testBit :: GeometryFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: GeometryFlagBitsKHR -> Maybe Int

bitSize :: GeometryFlagBitsKHR -> Int

isSigned :: GeometryFlagBitsKHR -> Bool

shiftL :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

unsafeShiftL :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

shiftR :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

unsafeShiftR :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

rotateL :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

rotateR :: GeometryFlagBitsKHR -> Int -> GeometryFlagBitsKHR

popCount :: GeometryFlagBitsKHR -> Int

FiniteBits GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

finiteBitSize :: GeometryFlagBitsKHR -> Int

countLeadingZeros :: GeometryFlagBitsKHR -> Int

countTrailingZeros :: GeometryFlagBitsKHR -> Int

Read GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS GeometryFlagBitsKHR

readList :: ReadS [GeometryFlagBitsKHR]

readPrec :: ReadPrec GeometryFlagBitsKHR

readListPrec :: ReadPrec [GeometryFlagBitsKHR]

Show GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> GeometryFlagBitsKHR -> ShowS

show :: GeometryFlagBitsKHR -> String

showList :: [GeometryFlagBitsKHR] -> ShowS

Eq GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> Bool

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

Ord GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> Ordering

(<) :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> Bool

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

(>) :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> Bool

(>=) :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> Bool

max :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> GeometryFlagBitsKHR

min :: GeometryFlagBitsKHR -> GeometryFlagBitsKHR -> GeometryFlagBitsKHR

Zero GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: GeometryFlagBitsKHR

type GeometryFlagsKHR = GeometryFlagBitsKHR

newtype BuildAccelerationStructureFlagBitsKHR

VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds

Description

Note

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

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, BuildAccelerationStructureFlagsKHR

Constructors

BuildAccelerationStructureFlagBitsKHR Flags

Bundled Patterns

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR indicates that the specified acceleration structure can be updated with a mode of BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR in AccelerationStructureBuildGeometryInfoKHR or an update of TRUE in cmdBuildAccelerationStructureNV .

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR indicates that the specified acceleration structure can act as the source for a copy acceleration structure command with mode of COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR to produce a compacted acceleration structure.

pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR indicates that the given acceleration structure build should prioritize trace performance over build time.

pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR indicates that the given acceleration structure build should prioritize build time over trace performance.

pattern BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR indicates that this acceleration structure should minimize the size of the scratch memory and the final result acceleration structure, potentially at the expense of build time or trace performance.

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_EXT :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_EXT indicates that the data of the opacity micromaps associated with the specified acceleration structure may change with an acceleration structure update.

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_EXT :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_EXT indicates that the specified acceleration structure may be referenced in an instance with GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_EXT set.

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_EXT :: BuildAccelerationStructureFlagBitsKHR

BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_EXT indicates that the opacity micromaps associated with the specified acceleration structure may change with an acceleration structure update.

pattern BUILD_ACCELERATION_STRUCTURE_MOTION_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

Instances

Storable BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: BuildAccelerationStructureFlagBitsKHR -> Int

alignment :: BuildAccelerationStructureFlagBitsKHR -> Int

peekElemOff :: Ptr BuildAccelerationStructureFlagBitsKHR -> Int -> IO BuildAccelerationStructureFlagBitsKHR

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

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

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

peek :: Ptr BuildAccelerationStructureFlagBitsKHR -> IO BuildAccelerationStructureFlagBitsKHR

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

Bits BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

xor :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

complement :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

shift :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

rotate :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

zeroBits :: BuildAccelerationStructureFlagBitsKHR

bit :: Int -> BuildAccelerationStructureFlagBitsKHR

setBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

clearBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

complementBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

testBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: BuildAccelerationStructureFlagBitsKHR -> Maybe Int

bitSize :: BuildAccelerationStructureFlagBitsKHR -> Int

isSigned :: BuildAccelerationStructureFlagBitsKHR -> Bool

shiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

unsafeShiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

shiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

unsafeShiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

rotateL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

rotateR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

popCount :: BuildAccelerationStructureFlagBitsKHR -> Int

FiniteBits BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

finiteBitSize :: BuildAccelerationStructureFlagBitsKHR -> Int

countLeadingZeros :: BuildAccelerationStructureFlagBitsKHR -> Int

countTrailingZeros :: BuildAccelerationStructureFlagBitsKHR -> Int

Read BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS BuildAccelerationStructureFlagBitsKHR

readList :: ReadS [BuildAccelerationStructureFlagBitsKHR]

readPrec :: ReadPrec BuildAccelerationStructureFlagBitsKHR

readListPrec :: ReadPrec [BuildAccelerationStructureFlagBitsKHR]

Show BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> BuildAccelerationStructureFlagBitsKHR -> ShowS

show :: BuildAccelerationStructureFlagBitsKHR -> String

showList :: [BuildAccelerationStructureFlagBitsKHR] -> ShowS

Eq BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool

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

Ord BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Ordering

(<) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool

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

(>) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool

(>=) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool

max :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

min :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

Zero BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: BuildAccelerationStructureFlagBitsKHR

type BuildAccelerationStructureFlagsKHR = BuildAccelerationStructureFlagBitsKHR

newtype CopyAccelerationStructureModeKHR

VkCopyAccelerationStructureModeKHR - Acceleration structure copy mode

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, CopyAccelerationStructureInfoKHR, CopyAccelerationStructureToMemoryInfoKHR, CopyMemoryToAccelerationStructureInfoKHR, cmdCopyAccelerationStructureNV

Constructors

CopyAccelerationStructureModeKHR Int32

Bundled Patterns

pattern COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR :: CopyAccelerationStructureModeKHR

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

pattern COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR :: CopyAccelerationStructureModeKHR

COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR creates a more compact version of an acceleration structure src into dst. The acceleration structure dst must have been created with a size at least as large as that returned by cmdWriteAccelerationStructuresPropertiesKHR or writeAccelerationStructuresPropertiesKHR after the build of the acceleration structure specified by src. If src contains references to other acceleration structures, dst will reference the same acceleration structures.

pattern COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR :: CopyAccelerationStructureModeKHR

COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR serializes the acceleration structure to a semi-opaque format which can be reloaded on a compatible implementation.

pattern COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR :: CopyAccelerationStructureModeKHR

COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR deserializes the semi-opaque serialization format in the buffer to the acceleration structure.

Instances

Storable CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: CopyAccelerationStructureModeKHR -> Int

alignment :: CopyAccelerationStructureModeKHR -> Int

peekElemOff :: Ptr CopyAccelerationStructureModeKHR -> Int -> IO CopyAccelerationStructureModeKHR

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

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

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

peek :: Ptr CopyAccelerationStructureModeKHR -> IO CopyAccelerationStructureModeKHR

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

Read CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS CopyAccelerationStructureModeKHR

readList :: ReadS [CopyAccelerationStructureModeKHR]

readPrec :: ReadPrec CopyAccelerationStructureModeKHR

readListPrec :: ReadPrec [CopyAccelerationStructureModeKHR]

Show CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> CopyAccelerationStructureModeKHR -> ShowS

show :: CopyAccelerationStructureModeKHR -> String

showList :: [CopyAccelerationStructureModeKHR] -> ShowS

Eq CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> Bool

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

Ord CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> Ordering

(<) :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> Bool

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

(>) :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> Bool

(>=) :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> Bool

max :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR

min :: CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR -> CopyAccelerationStructureModeKHR

Zero CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: CopyAccelerationStructureModeKHR

newtype AccelerationStructureTypeKHR

VkAccelerationStructureTypeKHR - Type of acceleration structure

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureCreateInfoKHR, AccelerationStructureInfoNV

Constructors

AccelerationStructureTypeKHR Int32

Bundled Patterns

pattern ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR :: AccelerationStructureTypeKHR

ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR is a top-level acceleration structure containing instance data referring to bottom-level acceleration structures.

pattern ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR :: AccelerationStructureTypeKHR

ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR is a bottom-level acceleration structure containing the AABBs or geometry to be intersected.

pattern ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR :: AccelerationStructureTypeKHR

ACCELERATION_STRUCTURE_TYPE_GENERIC_KHR is an acceleration structure whose type is determined at build time used for special circumstances. In these cases, the acceleration structure type is not known at creation time, but must be specified at build time as either top or bottom.

Instances

Storable AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: AccelerationStructureTypeKHR -> Int

alignment :: AccelerationStructureTypeKHR -> Int

peekElemOff :: Ptr AccelerationStructureTypeKHR -> Int -> IO AccelerationStructureTypeKHR

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

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

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

peek :: Ptr AccelerationStructureTypeKHR -> IO AccelerationStructureTypeKHR

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

Read AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS AccelerationStructureTypeKHR

readList :: ReadS [AccelerationStructureTypeKHR]

readPrec :: ReadPrec AccelerationStructureTypeKHR

readListPrec :: ReadPrec [AccelerationStructureTypeKHR]

Show AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> AccelerationStructureTypeKHR -> ShowS

show :: AccelerationStructureTypeKHR -> String

showList :: [AccelerationStructureTypeKHR] -> ShowS

Eq AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> Bool

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

Ord AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> Ordering

(<) :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> Bool

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

(>) :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> Bool

(>=) :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> Bool

max :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR

min :: AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR -> AccelerationStructureTypeKHR

Zero AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: AccelerationStructureTypeKHR

newtype GeometryTypeKHR

VkGeometryTypeKHR - Enum specifying which type of geometry is provided

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, AccelerationStructureGeometryKHR, GeometryNV

Constructors

GeometryTypeKHR Int32

Bundled Patterns

pattern GEOMETRY_TYPE_TRIANGLES_KHR :: GeometryTypeKHR

GEOMETRY_TYPE_TRIANGLES_KHR specifies a geometry type consisting of triangles.

pattern GEOMETRY_TYPE_AABBS_KHR :: GeometryTypeKHR

GEOMETRY_TYPE_AABBS_KHR specifies a geometry type consisting of axis-aligned bounding boxes.

pattern GEOMETRY_TYPE_INSTANCES_KHR :: GeometryTypeKHR

GEOMETRY_TYPE_INSTANCES_KHR specifies a geometry type consisting of acceleration structure instances.

Instances

Storable GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: GeometryTypeKHR -> Int

alignment :: GeometryTypeKHR -> Int

peekElemOff :: Ptr GeometryTypeKHR -> Int -> IO GeometryTypeKHR

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

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

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

peek :: Ptr GeometryTypeKHR -> IO GeometryTypeKHR

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

Read GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS GeometryTypeKHR

readList :: ReadS [GeometryTypeKHR]

readPrec :: ReadPrec GeometryTypeKHR

readListPrec :: ReadPrec [GeometryTypeKHR]

Show GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> GeometryTypeKHR -> ShowS

show :: GeometryTypeKHR -> String

showList :: [GeometryTypeKHR] -> ShowS

Eq GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: GeometryTypeKHR -> GeometryTypeKHR -> Bool

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

Ord GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: GeometryTypeKHR -> GeometryTypeKHR -> Ordering

(<) :: GeometryTypeKHR -> GeometryTypeKHR -> Bool

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

(>) :: GeometryTypeKHR -> GeometryTypeKHR -> Bool

(>=) :: GeometryTypeKHR -> GeometryTypeKHR -> Bool

max :: GeometryTypeKHR -> GeometryTypeKHR -> GeometryTypeKHR

min :: GeometryTypeKHR -> GeometryTypeKHR -> GeometryTypeKHR

Zero GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: GeometryTypeKHR

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

VK_KHR_ray_tracing_pipeline, VK_NV_ray_tracing, 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

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

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

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

Zero RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing_pipeline

Methods

zero :: RayTracingShaderGroupTypeKHR

type MemoryRequirements2KHR = MemoryRequirements2

pattern GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_KHR :: GeometryInstanceFlagBitsKHR

type SHADER_UNUSED_KHR = 4294967295

pattern SHADER_UNUSED_KHR :: Word32

VK_SHADER_UNUSED_KHR - Sentinel for an unused shader index

See Also

VK_KHR_ray_tracing_pipeline, VK_NV_ray_tracing