Vulkan.Extensions.VK_KHR_ray_tracing

Documentation

destroyAccelerationStructureKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the buffer.

-> AccelerationStructureKHR

accelerationStructure is the acceleration structure to destroy.

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

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

-> io ()

vkDestroyAccelerationStructureKHR - 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 AccelerationStructureKHR 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

AccelerationStructureKHR, AllocationCallbacks, Device

getAccelerationStructureMemoryRequirementsKHR

Arguments

:: forall a io. (Extendss MemoryRequirements2 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

-> AccelerationStructureMemoryRequirementsInfoKHR

pInfo specifies the acceleration structure to get memory requirements for.

pInfo must be a valid pointer to a valid AccelerationStructureMemoryRequirementsInfoKHR structure

-> io (MemoryRequirements2 a)

vkGetAccelerationStructureMemoryRequirementsKHR - Get acceleration structure memory requirements

Valid Usage (Implicit)

See Also

AccelerationStructureMemoryRequirementsInfoKHR, Device, MemoryRequirements2

bindAccelerationStructureMemoryKHR

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

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

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

-> io ()

vkBindAccelerationStructureMemoryKHR - Bind acceleration structure memory

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

BindAccelerationStructureMemoryInfoKHR, Device

cmdCopyAccelerationStructureKHR

Arguments

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

=> CommandBuffer

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

-> CopyAccelerationStructureInfoKHR a

pInfo is a pointer to a CopyAccelerationStructureInfoKHR structure defining the copy operation.

-> io ()

vkCmdCopyAccelerationStructureKHR - Copy an acceleration structure

Valid Usage

• All AccelerationStructureKHR objects referenced by this command must be bound to device memory

• The DeferredOperationInfoKHR structure must not be included in the pNext chain of the CopyAccelerationStructureInfoKHR structure

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

CommandBuffer, CopyAccelerationStructureInfoKHR

copyAccelerationStructureKHR :: forall a io. (Extendss CopyAccelerationStructureInfoKHR a, PokeChain a, MonadIO io) => Device -> CopyAccelerationStructureInfoKHR a -> io Result

vkCopyAccelerationStructureKHR - Copy an acceleration structure on the host

Parameters

This command fulfills the same task as cmdCopyAccelerationStructureKHR but executed by the host.

Description

• device is the device which owns the acceleration structures.

• pInfo is a pointer to a CopyAccelerationStructureInfoKHR structure defining the copy operation.

If the DeferredOperationInfoKHR structure is included in the pNext chain of the CopyAccelerationStructureInfoKHR structure, the operation of this command is deferred, as defined in the Deferred Host Operations chapter.

Valid Usage

• All AccelerationStructureKHR objects referenced by this command must be bound to host-visible memory

• the ::rayTracingHostAccelerationStructureCommands feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid CopyAccelerationStructureInfoKHR structure

Return Codes

Success

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CopyAccelerationStructureInfoKHR, Device

cmdCopyAccelerationStructureToMemoryKHR :: forall a io. (Extendss CopyAccelerationStructureToMemoryInfoKHR a, PokeChain a, MonadIO io) => CommandBuffer -> CopyAccelerationStructureToMemoryInfoKHR a -> io ()

vkCmdCopyAccelerationStructureToMemoryKHR - Copy an acceleration structure to device memory

Parameters

This command produces the same results as copyAccelerationStructureToMemoryKHR, but writes its result to a device address, and is executed on the device rather than the host. The output may not necessarily be bit-for-bit identical, but it can be equally used by either cmdCopyMemoryToAccelerationStructureKHR or copyMemoryToAccelerationStructureKHR.

Description

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

• pInfo is an a pointer to a CopyAccelerationStructureToMemoryInfoKHR structure defining the copy operation.

The defined header structure for the serialized data consists of:

• UUID_SIZE bytes of data matching PhysicalDeviceIDProperties::driverUUID
• UUID_SIZE bytes of data identifying the compatibility for comparison using getDeviceAccelerationStructureCompatibilityKHR
• A 64-bit integer of the total size matching the value queried using QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR
• A 64-bit integer of the deserialized size to be passed in to AccelerationStructureCreateInfoKHR::compactedSize
• A 64-bit integer of the count of the number of acceleration structure handles following. This will be zero for a bottom-level acceleration structure.

The corresponding handles matching the values returned by getAccelerationStructureDeviceAddressKHR or getAccelerationStructureHandleNV are tightly packed in the buffer following the count. The application is expected to store a mapping between those handles and the original application-generated bottom-level acceleration structures to provide when deserializing.

Valid Usage

• All DeviceOrHostAddressConstKHR referenced by this command must contain valid device addresses for a buffer bound to device memory. If the buffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

• All AccelerationStructureKHR objects referenced by this command must be bound to device memory
• The DeferredOperationInfoKHR structure must not be included in the pNext chain of the CopyAccelerationStructureToMemoryInfoKHR structure
• mode must be COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

CommandBuffer, CopyAccelerationStructureToMemoryInfoKHR

copyAccelerationStructureToMemoryKHR :: forall a io. (Extendss CopyAccelerationStructureToMemoryInfoKHR a, PokeChain a, MonadIO io) => Device -> CopyAccelerationStructureToMemoryInfoKHR a -> io Result

vkCopyAccelerationStructureToMemoryKHR - Serialize an acceleration structure on the host

Parameters

This command fulfills the same task as cmdCopyAccelerationStructureToMemoryKHR but executed by the host.

Description

This command produces the same results as cmdCopyAccelerationStructureToMemoryKHR, but writes its result directly to a host pointer, and is executed on the host rather than the device. The output may not necessarily be bit-for-bit identical, but it can be equally used by either cmdCopyMemoryToAccelerationStructureKHR or copyMemoryToAccelerationStructureKHR.

• device is the device which owns pInfo->src.
• pInfo is a pointer to a CopyAccelerationStructureToMemoryInfoKHR structure defining the copy operation.

If the DeferredOperationInfoKHR structure is included in the pNext chain of the CopyAccelerationStructureToMemoryInfoKHR structure, the operation of this command is deferred, as defined in the https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#deferred-host-operations chapter.

Valid Usage

• All AccelerationStructureKHR objects referenced by this command must be bound to host-visible memory

• All DeviceOrHostAddressKHR referenced by this command must contain valid host pointers
• the ::rayTracingHostAccelerationStructureCommands feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid CopyAccelerationStructureToMemoryInfoKHR structure

Return Codes

Success

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CopyAccelerationStructureToMemoryInfoKHR, Device

cmdCopyMemoryToAccelerationStructureKHR :: forall a io. (Extendss CopyMemoryToAccelerationStructureInfoKHR a, PokeChain a, MonadIO io) => CommandBuffer -> CopyMemoryToAccelerationStructureInfoKHR a -> io ()

vkCmdCopyMemoryToAccelerationStructureKHR - Copy device memory to an acceleration structure

Parameters

This command can accept acceleration structures produced by either cmdCopyAccelerationStructureToMemoryKHR or copyAccelerationStructureToMemoryKHR.

Description

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

• pInfo is a pointer to a CopyMemoryToAccelerationStructureInfoKHR structure defining the copy operation.

The structure provided as input to deserialize is as described in cmdCopyAccelerationStructureToMemoryKHR, with any acceleration structure handles filled in with the newly-queried handles to bottom level acceleration structures created before deserialization. These do not need to be built at deserialize time, but must be created.

Valid Usage

• All DeviceOrHostAddressKHR referenced by this command must contain valid device addresses for a buffer bound to device memory. If the buffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

• All AccelerationStructureKHR objects referenced by this command must be bound to device memory
• The DeferredOperationInfoKHR structure must not be included in the pNext chain of the CopyMemoryToAccelerationStructureInfoKHR structure
• mode must be COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR
• The data in pInfo->src must have a format compatible with the destination physical device as returned by getDeviceAccelerationStructureCompatibilityKHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

CommandBuffer, CopyMemoryToAccelerationStructureInfoKHR

copyMemoryToAccelerationStructureKHR :: forall a io. (Extendss CopyMemoryToAccelerationStructureInfoKHR a, PokeChain a, MonadIO io) => Device -> CopyMemoryToAccelerationStructureInfoKHR a -> io Result

vkCopyMemoryToAccelerationStructureKHR - Deserialize an acceleration structure on the host

Parameters

This command fulfills the same task as cmdCopyMemoryToAccelerationStructureKHR but is executed by the host.

Description

This command can accept acceleration structures produced by either cmdCopyAccelerationStructureToMemoryKHR or copyAccelerationStructureToMemoryKHR.

• device is the device which owns pInfo->dst.
• pInfo is a pointer to a CopyMemoryToAccelerationStructureInfoKHR structure defining the copy operation.

If the DeferredOperationInfoKHR structure is included in the pNext chain of the CopyMemoryToAccelerationStructureInfoKHR structure, the operation of this command is deferred, as defined in the Deferred Host Operations chapter.

Valid Usage

• All AccelerationStructureKHR objects referenced by this command must be bound to host-visible memory

• All DeviceOrHostAddressConstKHR referenced by this command must contain valid host pointers
• the ::rayTracingHostAccelerationStructureCommands feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid CopyMemoryToAccelerationStructureInfoKHR structure

Return Codes

Success

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CopyMemoryToAccelerationStructureInfoKHR, Device

cmdWriteAccelerationStructuresPropertiesKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

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

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

vkCmdWriteAccelerationStructuresPropertiesKHR - Write acceleration structure result parameters to query results.

Valid Usage

• queryPool must have been created with a queryType matching queryType

• The queries identified by queryPool and firstQuery must be unavailable
• All acceleration structures in accelerationStructures must have been built with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
• queryType must be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR or QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid AccelerationStructureKHR 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
• 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	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

AccelerationStructureKHR, CommandBuffer, QueryPool, QueryType

writeAccelerationStructuresPropertiesKHR :: forall io. MonadIO io => Device -> ("accelerationStructures" ::: Vector AccelerationStructureKHR) -> QueryType -> ("dataSize" ::: Word64) -> ("data" ::: Ptr ()) -> ("stride" ::: Word64) -> io ()

vkWriteAccelerationStructuresPropertiesKHR - Query acceleration structure meta-data on the host

Parameters

This command fulfills the same task as cmdWriteAccelerationStructuresPropertiesKHR but executed by the host.

Description

• device is the device which owns the acceleration structures in pAccelerationStructures.

• accelerationStructureCount is the count of acceleration structures for which to query the property.
• pAccelerationStructures points to an array of existing previously built acceleration structures.
• queryType is a QueryType value specifying the property to be queried.
• dataSize is the size in bytes of the buffer pointed to by pData.
• pData is a pointer to a user-allocated buffer where the results will be written.
• stride is the stride in bytes between results for individual queries within pData.

Valid Usage

• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then stride must be a multiple of the size of DeviceSize

• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then data must point to a DeviceSize
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then stride must be a multiple of the size of DeviceSize
• If queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then data must point to a DeviceSize
• dataSize must be greater than or equal to accelerationStructureCount*stride
• The acceleration structures referenced by pAccelerationStructures must be bound to host-visible memory
• All acceleration structures in accelerationStructures must have been built with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if queryType is QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
• queryType must be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR or QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR
• the ::rayTracingHostAccelerationStructureCommands feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pAccelerationStructures must be a valid pointer to an array of accelerationStructureCount valid AccelerationStructureKHR handles
• queryType must be a valid QueryType value
• pData must be a valid pointer to an array of dataSize bytes
• accelerationStructureCount must be greater than 0
• dataSize must be greater than 0
• Each element of pAccelerationStructures 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

AccelerationStructureKHR, Device, QueryType

cmdTraceRaysKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("raygenShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("missShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("hitShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("callableShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("width" ::: Word32)

width is the width of the ray trace query dimensions.

-> ("height" ::: Word32)

height is height of the ray trace query dimensions.

-> ("depth" ::: Word32)

depth is depth of the ray trace query dimensions.

-> io ()

vkCmdTraceRaysKHR - Initialize a ray tracing dispatch

Description

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

Valid Usage

• If a ImageView is sampled with FILTER_LINEAR as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

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

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

CommandBuffer, StridedBufferRegionKHR

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

• 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 PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize × groupCount
• pipeline must have not been created with PIPELINE_CREATE_LIBRARY_BIT_KHR

Valid Usage (Implicit)

• device must be a valid Device handle

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, Pipeline

getRayTracingCaptureReplayShaderGroupHandlesKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device containing the ray tracing pipeline.

-> Pipeline

pipeline is the ray tracing pipeline object containing the shaders.

-> ("firstGroup" ::: Word32)

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

-> ("groupCount" ::: Word32)

groupCount is the number of shader handles to retrieve.

-> ("dataSize" ::: Word64)

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

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

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

-> io ()

vkGetRayTracingCaptureReplayShaderGroupHandlesKHR - Query ray tracing capture replay pipeline shader group handles

Valid Usage

• 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 PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleCaptureReplaySize × groupCount
• PhysicalDeviceRayTracingFeaturesKHR::rayTracingShaderGroupHandleCaptureReplay must be enabled to call this function

Valid Usage (Implicit)

• device must be a valid Device handle

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, Pipeline

createRayTracingPipelinesKHR

Arguments

:: forall io. MonadIO io

=> Device

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

-> PipelineCache

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

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

pCreateInfos is a pointer to an array of RayTracingPipelineCreateInfoKHR structures.

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

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

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

vkCreateRayTracingPipelinesKHR - Creates a new ray tracing pipeline object

Description

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

Valid Usage

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

• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline must have been created with the PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
• If pipelineCache was created with PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host access to pipelineCache must be externally synchronized
• The rayTracing feature must be enabled

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 RayTracingPipelineCreateInfoKHR structures
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pPipelines must be a valid pointer to an array of createInfoCount Pipeline handles
• createInfoCount must be greater than 0
• If pipelineCache is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR
• PIPELINE_COMPILE_REQUIRED_EXT

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS

See Also

AllocationCallbacks, Device, Pipeline, PipelineCache, RayTracingPipelineCreateInfoKHR

cmdTraceRaysIndirectKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("raygenShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("missShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("hitShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> ("callableShaderBindingTable" ::: StridedBufferRegionKHR)

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

-> Buffer

buffer is the buffer containing the trace ray parameters.

-> ("offset" ::: DeviceSize)

offset is the byte offset into buffer where parameters begin.

-> io ()

vkCmdTraceRaysIndirectKHR - Initialize an indirect ray tracing dispatch

Description

cmdTraceRaysIndirectKHR behaves similarly to cmdTraceRaysKHR except that the ray trace query dimensions are read by the device from buffer during execution. The parameters of trace ray are encoded in the TraceRaysIndirectCommandKHR structure located at offset bytes in buffer.

Valid Usage

• If a ImageView is sampled with FILTER_LINEAR as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

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

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pRaygenShaderBindingTable must be a valid pointer to a valid StridedBufferRegionKHR structure
• pMissShaderBindingTable must be a valid pointer to a valid StridedBufferRegionKHR structure
• pHitShaderBindingTable must be a valid pointer to a valid StridedBufferRegionKHR structure
• pCallableShaderBindingTable must be a valid pointer to a valid StridedBufferRegionKHR structure
• buffer 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
• Both of buffer, and commandBuffer 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	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

Buffer, CommandBuffer, DeviceSize, StridedBufferRegionKHR

getDeviceAccelerationStructureCompatibilityKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the device to check the version against.

-> AccelerationStructureVersionKHR

version points to the AccelerationStructureVersionKHR version information to check against the device.

-> io ()

vkGetDeviceAccelerationStructureCompatibilityKHR - Check if a serialized acceleration structure is compatible with the current device

Description

This possible return values for getDeviceAccelerationStructureCompatibilityKHR are:

• SUCCESS is returned if an acceleration structure serialized with version as the version information is compatible with device.
• ERROR_INCOMPATIBLE_VERSION_KHR is returned if an acceleration structure serialized with version as the version information is not compatible with device.

Valid Usage

• The rayTracing or rayQuery feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• version must be a valid pointer to a valid AccelerationStructureVersionKHR structure

Return Codes

Success

• SUCCESS

Failure

• ERROR_INCOMPATIBLE_VERSION_KHR

See Also

AccelerationStructureVersionKHR, Device

createAccelerationStructureKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that creates the buffer object.

-> AccelerationStructureCreateInfoKHR

pCreateInfo is a pointer to a AccelerationStructureCreateInfoKHR 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 AccelerationStructureKHR

vkCreateAccelerationStructureKHR - Create a new acceleration structure object

Description

Similar to other objects in Vulkan, the acceleration structure creation merely creates an object with a specific “shape”. The type and quantity of geometry that can be built into an acceleration structure is determined by the parameters of AccelerationStructureCreateInfoKHR.

Populating the data in the object after allocating and binding memory is done with commands such as cmdBuildAccelerationStructureKHR, buildAccelerationStructureKHR, cmdCopyAccelerationStructureKHR, and copyAccelerationStructureKHR.

The input buffers passed to acceleration structure build commands will be referenced by the implementation for the duration of the command. After the command completes, the acceleration structure may hold a reference to any acceleration structure specified by an active instance contained therein. Apart from this referencing, acceleration structures must be fully self-contained. The application may re-use or free any memory which was used by the command as an input or as scratch without affecting the results of ray traversal.

Valid Usage

• The rayTracing or rayQuery feature must be enabled

• If AccelerationStructureCreateInfoKHR::deviceAddress is not zero, the rayTracingAccelerationStructureCaptureReplay feature must be enabled
• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid AccelerationStructureCreateInfoKHR 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 AccelerationStructureKHR handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

See Also

AccelerationStructureCreateInfoKHR, AccelerationStructureKHR, AllocationCallbacks, Device

withAccelerationStructureKHR :: forall io r. MonadIO io => Device -> AccelerationStructureCreateInfoKHR -> Maybe AllocationCallbacks -> (io AccelerationStructureKHR -> (AccelerationStructureKHR -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createAccelerationStructureKHR and destroyAccelerationStructureKHR

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

cmdBuildAccelerationStructureKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("infos" ::: Vector (SomeStruct AccelerationStructureBuildGeometryInfoKHR))

pInfos is an array of infoCount AccelerationStructureBuildGeometryInfoKHR structures defining the geometry used to build each acceleration structure.

-> ("offsetInfos" ::: Vector AccelerationStructureBuildOffsetInfoKHR)

ppOffsetInfos is an array of infoCount pointers to arrays of AccelerationStructureBuildOffsetInfoKHR structures. Each ppOffsetInfos[i] is an array of pInfos[i].geometryCount AccelerationStructureBuildOffsetInfoKHR structures defining dynamic offsets to the addresses where geometry data is stored, as defined by pInfos[i].

-> io ()

vkCmdBuildAccelerationStructureKHR - Build an acceleration structure

Description

The cmdBuildAccelerationStructureKHR command provides the ability to initiate multiple acceleration structures builds, however there is no ordering or synchronization implied between any of the individual acceleration structure builds.

Note

This means that an application cannot build a top-level acceleration structure in the same cmdBuildAccelerationStructureKHR call as the associated bottom-level or instance acceleration structures are being built. There also cannot be any memory aliasing between any acceleration structure memories or scratch memories being used by any of the builds.

Accesses to the acceleration structure scratch buffers as identified by the AccelerationStructureBuildGeometryInfoKHR→scratchData buffer device addresses 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

• Each element of ppOffsetInfos[i] must be a valid pointer to an array of pInfos[i].geometryCount AccelerationStructureBuildOffsetInfoKHR structures

• Each pInfos[i].srcAccelerationStructure must not refer to the same acceleration structure as any pInfos[i].dstAccelerationStructure that is provided to the same build command unless it is identical for an update
• For each pInfos[i], dstAccelerationStructure must have been created with compatible AccelerationStructureCreateInfoKHR where AccelerationStructureCreateInfoKHR::type and AccelerationStructureCreateInfoKHR::flags are identical to AccelerationStructureBuildGeometryInfoKHR::type and AccelerationStructureBuildGeometryInfoKHR::flags respectively, AccelerationStructureBuildGeometryInfoKHR::geometryCount for dstAccelerationStructure are greater than or equal to the build size, and each geometry in AccelerationStructureBuildGeometryInfoKHR::ppGeometries for dstAccelerationStructure has greater than or equal to the number of vertices, indices, and AABBs, AccelerationStructureGeometryTrianglesDataKHR::transformData is both 0 or both non-zero, and all other parameters are the same
• For each pInfos[i], if update is TRUE, then objects that were previously active for that acceleration structure must not be made inactive as per ???
• For each pInfos[i], if update is TRUE, then objects that were previously inactive for that acceleration structure must not be made active as per ???
• Any acceleration structure instance in any top level build in this command must not reference any bottom level acceleration structure built by this command
• There must not be any memory aliasing between the scratch memories that are provided in all the pInfos[i].scratchData memories for the acceleration structure builds
• There must not be any memory aliasing between memory bound to any top level, bottom level, or instance acceleration structure accessed by this command
• If update is FALSE, all addresses between pInfos[i].scratchData and pInfos[i].scratchData + N
• 1 must be in the buffer device address range of the same buffer, where N is given by the size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with AccelerationStructureMemoryRequirementsInfoKHR::accelerationStructure set to pInfos[i].dstAccelerationStructure and AccelerationStructureMemoryRequirementsInfoKHR::type set to ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_KHR
• If update is TRUE, all addresses between pInfos[i].scratchData and pInfos[i].scratchData + N
• 1 must be in the buffer device address range of the same buffer, where N is given by the size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with AccelerationStructureMemoryRequirementsInfoKHR::accelerationStructure set to pInfos[i].dstAccelerationStructure and AccelerationStructureMemoryRequirementsInfoKHR::type set to ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_KHR
• The buffer from which the buffer device address pInfos[i].scratchData is queried must have been created with BUFFER_USAGE_RAY_TRACING_BIT_KHR usage flag
• All DeviceOrHostAddressKHR or DeviceOrHostAddressConstKHR referenced by this command must contain valid device addresses for a buffer bound to device memory. If the buffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
• All AccelerationStructureKHR objects referenced by this command must be bound to device memory
• The DeferredOperationInfoKHR structure must not be included in the pNext chain of any of the provided AccelerationStructureBuildGeometryInfoKHR structures

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfos must be a valid pointer to an array of infoCount valid AccelerationStructureBuildGeometryInfoKHR structures
• ppOffsetInfos must be a valid pointer to an array of infoCount AccelerationStructureBuildOffsetInfoKHR structures
• 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
• infoCount must be greater than 0

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureBuildOffsetInfoKHR, CommandBuffer

cmdBuildAccelerationStructureIndirectKHR

Arguments

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

=> CommandBuffer

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

-> AccelerationStructureBuildGeometryInfoKHR a

pInfo is a pointer to a AccelerationStructureBuildGeometryInfoKHR structure defining the geometry used to build the acceleration structure.

-> ("indirectBuffer" ::: Buffer)

indirectBuffer is the Buffer containing pInfo->geometryCount AccelerationStructureBuildOffsetInfoKHR structures defining dynamic offsets to the addresses where geometry data is stored, as defined by pInfo.

-> ("indirectOffset" ::: DeviceSize)

indirectOffset is the byte offset into indirectBuffer where offset parameters begin.

-> ("indirectStride" ::: Word32)

-> io ()

vkCmdBuildAccelerationStructureIndirectKHR - Build an acceleration structure with some parameters provided on the device

Valid Usage

• All DeviceOrHostAddressKHR or DeviceOrHostAddressConstKHR referenced by this command must contain valid device addresses for a buffer bound to device memory. If the buffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

• All AccelerationStructureKHR objects referenced by this command must be bound to device memory
• The ::rayTracingIndirectAccelerationStructureBuild feature must be enabled
• The DeferredOperationInfoKHR structure must not be included in the pNext chain of any of the provided AccelerationStructureBuildGeometryInfoKHR structures

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfo must be a valid pointer to a valid AccelerationStructureBuildGeometryInfoKHR structure
• indirectBuffer 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
• Both of commandBuffer, and indirectBuffer 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	Supported Queue Types	Pipeline Type
Primary Secondary	Outside	Compute

See Also

AccelerationStructureBuildGeometryInfoKHR, Buffer, CommandBuffer, DeviceSize

buildAccelerationStructureKHR :: forall io. MonadIO io => Device -> ("infos" ::: Vector (SomeStruct AccelerationStructureBuildGeometryInfoKHR)) -> ("offsetInfos" ::: Vector AccelerationStructureBuildOffsetInfoKHR) -> io Result

vkBuildAccelerationStructureKHR - Build an acceleration structure on the host

Parameters

This command fulfills the same task as cmdBuildAccelerationStructureKHR but executed by the host.

Description

• device is the Device for which the acceleration structures are being built.

• infoCount is the number of acceleration structures to build. It specifies the number of the pInfos structures and ppOffsetInfos pointers that must be provided.
• pInfos is a pointer to an array of infoCount AccelerationStructureBuildGeometryInfoKHR structures defining the geometry used to build each acceleration structure.
• ppOffsetInfos is an array of infoCount pointers to arrays of AccelerationStructureBuildOffsetInfoKHR structures. Each ppOffsetInfos[i] is an array of pInfos[i].geometryCount AccelerationStructureBuildOffsetInfoKHR structures defining dynamic offsets to the addresses where geometry data is stored, as defined by pInfos[i].

The buildAccelerationStructureKHR command provides the ability to initiate multiple acceleration structures builds, however there is no ordering or synchronization implied between any of the individual acceleration structure builds.

Note

This means that an application cannot build a top-level acceleration structure in the same buildAccelerationStructureKHR call as the associated bottom-level or instance acceleration structures are being built. There also cannot be any memory aliasing between any acceleration structure memories or scratch memories being used by any of the builds.

If the DeferredOperationInfoKHR structure is included in the pNext chain of any AccelerationStructureBuildGeometryInfoKHR structure, the operation of this command is deferred, as defined in the Deferred Host Operations chapter.

Valid Usage

• Each element of ppOffsetInfos[i] must be a valid pointer to an array of pInfos[i].geometryCount AccelerationStructureBuildOffsetInfoKHR structures

• Each pInfos[i].srcAccelerationStructure must not refer to the same acceleration structure as any pInfos[i].dstAccelerationStructure that is provided to the same build command unless it is identical for an update
• For each pInfos[i], dstAccelerationStructure must have been created with compatible AccelerationStructureCreateInfoKHR where AccelerationStructureCreateInfoKHR::type and AccelerationStructureCreateInfoKHR::flags are identical to AccelerationStructureBuildGeometryInfoKHR::type and AccelerationStructureBuildGeometryInfoKHR::flags respectively, AccelerationStructureBuildGeometryInfoKHR::geometryCount for dstAccelerationStructure are greater than or equal to the build size, and each geometry in AccelerationStructureBuildGeometryInfoKHR::ppGeometries for dstAccelerationStructure has greater than or equal to the number of vertices, indices, and AABBs, AccelerationStructureGeometryTrianglesDataKHR::transformData is both 0 or both non-zero, and all other parameters are the same
• For each pInfos[i], if update is TRUE, then objects that were previously active for that acceleration structure must not be made inactive as per ???
• For each pInfos[i], if update is TRUE, then objects that were previously inactive for that acceleration structure must not be made active as per ???
• Any acceleration structure instance in any top level build in this command must not reference any bottom level acceleration structure built by this command
• There must not be any memory aliasing between the scratch memories that are provided in all the pInfos[i].scratchData memories for the acceleration structure builds
• There must not be any memory aliasing between memory bound to any top level, bottom level, or instance acceleration structure accessed by this command
• All DeviceOrHostAddressKHR or DeviceOrHostAddressConstKHR referenced by this command must contain valid host addresses
• All AccelerationStructureKHR objects referenced by this command must be bound to host-visible memory
• The ::rayTracingHostAccelerationStructureCommands feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfos must be a valid pointer to an array of infoCount valid AccelerationStructureBuildGeometryInfoKHR structures
• ppOffsetInfos must be a valid pointer to an array of infoCount AccelerationStructureBuildOffsetInfoKHR structures
• infoCount must be greater than 0

Return Codes

Success

• SUCCESS
• OPERATION_DEFERRED_KHR
• OPERATION_NOT_DEFERRED_KHR

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureBuildOffsetInfoKHR, Device

getAccelerationStructureDeviceAddressKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that the accelerationStructure was created on.

-> AccelerationStructureDeviceAddressInfoKHR

pInfo is a pointer to a AccelerationStructureDeviceAddressInfoKHR structure specifying the acceleration structure to retrieve an address for.

-> io DeviceAddress

vkGetAccelerationStructureDeviceAddressKHR - Query an address of a acceleration structure

Description

The 64-bit return value is an address of the acceleration structure, which can be used for device and shader operations that involve acceleration structures, such as ray traversal and acceleration structure building.

If the acceleration structure was created with a non-zero value of AccelerationStructureCreateInfoKHR::deviceAddress the return value will be the same address.

Valid Usage

• If device was created with multiple physical devices, then the bufferDeviceAddressMultiDevice feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid AccelerationStructureDeviceAddressInfoKHR structure

See Also

AccelerationStructureDeviceAddressInfoKHR, Device

data RayTracingShaderGroupCreateInfoKHR

VkRayTracingShaderGroupCreateInfoKHR - Structure specifying shaders in a shader group

Valid Usage

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

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_SHADER_GROUP_CREATE_INFO_KHR

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

See Also

RayTracingPipelineCreateInfoKHR, RayTracingShaderGroupTypeKHR, StructureType

Constructors

RayTracingShaderGroupCreateInfoKHR

Fields

• type' :: RayTracingShaderGroupTypeKHR

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

• generalShader :: Word32

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

• closestHitShader :: Word32

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

• anyHitShader :: Word32

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

• intersectionShader :: Word32

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

• shaderGroupCaptureReplayHandle :: Ptr ()

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

Instances

Show RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> RayTracingShaderGroupCreateInfoKHR -> ShowS

show :: RayTracingShaderGroupCreateInfoKHR -> String

showList :: [RayTracingShaderGroupCreateInfoKHR] -> ShowS

Generic RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep RayTracingShaderGroupCreateInfoKHR :: Type -> Type

Methods

from :: RayTracingShaderGroupCreateInfoKHR -> Rep RayTracingShaderGroupCreateInfoKHR x

to :: Rep RayTracingShaderGroupCreateInfoKHR x -> RayTracingShaderGroupCreateInfoKHR

Storable RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: RayTracingShaderGroupCreateInfoKHR -> Int

alignment :: RayTracingShaderGroupCreateInfoKHR -> Int

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

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

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

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

peek :: Ptr RayTracingShaderGroupCreateInfoKHR -> IO RayTracingShaderGroupCreateInfoKHR

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

FromCStruct RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr RayTracingShaderGroupCreateInfoKHR -> IO RayTracingShaderGroupCreateInfoKHR

ToCStruct RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: RayTracingShaderGroupCreateInfoKHR

type Rep RayTracingShaderGroupCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep RayTracingShaderGroupCreateInfoKHR = D1 ('MetaData "RayTracingShaderGroupCreateInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "RayTracingShaderGroupCreateInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RayTracingShaderGroupTypeKHR) :*: (S1 ('MetaSel ('Just "generalShader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "closestHitShader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))) :*: (S1 ('MetaSel ('Just "anyHitShader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "intersectionShader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "shaderGroupCaptureReplayHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr ()))))))

data RayTracingPipelineCreateInfoKHR (es :: [Type])

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

Description

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

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

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

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

If the DeferredOperationInfoKHR structure is included in the pNext chain of RayTracingPipelineCreateInfoKHR, the operation of this pipeline creation is deferred, as defined in the Deferred Host Operations chapter.

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 stage member of at least one element of pStages must be SHADER_STAGE_RAYGEN_BIT_KHR
• The shader code for the entry points identified by pStages, and the rest of the state identified by this structure must adhere to the pipeline linking rules described in the Shader Interfaces chapter
• layout must be consistent with all shaders specified in pStages
• The number of resources in layout accessible to each shader stage that is used by the pipeline must be less than or equal to PhysicalDeviceLimits::maxPerStageResources
• flags must not include PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
• If the pipelineCreationCacheControl feature is not enabled, flags must not include PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT
• maxRecursionDepth must be less than or equal to PhysicalDeviceRayTracingPropertiesKHR::maxRecursionDepth
• If flags includes PIPELINE_CREATE_LIBRARY_BIT_KHR, pLibraryInterface must not be NULL
• If the libraryCount member of libraries is greater than 0, pLibraryInterface must not be NULL
• Each element of the pLibraries member of libraries must have been created with the value of maxRecursionDepth equal to that in this pipeline
• Each element of the pLibraries member of libraries must have been created with a layout that is compatible with the layout in this pipeline
• Each element of the pLibraries member of libraries must have been created with values of the maxPayloadSize, maxAttributeSize, and maxCallableSize members of pLibraryInterface equal to those in this pipeline
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, for any element of pGroups with a type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, the anyHitShader of that element must not be SHADER_UNUSED_KHR
• If flags includes PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, for any element of pGroups with a type of RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, the closestHitShader of that element must not be SHADER_UNUSED_KHR
• If the rayTracingPrimitiveCulling feature is not enabled, flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
• If the rayTracingPrimitiveCulling feature is not enabled, flags must not include PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
• If libraries.libraryCount is zero, then stageCount must not be zero
• If libraries.libraryCount is zero, then groupCount must not be zero

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_KHR

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

See Also

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

Constructors

RayTracingPipelineCreateInfoKHR

Fields

• next :: Chain es

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

• flags :: PipelineCreateFlags

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

• stages :: Vector (SomeStruct PipelineShaderStageCreateInfo)

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

• groups :: Vector RayTracingShaderGroupCreateInfoKHR

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

• maxRecursionDepth :: Word32

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

• libraries :: PipelineLibraryCreateInfoKHR

  libraries is a PipelineLibraryCreateInfoKHR structure defining pipeline libraries to include.

• libraryInterface :: Maybe RayTracingPipelineInterfaceCreateInfoKHR

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

• layout :: PipelineLayout

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

• basePipelineHandle :: Pipeline

  basePipelineHandle is a pipeline to derive from.

• basePipelineIndex :: Int32

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

Instances

Extensible RayTracingPipelineCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

extensibleType :: StructureType

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

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

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

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> RayTracingPipelineCreateInfoKHR es -> ShowS

show :: RayTracingPipelineCreateInfoKHR es -> String

showList :: [RayTracingPipelineCreateInfoKHR es] -> ShowS

Generic (RayTracingPipelineCreateInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep (RayTracingPipelineCreateInfoKHR es) :: Type -> Type

Methods

from :: RayTracingPipelineCreateInfoKHR es -> Rep (RayTracingPipelineCreateInfoKHR es) x

to :: Rep (RayTracingPipelineCreateInfoKHR es) x -> RayTracingPipelineCreateInfoKHR es

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: RayTracingPipelineCreateInfoKHR es

type Rep (RayTracingPipelineCreateInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep (RayTracingPipelineCreateInfoKHR es) = D1 ('MetaData "RayTracingPipelineCreateInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "RayTracingPipelineCreateInfoKHR" 'PrefixI 'True) (((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineCreateFlags)) :*: (S1 ('MetaSel ('Just "stages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector (SomeStruct PipelineShaderStageCreateInfo))) :*: (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector RayTracingShaderGroupCreateInfoKHR)) :*: S1 ('MetaSel ('Just "maxRecursionDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))) :*: ((S1 ('MetaSel ('Just "libraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineLibraryCreateInfoKHR) :*: S1 ('MetaSel ('Just "libraryInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RayTracingPipelineInterfaceCreateInfoKHR))) :*: (S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineLayout) :*: (S1 ('MetaSel ('Just "basePipelineHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Pipeline) :*: S1 ('MetaSel ('Just "basePipelineIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int32))))))

data BindAccelerationStructureMemoryInfoKHR

VkBindAccelerationStructureMemoryInfoKHR - 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 getAccelerationStructureMemoryRequirementsKHR with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR
• memoryOffset must be an integer multiple of the alignment member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR
• The size member of the MemoryRequirements structure returned from a call to getAccelerationStructureMemoryRequirementsKHR with accelerationStructure and type of ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR 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_KHR

• pNext must be NULL
• accelerationStructure must be a valid AccelerationStructureKHR 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

AccelerationStructureKHR, DeviceMemory, DeviceSize, StructureType, bindAccelerationStructureMemoryKHR, bindAccelerationStructureMemoryNV

Constructors

BindAccelerationStructureMemoryInfoKHR

Fields

• accelerationStructure :: AccelerationStructureKHR

  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 BindAccelerationStructureMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> BindAccelerationStructureMemoryInfoKHR -> ShowS

show :: BindAccelerationStructureMemoryInfoKHR -> String

showList :: [BindAccelerationStructureMemoryInfoKHR] -> ShowS

Generic BindAccelerationStructureMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep BindAccelerationStructureMemoryInfoKHR :: Type -> Type

Methods

from :: BindAccelerationStructureMemoryInfoKHR -> Rep BindAccelerationStructureMemoryInfoKHR x

to :: Rep BindAccelerationStructureMemoryInfoKHR x -> BindAccelerationStructureMemoryInfoKHR

FromCStruct BindAccelerationStructureMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr BindAccelerationStructureMemoryInfoKHR -> IO BindAccelerationStructureMemoryInfoKHR

ToCStruct BindAccelerationStructureMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr BindAccelerationStructureMemoryInfoKHR -> BindAccelerationStructureMemoryInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BindAccelerationStructureMemoryInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BindAccelerationStructureMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: BindAccelerationStructureMemoryInfoKHR

type Rep BindAccelerationStructureMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep BindAccelerationStructureMemoryInfoKHR = D1 ('MetaData "BindAccelerationStructureMemoryInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "BindAccelerationStructureMemoryInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accelerationStructure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR) :*: S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceMemory)) :*: (S1 ('MetaSel ('Just "memoryOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "deviceIndices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Word32)))))

data WriteDescriptorSetAccelerationStructureKHR

VkWriteDescriptorSetAccelerationStructureKHR - Structure specifying acceleration structure descriptor info

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_ACCELERATION_STRUCTURE_KHR

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

See Also

AccelerationStructureKHR, StructureType

Constructors

WriteDescriptorSetAccelerationStructureKHR

Fields

• accelerationStructures :: Vector AccelerationStructureKHR

  pAccelerationStructures are the acceleration structures to update.

Instances

Show WriteDescriptorSetAccelerationStructureKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> WriteDescriptorSetAccelerationStructureKHR -> ShowS

show :: WriteDescriptorSetAccelerationStructureKHR -> String

showList :: [WriteDescriptorSetAccelerationStructureKHR] -> ShowS

Generic WriteDescriptorSetAccelerationStructureKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep WriteDescriptorSetAccelerationStructureKHR :: Type -> Type

Methods

from :: WriteDescriptorSetAccelerationStructureKHR -> Rep WriteDescriptorSetAccelerationStructureKHR x

to :: Rep WriteDescriptorSetAccelerationStructureKHR x -> WriteDescriptorSetAccelerationStructureKHR

FromCStruct WriteDescriptorSetAccelerationStructureKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr WriteDescriptorSetAccelerationStructureKHR -> IO WriteDescriptorSetAccelerationStructureKHR

ToCStruct WriteDescriptorSetAccelerationStructureKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr WriteDescriptorSetAccelerationStructureKHR -> WriteDescriptorSetAccelerationStructureKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr WriteDescriptorSetAccelerationStructureKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero WriteDescriptorSetAccelerationStructureKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: WriteDescriptorSetAccelerationStructureKHR

type Rep WriteDescriptorSetAccelerationStructureKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep WriteDescriptorSetAccelerationStructureKHR = D1 ('MetaData "WriteDescriptorSetAccelerationStructureKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "WriteDescriptorSetAccelerationStructureKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "accelerationStructures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AccelerationStructureKHR))))

data AccelerationStructureMemoryRequirementsInfoKHR

VkAccelerationStructureMemoryRequirementsInfoKHR - Structure specifying acceleration to query for memory requirements

Valid Usage (Implicit)

See Also

AccelerationStructureBuildTypeKHR, AccelerationStructureKHR, AccelerationStructureMemoryRequirementsTypeKHR, StructureType, getAccelerationStructureMemoryRequirementsKHR

Constructors

AccelerationStructureMemoryRequirementsInfoKHR

Fields

• type' :: AccelerationStructureMemoryRequirementsTypeKHR

  type selects the type of memory requirement being queried. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR returns the memory requirements for the object itself. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_KHR returns the memory requirements for the scratch memory when doing a build. ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_KHR returns the memory requirements for the scratch memory when doing an update.

  type must be a valid AccelerationStructureMemoryRequirementsTypeKHR value

• buildType :: AccelerationStructureBuildTypeKHR

  buildType selects the build types whose memory requirements are being queried.

  buildType must be a valid AccelerationStructureBuildTypeKHR value

• accelerationStructure :: AccelerationStructureKHR

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

  accelerationStructure must be a valid AccelerationStructureKHR handle

Instances

Eq AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: AccelerationStructureMemoryRequirementsInfoKHR -> AccelerationStructureMemoryRequirementsInfoKHR -> Bool

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

Show AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureMemoryRequirementsInfoKHR -> ShowS

show :: AccelerationStructureMemoryRequirementsInfoKHR -> String

showList :: [AccelerationStructureMemoryRequirementsInfoKHR] -> ShowS

Generic AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureMemoryRequirementsInfoKHR :: Type -> Type

Methods

from :: AccelerationStructureMemoryRequirementsInfoKHR -> Rep AccelerationStructureMemoryRequirementsInfoKHR x

to :: Rep AccelerationStructureMemoryRequirementsInfoKHR x -> AccelerationStructureMemoryRequirementsInfoKHR

Storable AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: AccelerationStructureMemoryRequirementsInfoKHR -> Int

alignment :: AccelerationStructureMemoryRequirementsInfoKHR -> Int

peekElemOff :: Ptr AccelerationStructureMemoryRequirementsInfoKHR -> Int -> IO AccelerationStructureMemoryRequirementsInfoKHR

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

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

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

peek :: Ptr AccelerationStructureMemoryRequirementsInfoKHR -> IO AccelerationStructureMemoryRequirementsInfoKHR

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

FromCStruct AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureMemoryRequirementsInfoKHR -> IO AccelerationStructureMemoryRequirementsInfoKHR

ToCStruct AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureMemoryRequirementsInfoKHR -> AccelerationStructureMemoryRequirementsInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureMemoryRequirementsInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureMemoryRequirementsInfoKHR

type Rep AccelerationStructureMemoryRequirementsInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureMemoryRequirementsInfoKHR = D1 ('MetaData "AccelerationStructureMemoryRequirementsInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureMemoryRequirementsInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureMemoryRequirementsTypeKHR) :*: (S1 ('MetaSel ('Just "buildType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureBuildTypeKHR) :*: S1 ('MetaSel ('Just "accelerationStructure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR))))

data PhysicalDeviceRayTracingFeaturesKHR

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

Members

The members of the PhysicalDeviceRayTracingFeaturesKHR structure describe the following features:

Description

• rayTracing indicates whether the implementation supports ray tracing functionality. See Ray Tracing.

• rayTracingShaderGroupHandleCaptureReplay indicates whether the implementation supports saving and reusing shader group handles, e.g. for trace capture and replay.
• rayTracingShaderGroupHandleCaptureReplayMixed indicates whether the implementation supports reuse of shader group handles being arbitrarily mixed with creation of non-reused shader group handles. If this is FALSE, all reused shader group handles must be specified before any non-reused handles may be created.
• rayTracingAccelerationStructureCaptureReplay indicates whether the implementation supports saving and reusing acceleration structure device addresses, e.g. for trace capture and replay.
• rayTracingIndirectTraceRays indicates whether the implementation supports indirect trace ray commands, e.g. cmdTraceRaysIndirectKHR.
• rayTracingIndirectAccelerationStructureBuild indicates whether the implementation supports indirect acceleration structure build commands, e.g. cmdBuildAccelerationStructureIndirectKHR.
• rayTracingHostAccelerationStructureCommands indicates whether the implementation supports host side acceleration structure commands, e.g. buildAccelerationStructureKHR, copyAccelerationStructureKHR, copyAccelerationStructureToMemoryKHR, copyMemoryToAccelerationStructureKHR, writeAccelerationStructuresPropertiesKHR.
• rayQuery indicates whether the implementation supports ray query (OpRayQueryProceedKHR) functionality.
• rayTracingPrimitiveCulling indicates whether the implementation supports primitive culling during ray traversal.

If the PhysicalDeviceRayTracingFeaturesKHR structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDeviceRayTracingFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to enable the features.

Valid Usage

• If rayTracingShaderGroupHandleCaptureReplayMixed is TRUE, rayTracingShaderGroupHandleCaptureReplay must also be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_FEATURES_KHR

See Also

Bool32, StructureType

Constructors

PhysicalDeviceRayTracingFeaturesKHR

Fields

• rayTracing :: Bool
• rayTracingShaderGroupHandleCaptureReplay :: Bool
• rayTracingShaderGroupHandleCaptureReplayMixed :: Bool
• rayTracingAccelerationStructureCaptureReplay :: Bool
• rayTracingIndirectTraceRays :: Bool
• rayTracingIndirectAccelerationStructureBuild :: Bool
• rayTracingHostAccelerationStructureCommands :: Bool
• rayQuery :: Bool
• rayTracingPrimitiveCulling :: Bool

Instances

Eq PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: PhysicalDeviceRayTracingFeaturesKHR -> PhysicalDeviceRayTracingFeaturesKHR -> Bool

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

Show PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> PhysicalDeviceRayTracingFeaturesKHR -> ShowS

show :: PhysicalDeviceRayTracingFeaturesKHR -> String

showList :: [PhysicalDeviceRayTracingFeaturesKHR] -> ShowS

Generic PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep PhysicalDeviceRayTracingFeaturesKHR :: Type -> Type

Methods

from :: PhysicalDeviceRayTracingFeaturesKHR -> Rep PhysicalDeviceRayTracingFeaturesKHR x

to :: Rep PhysicalDeviceRayTracingFeaturesKHR x -> PhysicalDeviceRayTracingFeaturesKHR

Storable PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: PhysicalDeviceRayTracingFeaturesKHR -> Int

alignment :: PhysicalDeviceRayTracingFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceRayTracingFeaturesKHR -> Int -> IO PhysicalDeviceRayTracingFeaturesKHR

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

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

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

peek :: Ptr PhysicalDeviceRayTracingFeaturesKHR -> IO PhysicalDeviceRayTracingFeaturesKHR

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

FromCStruct PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr PhysicalDeviceRayTracingFeaturesKHR -> IO PhysicalDeviceRayTracingFeaturesKHR

ToCStruct PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr PhysicalDeviceRayTracingFeaturesKHR -> PhysicalDeviceRayTracingFeaturesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceRayTracingFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: PhysicalDeviceRayTracingFeaturesKHR

type Rep PhysicalDeviceRayTracingFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep PhysicalDeviceRayTracingFeaturesKHR = D1 ('MetaData "PhysicalDeviceRayTracingFeaturesKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "PhysicalDeviceRayTracingFeaturesKHR" 'PrefixI 'True) (((S1 ('MetaSel ('Just "rayTracing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rayTracingShaderGroupHandleCaptureReplay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "rayTracingShaderGroupHandleCaptureReplayMixed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rayTracingAccelerationStructureCaptureReplay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "rayTracingIndirectTraceRays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rayTracingIndirectAccelerationStructureBuild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "rayTracingHostAccelerationStructureCommands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "rayQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rayTracingPrimitiveCulling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

data PhysicalDeviceRayTracingPropertiesKHR

VkPhysicalDeviceRayTracingPropertiesKHR - Properties of the physical device for ray tracing

Description

If the PhysicalDeviceRayTracingPropertiesKHR structure is included in the pNext chain of PhysicalDeviceProperties2, it is filled with the implementation-dependent limits.

Limits specified by this structure must match those specified with the same name in PhysicalDeviceRayTracingPropertiesNV.

Valid Usage (Implicit)

See Also

StructureType

Constructors

PhysicalDeviceRayTracingPropertiesKHR

Fields

• shaderGroupHandleSize :: Word32

  shaderGroupHandleSize 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 SBT.

• shaderGroupBaseAlignment :: Word32

  shaderGroupBaseAlignment is the required alignment in bytes for the base of the SBTs.

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

• maxPrimitiveCount :: Word64

  maxPrimitiveCount is the maximum number of triangles or AABBs 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.

• shaderGroupHandleCaptureReplaySize :: Word32

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

Instances

Eq PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: PhysicalDeviceRayTracingPropertiesKHR -> PhysicalDeviceRayTracingPropertiesKHR -> Bool

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

Show PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> PhysicalDeviceRayTracingPropertiesKHR -> ShowS

show :: PhysicalDeviceRayTracingPropertiesKHR -> String

showList :: [PhysicalDeviceRayTracingPropertiesKHR] -> ShowS

Generic PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep PhysicalDeviceRayTracingPropertiesKHR :: Type -> Type

Methods

from :: PhysicalDeviceRayTracingPropertiesKHR -> Rep PhysicalDeviceRayTracingPropertiesKHR x

to :: Rep PhysicalDeviceRayTracingPropertiesKHR x -> PhysicalDeviceRayTracingPropertiesKHR

Storable PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: PhysicalDeviceRayTracingPropertiesKHR -> Int

alignment :: PhysicalDeviceRayTracingPropertiesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceRayTracingPropertiesKHR -> Int -> IO PhysicalDeviceRayTracingPropertiesKHR

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

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

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

peek :: Ptr PhysicalDeviceRayTracingPropertiesKHR -> IO PhysicalDeviceRayTracingPropertiesKHR

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

FromCStruct PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr PhysicalDeviceRayTracingPropertiesKHR -> IO PhysicalDeviceRayTracingPropertiesKHR

ToCStruct PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr PhysicalDeviceRayTracingPropertiesKHR -> PhysicalDeviceRayTracingPropertiesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceRayTracingPropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: PhysicalDeviceRayTracingPropertiesKHR

type Rep PhysicalDeviceRayTracingPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep PhysicalDeviceRayTracingPropertiesKHR = D1 ('MetaData "PhysicalDeviceRayTracingPropertiesKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "PhysicalDeviceRayTracingPropertiesKHR" 'PrefixI 'True) (((S1 ('MetaSel ('Just "shaderGroupHandleSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "maxRecursionDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "maxShaderGroupStride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "shaderGroupBaseAlignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))) :*: ((S1 ('MetaSel ('Just "maxGeometryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "maxInstanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "maxPrimitiveCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64) :*: (S1 ('MetaSel ('Just "maxDescriptorSetAccelerationStructures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "shaderGroupHandleCaptureReplaySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))))

data StridedBufferRegionKHR

VkStridedBufferRegionKHR - Structure specifying a region of a VkBuffer with a stride

Valid Usage

• If buffer is not NULL_HANDLE, size plus offset must be less than or equal to the size of buffer

• If buffer is not NULL_HANDLE, stride must be less than the size of buffer

Valid Usage (Implicit)

• If buffer is not NULL_HANDLE, buffer must be a valid Buffer handle

See Also

Buffer, DeviceSize, cmdTraceRaysIndirectKHR, cmdTraceRaysKHR

Constructors

StridedBufferRegionKHR

Fields

• buffer :: Buffer

  buffer is the buffer containing this region.

• offset :: DeviceSize

  offset is the byte offset in buffer at which the region starts.

• stride :: DeviceSize

  stride is the byte stride between consecutive elements.

• size :: DeviceSize

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

Instances

Eq StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: StridedBufferRegionKHR -> StridedBufferRegionKHR -> Bool

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

Show StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> StridedBufferRegionKHR -> ShowS

show :: StridedBufferRegionKHR -> String

showList :: [StridedBufferRegionKHR] -> ShowS

Generic StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep StridedBufferRegionKHR :: Type -> Type

Methods

from :: StridedBufferRegionKHR -> Rep StridedBufferRegionKHR x

to :: Rep StridedBufferRegionKHR x -> StridedBufferRegionKHR

Storable StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: StridedBufferRegionKHR -> Int

alignment :: StridedBufferRegionKHR -> Int

peekElemOff :: Ptr StridedBufferRegionKHR -> Int -> IO StridedBufferRegionKHR

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

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

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

peek :: Ptr StridedBufferRegionKHR -> IO StridedBufferRegionKHR

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

FromCStruct StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr StridedBufferRegionKHR -> IO StridedBufferRegionKHR

ToCStruct StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr StridedBufferRegionKHR -> StridedBufferRegionKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr StridedBufferRegionKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: StridedBufferRegionKHR

type Rep StridedBufferRegionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep StridedBufferRegionKHR = D1 ('MetaData "StridedBufferRegionKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "StridedBufferRegionKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Buffer) :*: S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize)) :*: (S1 ('MetaSel ('Just "stride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize))))

data TraceRaysIndirectCommandKHR

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

Description

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

Valid Usage

See Also

No cross-references are available

Constructors

TraceRaysIndirectCommandKHR

Fields

• width :: Word32

  width is the width of the ray trace query dimensions.

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

• height :: Word32

  height is height of the ray trace query dimensions.

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

• depth :: Word32

  depth is depth of the ray trace query dimensions.

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

Instances

Eq TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Show TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> TraceRaysIndirectCommandKHR -> ShowS

show :: TraceRaysIndirectCommandKHR -> String

showList :: [TraceRaysIndirectCommandKHR] -> ShowS

Generic TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep TraceRaysIndirectCommandKHR :: Type -> Type

Methods

from :: TraceRaysIndirectCommandKHR -> Rep TraceRaysIndirectCommandKHR x

to :: Rep TraceRaysIndirectCommandKHR x -> TraceRaysIndirectCommandKHR

Storable TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: TraceRaysIndirectCommandKHR -> Int

alignment :: TraceRaysIndirectCommandKHR -> Int

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

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

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

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

peek :: Ptr TraceRaysIndirectCommandKHR -> IO TraceRaysIndirectCommandKHR

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

FromCStruct TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr TraceRaysIndirectCommandKHR -> IO TraceRaysIndirectCommandKHR

ToCStruct TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: TraceRaysIndirectCommandKHR

type Rep TraceRaysIndirectCommandKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep TraceRaysIndirectCommandKHR = D1 ('MetaData "TraceRaysIndirectCommandKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "TraceRaysIndirectCommandKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "depth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))

data AccelerationStructureGeometryTrianglesDataKHR

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_TRIANGLES_DATA_KHR

• pNext must be NULL
• vertexFormat must be a valid Format value
• vertexData must be a valid DeviceOrHostAddressConstKHR union
• indexType must be a valid IndexType value
• If indexData is not 0, indexData must be a valid DeviceOrHostAddressConstKHR union
• If transformData is not 0, transformData must be a valid DeviceOrHostAddressConstKHR union

See Also

AccelerationStructureGeometryDataKHR, DeviceOrHostAddressConstKHR, DeviceSize, Format, IndexType, StructureType

Constructors

AccelerationStructureGeometryTrianglesDataKHR

Fields

• vertexFormat :: Format

  vertexFormat is the Format of each vertex element.

• vertexData :: DeviceOrHostAddressConstKHR

  vertexData is a device or host address to memory containing vertex data for this geometry.

• vertexStride :: DeviceSize

  vertexStride is the stride in bytes between each vertex.

• indexType :: IndexType

  indexType is the IndexType of each index element.

• indexData :: DeviceOrHostAddressConstKHR

  indexData is a device or host address to memory containing index data for this geometry.

• transformData :: DeviceOrHostAddressConstKHR

  transformData is a device or host address to memory containing an optional reference to a TransformMatrixKHR structure defining a transformation that should be applied to vertices in this geometry.

Instances

Show AccelerationStructureGeometryTrianglesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureGeometryTrianglesDataKHR -> ShowS

show :: AccelerationStructureGeometryTrianglesDataKHR -> String

showList :: [AccelerationStructureGeometryTrianglesDataKHR] -> ShowS

Generic AccelerationStructureGeometryTrianglesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureGeometryTrianglesDataKHR :: Type -> Type

Methods

from :: AccelerationStructureGeometryTrianglesDataKHR -> Rep AccelerationStructureGeometryTrianglesDataKHR x

to :: Rep AccelerationStructureGeometryTrianglesDataKHR x -> AccelerationStructureGeometryTrianglesDataKHR

ToCStruct AccelerationStructureGeometryTrianglesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureGeometryTrianglesDataKHR -> AccelerationStructureGeometryTrianglesDataKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureGeometryTrianglesDataKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureGeometryTrianglesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureGeometryTrianglesDataKHR

type Rep AccelerationStructureGeometryTrianglesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureGeometryTrianglesDataKHR = D1 ('MetaData "AccelerationStructureGeometryTrianglesDataKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureGeometryTrianglesDataKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vertexFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Format) :*: (S1 ('MetaSel ('Just "vertexData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressConstKHR) :*: S1 ('MetaSel ('Just "vertexStride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize))) :*: (S1 ('MetaSel ('Just "indexType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexType) :*: (S1 ('MetaSel ('Just "indexData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressConstKHR) :*: S1 ('MetaSel ('Just "transformData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressConstKHR)))))

data AccelerationStructureGeometryAabbsDataKHR

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

Valid Usage (Implicit)

See Also

AccelerationStructureGeometryDataKHR, DeviceOrHostAddressConstKHR, DeviceSize, StructureType

Constructors

AccelerationStructureGeometryAabbsDataKHR

Fields

• data' :: DeviceOrHostAddressConstKHR

  data is a device or host address to memory containing AabbPositionsKHR structures containing position data for each axis-aligned bounding box in the geometry.

  data must be aligned to 8 bytes

  data must be a valid DeviceOrHostAddressConstKHR union

• stride :: DeviceSize

  stride is the stride in bytes between each entry in data.

  stride must be a multiple of 8

Instances

Show AccelerationStructureGeometryAabbsDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureGeometryAabbsDataKHR -> ShowS

show :: AccelerationStructureGeometryAabbsDataKHR -> String

showList :: [AccelerationStructureGeometryAabbsDataKHR] -> ShowS

Generic AccelerationStructureGeometryAabbsDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureGeometryAabbsDataKHR :: Type -> Type

Methods

from :: AccelerationStructureGeometryAabbsDataKHR -> Rep AccelerationStructureGeometryAabbsDataKHR x

to :: Rep AccelerationStructureGeometryAabbsDataKHR x -> AccelerationStructureGeometryAabbsDataKHR

ToCStruct AccelerationStructureGeometryAabbsDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureGeometryAabbsDataKHR -> AccelerationStructureGeometryAabbsDataKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureGeometryAabbsDataKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureGeometryAabbsDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureGeometryAabbsDataKHR

type Rep AccelerationStructureGeometryAabbsDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureGeometryAabbsDataKHR = D1 ('MetaData "AccelerationStructureGeometryAabbsDataKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureGeometryAabbsDataKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressConstKHR) :*: S1 ('MetaSel ('Just "stride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize)))

data AccelerationStructureGeometryInstancesDataKHR

VkAccelerationStructureGeometryInstancesDataKHR - Structure specifying a geometry consisting of instances of other acceleration structures

Valid Usage

• data must be aligned to 16 bytes

• If arrayOfPointers is true, each pointer must be aligned to 16 bytes

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_INSTANCES_DATA_KHR

• pNext must be NULL
• data must be a valid DeviceOrHostAddressConstKHR union

See Also

AccelerationStructureGeometryDataKHR, Bool32, DeviceOrHostAddressConstKHR, StructureType

Constructors

AccelerationStructureGeometryInstancesDataKHR

Fields

• arrayOfPointers :: Bool

  arrayOfPointers specifies whether data is used as an array of addresses or just an array.

• data' :: DeviceOrHostAddressConstKHR

  data is either the address of an array of device or host addresses referencing individual AccelerationStructureInstanceKHR structures if arrayOfPointers is TRUE, or the address of an array of AccelerationStructureInstanceKHR structures.

Instances

Show AccelerationStructureGeometryInstancesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureGeometryInstancesDataKHR -> ShowS

show :: AccelerationStructureGeometryInstancesDataKHR -> String

showList :: [AccelerationStructureGeometryInstancesDataKHR] -> ShowS

Generic AccelerationStructureGeometryInstancesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureGeometryInstancesDataKHR :: Type -> Type

Methods

from :: AccelerationStructureGeometryInstancesDataKHR -> Rep AccelerationStructureGeometryInstancesDataKHR x

to :: Rep AccelerationStructureGeometryInstancesDataKHR x -> AccelerationStructureGeometryInstancesDataKHR

ToCStruct AccelerationStructureGeometryInstancesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureGeometryInstancesDataKHR -> AccelerationStructureGeometryInstancesDataKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureGeometryInstancesDataKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureGeometryInstancesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureGeometryInstancesDataKHR

type Rep AccelerationStructureGeometryInstancesDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureGeometryInstancesDataKHR = D1 ('MetaData "AccelerationStructureGeometryInstancesDataKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureGeometryInstancesDataKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "arrayOfPointers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressConstKHR)))

data AccelerationStructureGeometryKHR

VkAccelerationStructureGeometryKHR - Structure specifying geometries to be built into an acceleration structure

Valid Usage

• If geometryType is GEOMETRY_TYPE_AABBS_KHR, the aabbs member of geometry must be a valid AccelerationStructureGeometryAabbsDataKHR structure

• If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, the triangles member of geometry must be a valid AccelerationStructureGeometryTrianglesDataKHR structure
• If geometryType is GEOMETRY_TYPE_INSTANCES_KHR, the instances member of geometry must be a valid AccelerationStructureGeometryInstancesDataKHR structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_KHR

• pNext must be NULL
• geometryType must be a valid GeometryTypeKHR value
• If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, the triangles member of geometry must be a valid AccelerationStructureGeometryTrianglesDataKHR structure
• If geometryType is GEOMETRY_TYPE_AABBS_KHR, the aabbs member of geometry must be a valid AccelerationStructureGeometryAabbsDataKHR structure
• If geometryType is GEOMETRY_TYPE_INSTANCES_KHR, the instances member of geometry must be a valid AccelerationStructureGeometryInstancesDataKHR structure
• flags must be a valid combination of GeometryFlagBitsKHR values

See Also

AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureGeometryDataKHR, GeometryFlagsKHR, GeometryTypeKHR, StructureType

Constructors

AccelerationStructureGeometryKHR

Fields

• geometryType :: GeometryTypeKHR

  geometryType describes which type of geometry this AccelerationStructureGeometryKHR refers to.

• geometry :: AccelerationStructureGeometryDataKHR

  geometry is a AccelerationStructureGeometryDataKHR union describing the geometry data for the relevant geometry type.

• flags :: GeometryFlagsKHR

  flags is a bitmask of GeometryFlagBitsKHR values describing additional properties of how the geometry should be built.

Instances

Show AccelerationStructureGeometryKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureGeometryKHR -> ShowS

show :: AccelerationStructureGeometryKHR -> String

showList :: [AccelerationStructureGeometryKHR] -> ShowS

Generic AccelerationStructureGeometryKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureGeometryKHR :: Type -> Type

Methods

from :: AccelerationStructureGeometryKHR -> Rep AccelerationStructureGeometryKHR x

to :: Rep AccelerationStructureGeometryKHR x -> AccelerationStructureGeometryKHR

ToCStruct AccelerationStructureGeometryKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureGeometryKHR -> AccelerationStructureGeometryKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureGeometryKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureGeometryKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureGeometryKHR

type Rep AccelerationStructureGeometryKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureGeometryKHR = D1 ('MetaData "AccelerationStructureGeometryKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureGeometryKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "geometryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeometryTypeKHR) :*: (S1 ('MetaSel ('Just "geometry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureGeometryDataKHR) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeometryFlagsKHR))))

data AccelerationStructureBuildGeometryInfoKHR (es :: [Type])

VkAccelerationStructureBuildGeometryInfoKHR - Structure specifying the geometry data used to build an acceleration structure

Description

Note

Elements of ppGeometries are accessed as follows, based on geometryArrayOfPointers:

if (geometryArrayOfPointers) {
    use *(ppGeometries[i]);
} else {
    use (*ppGeometries)[i];
}

Valid Usage

• If update is TRUE, srcAccelerationStructure must not be NULL_HANDLE

• If update is TRUE, srcAccelerationStructure must have been built before with BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR set in AccelerationStructureBuildGeometryInfoKHR::flags
• scratchData must have been created with BUFFER_USAGE_RAY_TRACING_BIT_KHR usage flag
• If update is TRUE, the srcAccelerationStructure and dstAccelerationStructure objects must either be the same object or not have any memory aliasing

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_GEOMETRY_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of DeferredOperationInfoKHR
• The sType value of each struct in the pNext chain must be unique
• type must be a valid AccelerationStructureTypeKHR value
• flags must be a valid combination of BuildAccelerationStructureFlagBitsKHR values
• If srcAccelerationStructure is not NULL_HANDLE, srcAccelerationStructure must be a valid AccelerationStructureKHR handle
• dstAccelerationStructure must be a valid AccelerationStructureKHR handle
• scratchData must be a valid DeviceOrHostAddressKHR union
• Both of dstAccelerationStructure, and srcAccelerationStructure that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

AccelerationStructureGeometryKHR, AccelerationStructureKHR, AccelerationStructureTypeKHR, Bool32, BuildAccelerationStructureFlagsKHR, DeviceOrHostAddressKHR, StructureType, buildAccelerationStructureKHR, cmdBuildAccelerationStructureIndirectKHR, cmdBuildAccelerationStructureKHR

Constructors

AccelerationStructureBuildGeometryInfoKHR

Fields

• next :: Chain es

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

• type' :: AccelerationStructureTypeKHR

  type is a AccelerationStructureTypeKHR value specifying the type of acceleration structure being built.

• flags :: BuildAccelerationStructureFlagsKHR

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

• update :: Bool

  update specifies whether to update dstAccelerationStructure with the data in srcAccelerationStructure or not.

• srcAccelerationStructure :: AccelerationStructureKHR

  srcAccelerationStructure points to an existing acceleration structure that is to be used to update the dst acceleration structure when update is TRUE.

• dstAccelerationStructure :: AccelerationStructureKHR

  dstAccelerationStructure points to the target acceleration structure for the build.

• geometries :: Vector AccelerationStructureGeometryKHR

  ppGeometries is either a pointer to an array of pointers to AccelerationStructureGeometryKHR structures if geometryArrayOfPointers is TRUE, or a pointer to a pointer to an array of AccelerationStructureGeometryKHR structures if it is FALSE. Each element of the array describes the data used to build each acceleration structure geometry.

• scratchData :: DeviceOrHostAddressKHR

  scratchData is the device or host address to memory that will be used as scratch memory for the build.

Instances

Extensible AccelerationStructureBuildGeometryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (AccelerationStructureBuildGeometryInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureBuildGeometryInfoKHR es -> ShowS

show :: AccelerationStructureBuildGeometryInfoKHR es -> String

showList :: [AccelerationStructureBuildGeometryInfoKHR es] -> ShowS

Generic (AccelerationStructureBuildGeometryInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep (AccelerationStructureBuildGeometryInfoKHR es) :: Type -> Type

Methods

from :: AccelerationStructureBuildGeometryInfoKHR es -> Rep (AccelerationStructureBuildGeometryInfoKHR es) x

to :: Rep (AccelerationStructureBuildGeometryInfoKHR es) x -> AccelerationStructureBuildGeometryInfoKHR es

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureBuildGeometryInfoKHR es

type Rep (AccelerationStructureBuildGeometryInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep (AccelerationStructureBuildGeometryInfoKHR es) = D1 ('MetaData "AccelerationStructureBuildGeometryInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureBuildGeometryInfoKHR" 'PrefixI 'True) (((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureTypeKHR)) :*: (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BuildAccelerationStructureFlagsKHR) :*: S1 ('MetaSel ('Just "update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "srcAccelerationStructure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR) :*: S1 ('MetaSel ('Just "dstAccelerationStructure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR)) :*: (S1 ('MetaSel ('Just "geometries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AccelerationStructureGeometryKHR)) :*: S1 ('MetaSel ('Just "scratchData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressKHR)))))

data AccelerationStructureBuildOffsetInfoKHR

VkAccelerationStructureBuildOffsetInfoKHR - Structure specifying build offsets and counts for acceleration structure builds

Description

The primitive count and primitive offset are interpreted differently depending on the GeometryTypeKHR used:

• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, primitiveCount is the number of triangles to be built, where each triangle is treated as 3 vertices.

  • If the geometry uses indices, primitiveCount × 3 indices are consumed from AccelerationStructureGeometryTrianglesDataKHR::indexData, starting at an offset of primitiveOffset. The value of firstVertex is added to the index values before fetching vertices.
  • If the geometry does not use indices, primitiveCount × 3 vertices are consumed from AccelerationStructureGeometryTrianglesDataKHR::vertexData, starting at an offset of primitiveOffset + AccelerationStructureGeometryTrianglesDataKHR::vertexStride × firstVertex.
  • A single TransformMatrixKHR structure is consumed from AccelerationStructureGeometryTrianglesDataKHR::transformData, at an offset of transformOffset. This transformation matrix is used by all triangles.
• For geometries of type GEOMETRY_TYPE_AABBS_KHR, primitiveCount is the number of axis-aligned bounding boxes. primitiveCount AabbPositionsKHR structures are consumed from AccelerationStructureGeometryAabbsDataKHR::data, starting at an offset of primitiveOffset.
• For geometries of type GEOMETRY_TYPE_INSTANCES_KHR, primitiveCount is the number of acceleration structures. primitiveCount AccelerationStructureInstanceKHR structures are consumed from AccelerationStructureGeometryInstancesDataKHR::data, starting at an offset of primitiveOffset.

Valid Usage

• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, if the geometry uses indices, the offset primitiveOffset from AccelerationStructureGeometryTrianglesDataKHR::indexData must be a multiple of the element size of AccelerationStructureGeometryTrianglesDataKHR::indexType

• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, if the geometry doesn’t use indices, the offset primitiveOffset from AccelerationStructureGeometryTrianglesDataKHR::vertexData must be a multiple of the component size of AccelerationStructureGeometryTrianglesDataKHR::vertexFormat
• For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, the offset transformOffset from AccelerationStructureGeometryTrianglesDataKHR::transformData must be a multiple of 16
• For geometries of type GEOMETRY_TYPE_AABBS_KHR, the offset primitiveOffset from AccelerationStructureGeometryAabbsDataKHR::data must be a multiple of 8
• For geometries of type GEOMETRY_TYPE_INSTANCES_KHR, the offset primitiveOffset from AccelerationStructureGeometryInstancesDataKHR::data must be a multiple of 16 // TODO - Almost certainly should be more here

See Also

buildAccelerationStructureKHR, cmdBuildAccelerationStructureKHR

Constructors

AccelerationStructureBuildOffsetInfoKHR

Fields

• primitiveCount :: Word32

  primitiveCount defines the number of primitives for a corresponding acceleration structure geometry.

• primitiveOffset :: Word32

  primitiveOffset defines an offset in bytes into the memory where primitive data is defined.

• firstVertex :: Word32

  firstVertex is the index of the first vertex to build from for triangle geometry.

• transformOffset :: Word32

  transformOffset defines an offset in bytes into the memory where a transform matrix is defined.

Instances

Eq AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: AccelerationStructureBuildOffsetInfoKHR -> AccelerationStructureBuildOffsetInfoKHR -> Bool

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

Show AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureBuildOffsetInfoKHR -> ShowS

show :: AccelerationStructureBuildOffsetInfoKHR -> String

showList :: [AccelerationStructureBuildOffsetInfoKHR] -> ShowS

Generic AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureBuildOffsetInfoKHR :: Type -> Type

Methods

from :: AccelerationStructureBuildOffsetInfoKHR -> Rep AccelerationStructureBuildOffsetInfoKHR x

to :: Rep AccelerationStructureBuildOffsetInfoKHR x -> AccelerationStructureBuildOffsetInfoKHR

Storable AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: AccelerationStructureBuildOffsetInfoKHR -> Int

alignment :: AccelerationStructureBuildOffsetInfoKHR -> Int

peekElemOff :: Ptr AccelerationStructureBuildOffsetInfoKHR -> Int -> IO AccelerationStructureBuildOffsetInfoKHR

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

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

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

peek :: Ptr AccelerationStructureBuildOffsetInfoKHR -> IO AccelerationStructureBuildOffsetInfoKHR

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

FromCStruct AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureBuildOffsetInfoKHR -> IO AccelerationStructureBuildOffsetInfoKHR

ToCStruct AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureBuildOffsetInfoKHR -> AccelerationStructureBuildOffsetInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureBuildOffsetInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureBuildOffsetInfoKHR

type Rep AccelerationStructureBuildOffsetInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureBuildOffsetInfoKHR = D1 ('MetaData "AccelerationStructureBuildOffsetInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureBuildOffsetInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "primitiveCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "primitiveOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "firstVertex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "transformOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))

data AccelerationStructureCreateGeometryTypeInfoKHR

VkAccelerationStructureCreateGeometryTypeInfoKHR - Structure specifying the shape of geometries that will be built into an acceleration structure

Description

When geometryType is GEOMETRY_TYPE_TRIANGLES_KHR:

• if indexType is INDEX_TYPE_NONE_KHR, then this structure describes a set of triangles.
• if indexType is not INDEX_TYPE_NONE_KHR, then this structure describes a set of indexed triangles.

Valid Usage

• If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, vertexFormat must support the FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR in FormatProperties::bufferFeatures as returned by getPhysicalDeviceFormatProperties2

• If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, indexType must be INDEX_TYPE_UINT16, INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_GEOMETRY_TYPE_INFO_KHR

• pNext must be NULL
• geometryType must be a valid GeometryTypeKHR value
• indexType must be a valid IndexType value
• If vertexFormat is not 0, vertexFormat must be a valid Format value

See Also

AccelerationStructureCreateInfoKHR, Bool32, Format, GeometryTypeKHR, IndexType, StructureType

Constructors

AccelerationStructureCreateGeometryTypeInfoKHR

Fields

• geometryType :: GeometryTypeKHR

  geometryType is a GeometryTypeKHR that describes the type of an acceleration structure geometry.

• maxPrimitiveCount :: Word32

  maxPrimitiveCount describes the maximum number of primitives that can be built into an acceleration structure geometry.

• indexType :: IndexType

  indexType is a IndexType that describes the index type used to build this geometry when geometryType is GEOMETRY_TYPE_TRIANGLES_KHR.

• maxVertexCount :: Word32

  maxVertexCount describes the maximum vertex count that can be used to build an acceleration structure geometry when geometryType is GEOMETRY_TYPE_TRIANGLES_KHR.

• vertexFormat :: Format

  vertexFormat is a Format that describes the vertex format used to build this geometry when geometryType is GEOMETRY_TYPE_TRIANGLES_KHR.

• allowsTransforms :: Bool

  allowsTransforms indicates whether transform data can be used by this acceleration structure or not, when geometryType is GEOMETRY_TYPE_TRIANGLES_KHR.

Instances

Eq AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: AccelerationStructureCreateGeometryTypeInfoKHR -> AccelerationStructureCreateGeometryTypeInfoKHR -> Bool

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

Show AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureCreateGeometryTypeInfoKHR -> ShowS

show :: AccelerationStructureCreateGeometryTypeInfoKHR -> String

showList :: [AccelerationStructureCreateGeometryTypeInfoKHR] -> ShowS

Generic AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureCreateGeometryTypeInfoKHR :: Type -> Type

Methods

from :: AccelerationStructureCreateGeometryTypeInfoKHR -> Rep AccelerationStructureCreateGeometryTypeInfoKHR x

to :: Rep AccelerationStructureCreateGeometryTypeInfoKHR x -> AccelerationStructureCreateGeometryTypeInfoKHR

Storable AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: AccelerationStructureCreateGeometryTypeInfoKHR -> Int

alignment :: AccelerationStructureCreateGeometryTypeInfoKHR -> Int

peekElemOff :: Ptr AccelerationStructureCreateGeometryTypeInfoKHR -> Int -> IO AccelerationStructureCreateGeometryTypeInfoKHR

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

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

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

peek :: Ptr AccelerationStructureCreateGeometryTypeInfoKHR -> IO AccelerationStructureCreateGeometryTypeInfoKHR

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

FromCStruct AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureCreateGeometryTypeInfoKHR -> IO AccelerationStructureCreateGeometryTypeInfoKHR

ToCStruct AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureCreateGeometryTypeInfoKHR -> AccelerationStructureCreateGeometryTypeInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureCreateGeometryTypeInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureCreateGeometryTypeInfoKHR

type Rep AccelerationStructureCreateGeometryTypeInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureCreateGeometryTypeInfoKHR = D1 ('MetaData "AccelerationStructureCreateGeometryTypeInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureCreateGeometryTypeInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "geometryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeometryTypeKHR) :*: (S1 ('MetaSel ('Just "maxPrimitiveCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "indexType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexType))) :*: (S1 ('MetaSel ('Just "maxVertexCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "vertexFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Format) :*: S1 ('MetaSel ('Just "allowsTransforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

data AccelerationStructureCreateInfoKHR

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

Description

If deviceAddress is zero, no specific address is requested.

If deviceAddress is not zero, deviceAddress must be an address retrieved from an identically created acceleration structure on the same implementation. The acceleration structure must also be bound to an identically created DeviceMemory object.

Apps should avoid creating acceleration structures with app-provided addresses and implementation-provided addresses in the same process, to reduce the likelihood of ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR errors.

Valid Usage

• If compactedSize is not 0 then maxGeometryCount must be 0

• If compactedSize is 0 then maxGeometryCount must not be 0
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR then maxGeometryCount must be less than or equal to PhysicalDeviceRayTracingPropertiesKHR::maxGeometryCount
• If type is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR then the maxPrimitiveCount member of each element of the pGeometryInfos array must be less than or equal to PhysicalDeviceRayTracingPropertiesKHR::maxInstanceCount
• The total number of triangles in all geometries must be less than or equal to PhysicalDeviceRayTracingPropertiesKHR::maxPrimitiveCount
• The total number of AABBs in all geometries must be less than or equal to PhysicalDeviceRayTracingPropertiesKHR::maxPrimitiveCount
• If type is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR and compactedSize is 0, maxGeometryCount must be 1
• If type is ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR and compactedSize is 0, the geometryType member of elements of pGeometryInfos must be GEOMETRY_TYPE_INSTANCES_KHR
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR and compactedSize is 0, the geometryType member of elements of pGeometryInfos must not be GEOMETRY_TYPE_INSTANCES_KHR
• If type is ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR then the geometryType member of each geometry in pGeometryInfos must be the same
• If flags has the BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR bit set, then it must not have the BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR bit set
• If deviceAddress is not 0, PhysicalDeviceRayTracingFeaturesKHR::rayTracingAccelerationStructureCaptureReplay must be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR

• pNext must be NULL
• type must be a valid AccelerationStructureTypeKHR value
• flags must be a valid combination of BuildAccelerationStructureFlagBitsKHR values
• If maxGeometryCount is not 0, pGeometryInfos must be a valid pointer to an array of maxGeometryCount valid AccelerationStructureCreateGeometryTypeInfoKHR structures

See Also

AccelerationStructureCreateGeometryTypeInfoKHR, AccelerationStructureTypeKHR, BuildAccelerationStructureFlagsKHR, DeviceAddress, DeviceSize, StructureType, createAccelerationStructureKHR

Constructors

AccelerationStructureCreateInfoKHR

Fields

• compactedSize :: DeviceSize

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

• type' :: AccelerationStructureTypeKHR

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

• flags :: BuildAccelerationStructureFlagsKHR

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

• geometryInfos :: Vector AccelerationStructureCreateGeometryTypeInfoKHR

  pGeometryInfos is an array of maxGeometryCount AccelerationStructureCreateGeometryTypeInfoKHR structures, which describe the maximum size and format of the data that will be built into the acceleration structure.

• deviceAddress :: DeviceAddress

  deviceAddress is the device address requested for the acceleration structure if the rayTracingAccelerationStructureCaptureReplay feature is being used.

Instances

Show AccelerationStructureCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureCreateInfoKHR -> ShowS

show :: AccelerationStructureCreateInfoKHR -> String

showList :: [AccelerationStructureCreateInfoKHR] -> ShowS

Generic AccelerationStructureCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureCreateInfoKHR :: Type -> Type

Methods

from :: AccelerationStructureCreateInfoKHR -> Rep AccelerationStructureCreateInfoKHR x

to :: Rep AccelerationStructureCreateInfoKHR x -> AccelerationStructureCreateInfoKHR

FromCStruct AccelerationStructureCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureCreateInfoKHR -> IO AccelerationStructureCreateInfoKHR

ToCStruct AccelerationStructureCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureCreateInfoKHR -> AccelerationStructureCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureCreateInfoKHR

type Rep AccelerationStructureCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureCreateInfoKHR = D1 ('MetaData "AccelerationStructureCreateInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureCreateInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "compactedSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureTypeKHR)) :*: (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BuildAccelerationStructureFlagsKHR) :*: (S1 ('MetaSel ('Just "geometryInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AccelerationStructureCreateGeometryTypeInfoKHR)) :*: S1 ('MetaSel ('Just "deviceAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceAddress)))))

data AabbPositionsKHR

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

Valid Usage

See Also

No cross-references are available

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

Eq AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Show AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AabbPositionsKHR -> ShowS

show :: AabbPositionsKHR -> String

showList :: [AabbPositionsKHR] -> ShowS

Generic AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AabbPositionsKHR :: Type -> Type

Methods

from :: AabbPositionsKHR -> Rep AabbPositionsKHR x

to :: Rep AabbPositionsKHR x -> AabbPositionsKHR

Storable AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

FromCStruct AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AabbPositionsKHR -> IO AabbPositionsKHR

ToCStruct AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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_ray_tracing

Methods

zero :: AabbPositionsKHR

type Rep AabbPositionsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AabbPositionsKHR = D1 ('MetaData "AabbPositionsKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AabbPositionsKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "minX") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: (S1 ('MetaSel ('Just "minY") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: S1 ('MetaSel ('Just "minZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float))) :*: (S1 ('MetaSel ('Just "maxX") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: (S1 ('MetaSel ('Just "maxY") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float) :*: S1 ('MetaSel ('Just "maxZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Float)))))

data TransformMatrixKHR

VkTransformMatrixKHR - Structure specifying a 3x4 affine transformation matrix

See Also

AccelerationStructureInstanceKHR

Constructors

TransformMatrixKHR

Fields

• matrix :: ((Float, Float, Float, Float), (Float, Float, Float, Float), (Float, Float, Float, Float))

  matrix is a 3x4 row-major affine transformation matrix.

Instances

Eq TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Show TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> TransformMatrixKHR -> ShowS

show :: TransformMatrixKHR -> String

showList :: [TransformMatrixKHR] -> ShowS

Generic TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep TransformMatrixKHR :: Type -> Type

Methods

from :: TransformMatrixKHR -> Rep TransformMatrixKHR x

to :: Rep TransformMatrixKHR x -> TransformMatrixKHR

Storable TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

FromCStruct TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr TransformMatrixKHR -> IO TransformMatrixKHR

ToCStruct TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: TransformMatrixKHR

type Rep TransformMatrixKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep TransformMatrixKHR = D1 ('MetaData "TransformMatrixKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "TransformMatrixKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "matrix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ((Float, Float, Float, Float), (Float, Float, Float, Float), (Float, Float, Float, Float)))))

data AccelerationStructureInstanceKHR

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

Description

The C language spec 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

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 int32_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 rayMask & 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 int32_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

Show AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureInstanceKHR -> ShowS

show :: AccelerationStructureInstanceKHR -> String

showList :: [AccelerationStructureInstanceKHR] -> ShowS

Generic AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureInstanceKHR :: Type -> Type

Methods

from :: AccelerationStructureInstanceKHR -> Rep AccelerationStructureInstanceKHR x

to :: Rep AccelerationStructureInstanceKHR x -> AccelerationStructureInstanceKHR

FromCStruct AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureInstanceKHR -> IO AccelerationStructureInstanceKHR

ToCStruct AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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_ray_tracing

Methods

zero :: AccelerationStructureInstanceKHR

type Rep AccelerationStructureInstanceKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureInstanceKHR = D1 ('MetaData "AccelerationStructureInstanceKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureInstanceKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "transform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TransformMatrixKHR) :*: (S1 ('MetaSel ('Just "instanceCustomIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "mask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))) :*: (S1 ('MetaSel ('Just "instanceShaderBindingTableRecordOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeometryInstanceFlagsKHR) :*: S1 ('MetaSel ('Just "accelerationStructureReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64)))))

data AccelerationStructureDeviceAddressInfoKHR

VkAccelerationStructureDeviceAddressInfoKHR - Structure specifying the acceleration structure to query an address for

Valid Usage (Implicit)

See Also

AccelerationStructureKHR, StructureType, getAccelerationStructureDeviceAddressKHR

Constructors

AccelerationStructureDeviceAddressInfoKHR

Fields

• accelerationStructure :: AccelerationStructureKHR

  accelerationStructure specifies the acceleration structure whose address is being queried.

  accelerationStructure must be a valid AccelerationStructureKHR handle

Instances

Eq AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: AccelerationStructureDeviceAddressInfoKHR -> AccelerationStructureDeviceAddressInfoKHR -> Bool

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

Show AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureDeviceAddressInfoKHR -> ShowS

show :: AccelerationStructureDeviceAddressInfoKHR -> String

showList :: [AccelerationStructureDeviceAddressInfoKHR] -> ShowS

Generic AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureDeviceAddressInfoKHR :: Type -> Type

Methods

from :: AccelerationStructureDeviceAddressInfoKHR -> Rep AccelerationStructureDeviceAddressInfoKHR x

to :: Rep AccelerationStructureDeviceAddressInfoKHR x -> AccelerationStructureDeviceAddressInfoKHR

Storable AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: AccelerationStructureDeviceAddressInfoKHR -> Int

alignment :: AccelerationStructureDeviceAddressInfoKHR -> Int

peekElemOff :: Ptr AccelerationStructureDeviceAddressInfoKHR -> Int -> IO AccelerationStructureDeviceAddressInfoKHR

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

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

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

peek :: Ptr AccelerationStructureDeviceAddressInfoKHR -> IO AccelerationStructureDeviceAddressInfoKHR

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

FromCStruct AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureDeviceAddressInfoKHR -> IO AccelerationStructureDeviceAddressInfoKHR

ToCStruct AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureDeviceAddressInfoKHR -> AccelerationStructureDeviceAddressInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureDeviceAddressInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureDeviceAddressInfoKHR

type Rep AccelerationStructureDeviceAddressInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureDeviceAddressInfoKHR = D1 ('MetaData "AccelerationStructureDeviceAddressInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureDeviceAddressInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "accelerationStructure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR)))

data AccelerationStructureVersionKHR

VkAccelerationStructureVersionKHR - Acceleration structure version information

Valid Usage (Implicit)

See Also

StructureType, getDeviceAccelerationStructureCompatibilityKHR

Constructors

AccelerationStructureVersionKHR

Fields

• versionData :: ByteString

  versionData is a pointer to the version header as defined in CopyAccelerationStructureModeKHR

  versionData must be a valid pointer to an array of 2*VK_UUID_SIZE uint8_t values

Instances

Show AccelerationStructureVersionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureVersionKHR -> ShowS

show :: AccelerationStructureVersionKHR -> String

showList :: [AccelerationStructureVersionKHR] -> ShowS

Generic AccelerationStructureVersionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep AccelerationStructureVersionKHR :: Type -> Type

Methods

from :: AccelerationStructureVersionKHR -> Rep AccelerationStructureVersionKHR x

to :: Rep AccelerationStructureVersionKHR x -> AccelerationStructureVersionKHR

FromCStruct AccelerationStructureVersionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr AccelerationStructureVersionKHR -> IO AccelerationStructureVersionKHR

ToCStruct AccelerationStructureVersionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureVersionKHR -> AccelerationStructureVersionKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureVersionKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureVersionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureVersionKHR

type Rep AccelerationStructureVersionKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep AccelerationStructureVersionKHR = D1 ('MetaData "AccelerationStructureVersionKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "AccelerationStructureVersionKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "versionData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))

data CopyAccelerationStructureInfoKHR (es :: [Type])

VkCopyAccelerationStructureInfoKHR - Parameters for copying an acceleration structure

Valid Usage

• mode must be COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR or COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR

• src must have been built with BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if mode is COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of DeferredOperationInfoKHR
• The sType value of each struct in the pNext chain must be unique
• src must be a valid AccelerationStructureKHR handle
• dst must be a valid AccelerationStructureKHR handle
• mode must be a valid CopyAccelerationStructureModeKHR value
• Both of dst, and src must have been created, allocated, or retrieved from the same Device

See Also

AccelerationStructureKHR, CopyAccelerationStructureModeKHR, StructureType, cmdCopyAccelerationStructureKHR, copyAccelerationStructureKHR

Constructors

CopyAccelerationStructureInfoKHR

Fields

• next :: Chain es
• src :: AccelerationStructureKHR

  src is the source acceleration structure for the copy.

• dst :: AccelerationStructureKHR

  dst is the target acceleration structure for the copy.

• mode :: CopyAccelerationStructureModeKHR

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

Instances

Extensible CopyAccelerationStructureInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (CopyAccelerationStructureInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> CopyAccelerationStructureInfoKHR es -> ShowS

show :: CopyAccelerationStructureInfoKHR es -> String

showList :: [CopyAccelerationStructureInfoKHR es] -> ShowS

Generic (CopyAccelerationStructureInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep (CopyAccelerationStructureInfoKHR es) :: Type -> Type

Methods

from :: CopyAccelerationStructureInfoKHR es -> Rep (CopyAccelerationStructureInfoKHR es) x

to :: Rep (CopyAccelerationStructureInfoKHR es) x -> CopyAccelerationStructureInfoKHR es

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: CopyAccelerationStructureInfoKHR es

type Rep (CopyAccelerationStructureInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep (CopyAccelerationStructureInfoKHR es) = D1 ('MetaData "CopyAccelerationStructureInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "CopyAccelerationStructureInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "src") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR)) :*: (S1 ('MetaSel ('Just "dst") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CopyAccelerationStructureModeKHR))))

data CopyAccelerationStructureToMemoryInfoKHR (es :: [Type])

VkCopyAccelerationStructureToMemoryInfoKHR - Parameters for serializing an acceleration structure

Valid Usage

• The memory pointed to by dst must be at least as large as the serialization size of src, as reported by QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

• mode must be COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_ACCELERATION_STRUCTURE_TO_MEMORY_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of DeferredOperationInfoKHR
• The sType value of each struct in the pNext chain must be unique
• src must be a valid AccelerationStructureKHR handle
• dst must be a valid DeviceOrHostAddressKHR union
• mode must be a valid CopyAccelerationStructureModeKHR value

See Also

AccelerationStructureKHR, CopyAccelerationStructureModeKHR, DeviceOrHostAddressKHR, StructureType, cmdCopyAccelerationStructureToMemoryKHR, copyAccelerationStructureToMemoryKHR

Constructors

CopyAccelerationStructureToMemoryInfoKHR

Fields

• next :: Chain es
• src :: AccelerationStructureKHR

  src is the source acceleration structure for the copy

• dst :: DeviceOrHostAddressKHR

  dst is the device or host address to memory which is the target for the copy

• mode :: CopyAccelerationStructureModeKHR

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

Instances

Extensible CopyAccelerationStructureToMemoryInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (CopyAccelerationStructureToMemoryInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> CopyAccelerationStructureToMemoryInfoKHR es -> ShowS

show :: CopyAccelerationStructureToMemoryInfoKHR es -> String

showList :: [CopyAccelerationStructureToMemoryInfoKHR es] -> ShowS

Generic (CopyAccelerationStructureToMemoryInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep (CopyAccelerationStructureToMemoryInfoKHR es) :: Type -> Type

Methods

from :: CopyAccelerationStructureToMemoryInfoKHR es -> Rep (CopyAccelerationStructureToMemoryInfoKHR es) x

to :: Rep (CopyAccelerationStructureToMemoryInfoKHR es) x -> CopyAccelerationStructureToMemoryInfoKHR es

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: CopyAccelerationStructureToMemoryInfoKHR es

type Rep (CopyAccelerationStructureToMemoryInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep (CopyAccelerationStructureToMemoryInfoKHR es) = D1 ('MetaData "CopyAccelerationStructureToMemoryInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "CopyAccelerationStructureToMemoryInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "src") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR)) :*: (S1 ('MetaSel ('Just "dst") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressKHR) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CopyAccelerationStructureModeKHR))))

data CopyMemoryToAccelerationStructureInfoKHR (es :: [Type])

VkCopyMemoryToAccelerationStructureInfoKHR - Parameters for deserializing an acceleration structure

Valid Usage

• mode must be COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR

• The data in pInfo->src must have a format compatible with the destination physical device as returned by getDeviceAccelerationStructureCompatibilityKHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MEMORY_TO_ACCELERATION_STRUCTURE_INFO_KHR

• pNext must be NULL or a pointer to a valid instance of DeferredOperationInfoKHR
• The sType value of each struct in the pNext chain must be unique
• src must be a valid DeviceOrHostAddressConstKHR union
• dst must be a valid AccelerationStructureKHR handle
• mode must be a valid CopyAccelerationStructureModeKHR value

See Also

AccelerationStructureKHR, CopyAccelerationStructureModeKHR, DeviceOrHostAddressConstKHR, StructureType, cmdCopyMemoryToAccelerationStructureKHR, copyMemoryToAccelerationStructureKHR

Constructors

CopyMemoryToAccelerationStructureInfoKHR

Fields

• next :: Chain es
• src :: DeviceOrHostAddressConstKHR

  src is the device or host address to memory containing the source data for the copy.

• dst :: AccelerationStructureKHR

  dst is the target acceleration structure for the copy.

• mode :: CopyAccelerationStructureModeKHR

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

Instances

Extensible CopyMemoryToAccelerationStructureInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (CopyMemoryToAccelerationStructureInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> CopyMemoryToAccelerationStructureInfoKHR es -> ShowS

show :: CopyMemoryToAccelerationStructureInfoKHR es -> String

showList :: [CopyMemoryToAccelerationStructureInfoKHR es] -> ShowS

Generic (CopyMemoryToAccelerationStructureInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep (CopyMemoryToAccelerationStructureInfoKHR es) :: Type -> Type

Methods

from :: CopyMemoryToAccelerationStructureInfoKHR es -> Rep (CopyMemoryToAccelerationStructureInfoKHR es) x

to :: Rep (CopyMemoryToAccelerationStructureInfoKHR es) x -> CopyMemoryToAccelerationStructureInfoKHR es

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: CopyMemoryToAccelerationStructureInfoKHR es

type Rep (CopyMemoryToAccelerationStructureInfoKHR es)

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep (CopyMemoryToAccelerationStructureInfoKHR es) = D1 ('MetaData "CopyMemoryToAccelerationStructureInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "CopyMemoryToAccelerationStructureInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "src") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceOrHostAddressConstKHR)) :*: (S1 ('MetaSel ('Just "dst") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccelerationStructureKHR) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CopyAccelerationStructureModeKHR))))

data RayTracingPipelineInterfaceCreateInfoKHR

VkRayTracingPipelineInterfaceCreateInfoKHR - Structure specifying additional interface information when using libraries

Description

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

Valid Usage (Implicit)

See Also

RayTracingPipelineCreateInfoKHR, StructureType

Constructors

RayTracingPipelineInterfaceCreateInfoKHR

Fields

• maxPayloadSize :: Word32

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

• maxAttributeSize :: Word32

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

• maxCallableSize :: Word32

  maxCallableSize is the maximum callable data size in bytes used by any shader in the pipeline.

Instances

Eq RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Show RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> RayTracingPipelineInterfaceCreateInfoKHR -> ShowS

show :: RayTracingPipelineInterfaceCreateInfoKHR -> String

showList :: [RayTracingPipelineInterfaceCreateInfoKHR] -> ShowS

Generic RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Associated Types

type Rep RayTracingPipelineInterfaceCreateInfoKHR :: Type -> Type

Methods

from :: RayTracingPipelineInterfaceCreateInfoKHR -> Rep RayTracingPipelineInterfaceCreateInfoKHR x

to :: Rep RayTracingPipelineInterfaceCreateInfoKHR x -> RayTracingPipelineInterfaceCreateInfoKHR

Storable RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: RayTracingPipelineInterfaceCreateInfoKHR -> Int

alignment :: RayTracingPipelineInterfaceCreateInfoKHR -> Int

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

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

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

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

peek :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> IO RayTracingPipelineInterfaceCreateInfoKHR

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

FromCStruct RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

peekCStruct :: Ptr RayTracingPipelineInterfaceCreateInfoKHR -> IO RayTracingPipelineInterfaceCreateInfoKHR

ToCStruct RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: RayTracingPipelineInterfaceCreateInfoKHR

type Rep RayTracingPipelineInterfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

type Rep RayTracingPipelineInterfaceCreateInfoKHR = D1 ('MetaData "RayTracingPipelineInterfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_ray_tracing" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "RayTracingPipelineInterfaceCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxPayloadSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "maxAttributeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "maxCallableSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))

data DeviceOrHostAddressKHR

Constructors

DeviceAddress DeviceAddress

HostAddress (Ptr ())

Instances

Show DeviceOrHostAddressKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> DeviceOrHostAddressKHR -> ShowS

show :: DeviceOrHostAddressKHR -> String

showList :: [DeviceOrHostAddressKHR] -> ShowS

ToCStruct DeviceOrHostAddressKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr DeviceOrHostAddressKHR -> DeviceOrHostAddressKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceOrHostAddressKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceOrHostAddressKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: DeviceOrHostAddressKHR

data DeviceOrHostAddressConstKHR

Constructors

DeviceAddressConst DeviceAddress

HostAddressConst (Ptr ())

Instances

Show DeviceOrHostAddressConstKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> DeviceOrHostAddressConstKHR -> ShowS

show :: DeviceOrHostAddressConstKHR -> String

showList :: [DeviceOrHostAddressConstKHR] -> ShowS

ToCStruct DeviceOrHostAddressConstKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr DeviceOrHostAddressConstKHR -> DeviceOrHostAddressConstKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceOrHostAddressConstKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceOrHostAddressConstKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: DeviceOrHostAddressConstKHR

data AccelerationStructureGeometryDataKHR

Constructors

Triangles AccelerationStructureGeometryTrianglesDataKHR

Aabbs AccelerationStructureGeometryAabbsDataKHR

Instances AccelerationStructureGeometryInstancesDataKHR

Instances

Show AccelerationStructureGeometryDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureGeometryDataKHR -> ShowS

show :: AccelerationStructureGeometryDataKHR -> String

showList :: [AccelerationStructureGeometryDataKHR] -> ShowS

ToCStruct AccelerationStructureGeometryDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

pokeCStruct :: Ptr AccelerationStructureGeometryDataKHR -> AccelerationStructureGeometryDataKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureGeometryDataKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureGeometryDataKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureGeometryDataKHR

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

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_FRONT_COUNTERCLOCKWISE_BIT_KHR :: GeometryInstanceFlagBitsKHR

GEOMETRY_INSTANCE_TRIANGLE_FRONT_COUNTERCLOCKWISE_BIT_KHR indicates that the front face of the triangle for culling purposes is the face that is counter clockwise in object space relative to the ray origin. Because the facing is determined in object space, an instance transform matrix 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.

Instances

Eq GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Read GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS GeometryInstanceFlagBitsKHR

readList :: ReadS [GeometryInstanceFlagBitsKHR]

readPrec :: ReadPrec GeometryInstanceFlagBitsKHR

readListPrec :: ReadPrec [GeometryInstanceFlagBitsKHR]

Show GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> GeometryInstanceFlagBitsKHR -> ShowS

show :: GeometryInstanceFlagBitsKHR -> String

showList :: [GeometryInstanceFlagBitsKHR] -> ShowS

Storable GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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_ray_tracing

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

Zero GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: GeometryInstanceFlagBitsKHR

type GeometryInstanceFlagsKHR = GeometryInstanceFlagBitsKHR

newtype GeometryFlagBitsKHR

VkGeometryFlagBitsKHR - Bitmask specifying additional parameters for a geometry

See Also

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

Eq GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Read GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS GeometryFlagBitsKHR

readList :: ReadS [GeometryFlagBitsKHR]

readPrec :: ReadPrec GeometryFlagBitsKHR

readListPrec :: ReadPrec [GeometryFlagBitsKHR]

Show GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> GeometryFlagBitsKHR -> ShowS

show :: GeometryFlagBitsKHR -> String

showList :: [GeometryFlagBitsKHR] -> ShowS

Storable GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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_ray_tracing

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

Zero GeometryFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

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 update of TRUE in cmdBuildAccelerationStructureKHR or 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 build, potentially at the expense of build time or trace performance.

Instances

Eq BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Read BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS BuildAccelerationStructureFlagBitsKHR

readList :: ReadS [BuildAccelerationStructureFlagBitsKHR]

readPrec :: ReadPrec BuildAccelerationStructureFlagBitsKHR

readListPrec :: ReadPrec [BuildAccelerationStructureFlagBitsKHR]

Show BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> BuildAccelerationStructureFlagBitsKHR -> ShowS

show :: BuildAccelerationStructureFlagBitsKHR -> String

showList :: [BuildAccelerationStructureFlagBitsKHR] -> ShowS

Storable BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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_ray_tracing

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

Zero BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: BuildAccelerationStructureFlagBitsKHR

type BuildAccelerationStructureFlagsKHR = BuildAccelerationStructureFlagBitsKHR

newtype CopyAccelerationStructureModeKHR

VkCopyAccelerationStructureModeKHR - Acceleration structure copy mode

See Also

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.

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 compactedSize corresponding to the one returned by cmdWriteAccelerationStructuresPropertiesKHR after the build of the acceleration structure specified by src.

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

Eq CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Read CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS CopyAccelerationStructureModeKHR

readList :: ReadS [CopyAccelerationStructureModeKHR]

readPrec :: ReadPrec CopyAccelerationStructureModeKHR

readListPrec :: ReadPrec [CopyAccelerationStructureModeKHR]

Show CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> CopyAccelerationStructureModeKHR -> ShowS

show :: CopyAccelerationStructureModeKHR -> String

showList :: [CopyAccelerationStructureModeKHR] -> ShowS

Storable CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Zero CopyAccelerationStructureModeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: CopyAccelerationStructureModeKHR

newtype AccelerationStructureTypeKHR

VkAccelerationStructureTypeKHR - Type of acceleration structure

See Also

AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureCreateInfoKHR

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.

Instances

Eq AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Read AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS AccelerationStructureTypeKHR

readList :: ReadS [AccelerationStructureTypeKHR]

readPrec :: ReadPrec AccelerationStructureTypeKHR

readListPrec :: ReadPrec [AccelerationStructureTypeKHR]

Show AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureTypeKHR -> ShowS

show :: AccelerationStructureTypeKHR -> String

showList :: [AccelerationStructureTypeKHR] -> ShowS

Storable AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Zero AccelerationStructureTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureTypeKHR

newtype GeometryTypeKHR

VkGeometryTypeKHR - Enum specifying which type of geometry is provided

See Also

AccelerationStructureCreateGeometryTypeInfoKHR, 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

Eq GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Read GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS GeometryTypeKHR

readList :: ReadS [GeometryTypeKHR]

readPrec :: ReadPrec GeometryTypeKHR

readListPrec :: ReadPrec [GeometryTypeKHR]

Show GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> GeometryTypeKHR -> ShowS

show :: GeometryTypeKHR -> String

showList :: [GeometryTypeKHR] -> ShowS

Storable GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

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

Zero GeometryTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: GeometryTypeKHR

newtype AccelerationStructureMemoryRequirementsTypeKHR

VkAccelerationStructureMemoryRequirementsTypeKHR - Acceleration structure memory requirement type

See Also

AccelerationStructureMemoryRequirementsInfoKHR

Constructors

AccelerationStructureMemoryRequirementsTypeKHR Int32

Bundled Patterns

pattern ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR :: AccelerationStructureMemoryRequirementsTypeKHR

ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_OBJECT_KHR requests the memory requirement for the AccelerationStructureKHR backing store.

pattern ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_KHR :: AccelerationStructureMemoryRequirementsTypeKHR

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

pattern ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_KHR :: AccelerationStructureMemoryRequirementsTypeKHR

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

Instances

Eq AccelerationStructureMemoryRequirementsTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> Bool

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

Ord AccelerationStructureMemoryRequirementsTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

compare :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> Ordering

(<) :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> Bool

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

(>) :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> Bool

(>=) :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> Bool

max :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR

min :: AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR -> AccelerationStructureMemoryRequirementsTypeKHR

Read AccelerationStructureMemoryRequirementsTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS AccelerationStructureMemoryRequirementsTypeKHR

readList :: ReadS [AccelerationStructureMemoryRequirementsTypeKHR]

readPrec :: ReadPrec AccelerationStructureMemoryRequirementsTypeKHR

readListPrec :: ReadPrec [AccelerationStructureMemoryRequirementsTypeKHR]

Show AccelerationStructureMemoryRequirementsTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureMemoryRequirementsTypeKHR -> ShowS

show :: AccelerationStructureMemoryRequirementsTypeKHR -> String

showList :: [AccelerationStructureMemoryRequirementsTypeKHR] -> ShowS

Storable AccelerationStructureMemoryRequirementsTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: AccelerationStructureMemoryRequirementsTypeKHR -> Int

alignment :: AccelerationStructureMemoryRequirementsTypeKHR -> Int

peekElemOff :: Ptr AccelerationStructureMemoryRequirementsTypeKHR -> Int -> IO AccelerationStructureMemoryRequirementsTypeKHR

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

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

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

peek :: Ptr AccelerationStructureMemoryRequirementsTypeKHR -> IO AccelerationStructureMemoryRequirementsTypeKHR

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

Zero AccelerationStructureMemoryRequirementsTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureMemoryRequirementsTypeKHR

newtype AccelerationStructureBuildTypeKHR

VkAccelerationStructureBuildTypeKHR - Acceleration structure build type

See Also

AccelerationStructureMemoryRequirementsInfoKHR

Constructors

AccelerationStructureBuildTypeKHR Int32

Bundled Patterns

pattern ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR :: AccelerationStructureBuildTypeKHR

ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR requests the memory requirement for operations performed by the host.

pattern ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR :: AccelerationStructureBuildTypeKHR

ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR requests the memory requirement for operations performed by the device.

pattern ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR :: AccelerationStructureBuildTypeKHR

ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR requests the memory requirement for operations performed by either the host, or the device.

Instances

Eq AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

(==) :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> Bool

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

Ord AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

compare :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> Ordering

(<) :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> Bool

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

(>) :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> Bool

(>=) :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> Bool

max :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR

min :: AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR -> AccelerationStructureBuildTypeKHR

Read AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS AccelerationStructureBuildTypeKHR

readList :: ReadS [AccelerationStructureBuildTypeKHR]

readPrec :: ReadPrec AccelerationStructureBuildTypeKHR

readListPrec :: ReadPrec [AccelerationStructureBuildTypeKHR]

Show AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> AccelerationStructureBuildTypeKHR -> ShowS

show :: AccelerationStructureBuildTypeKHR -> String

showList :: [AccelerationStructureBuildTypeKHR] -> ShowS

Storable AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: AccelerationStructureBuildTypeKHR -> Int

alignment :: AccelerationStructureBuildTypeKHR -> Int

peekElemOff :: Ptr AccelerationStructureBuildTypeKHR -> Int -> IO AccelerationStructureBuildTypeKHR

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

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

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

peek :: Ptr AccelerationStructureBuildTypeKHR -> IO AccelerationStructureBuildTypeKHR

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

Zero AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: AccelerationStructureBuildTypeKHR

newtype RayTracingShaderGroupTypeKHR

VkRayTracingShaderGroupTypeKHR - Shader group types

Description

Note

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

See Also

RayTracingShaderGroupCreateInfoKHR, RayTracingShaderGroupCreateInfoNV

Constructors

RayTracingShaderGroupTypeKHR Int32

Bundled Patterns

pattern RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_KHR :: RayTracingShaderGroupTypeKHR

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

pattern RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR :: RayTracingShaderGroupTypeKHR

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

pattern RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR :: RayTracingShaderGroupTypeKHR

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

Instances

Eq RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

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

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

Ord RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

compare :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> Ordering

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

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

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

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

max :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR

min :: RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR -> RayTracingShaderGroupTypeKHR

Read RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

readsPrec :: Int -> ReadS RayTracingShaderGroupTypeKHR

readList :: ReadS [RayTracingShaderGroupTypeKHR]

readPrec :: ReadPrec RayTracingShaderGroupTypeKHR

readListPrec :: ReadPrec [RayTracingShaderGroupTypeKHR]

Show RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

showsPrec :: Int -> RayTracingShaderGroupTypeKHR -> ShowS

show :: RayTracingShaderGroupTypeKHR -> String

showList :: [RayTracingShaderGroupTypeKHR] -> ShowS

Storable RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

sizeOf :: RayTracingShaderGroupTypeKHR -> Int

alignment :: RayTracingShaderGroupTypeKHR -> Int

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

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

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

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

peek :: Ptr RayTracingShaderGroupTypeKHR -> IO RayTracingShaderGroupTypeKHR

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

Zero RayTracingShaderGroupTypeKHR

Defined in Vulkan.Extensions.VK_KHR_ray_tracing

Methods

zero :: RayTracingShaderGroupTypeKHR

type KHR_RAY_TRACING_SPEC_VERSION = 8

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

type KHR_RAY_TRACING_EXTENSION_NAME = "VK_KHR_ray_tracing"

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

newtype AccelerationStructureKHR

VkAccelerationStructureKHR - Opaque handle to an acceleration structure object

See Also

AccelerationStructureBuildGeometryInfoKHR, AccelerationStructureDeviceAddressInfoKHR, AccelerationStructureMemoryRequirementsInfoKHR, BindAccelerationStructureMemoryInfoKHR, CopyAccelerationStructureInfoKHR, CopyAccelerationStructureToMemoryInfoKHR, CopyMemoryToAccelerationStructureInfoKHR, WriteDescriptorSetAccelerationStructureKHR, cmdBuildAccelerationStructureNV, cmdCopyAccelerationStructureNV, cmdWriteAccelerationStructuresPropertiesKHR, cmdWriteAccelerationStructuresPropertiesNV, createAccelerationStructureKHR, destroyAccelerationStructureKHR, destroyAccelerationStructureNV, getAccelerationStructureHandleNV, writeAccelerationStructuresPropertiesKHR

Constructors

AccelerationStructureKHR Word64

Instances

Eq AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: AccelerationStructureKHR -> AccelerationStructureKHR -> Bool

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

Ord AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: AccelerationStructureKHR -> AccelerationStructureKHR -> Ordering

(<) :: AccelerationStructureKHR -> AccelerationStructureKHR -> Bool

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

(>) :: AccelerationStructureKHR -> AccelerationStructureKHR -> Bool

(>=) :: AccelerationStructureKHR -> AccelerationStructureKHR -> Bool

max :: AccelerationStructureKHR -> AccelerationStructureKHR -> AccelerationStructureKHR

min :: AccelerationStructureKHR -> AccelerationStructureKHR -> AccelerationStructureKHR

Show AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> AccelerationStructureKHR -> ShowS

show :: AccelerationStructureKHR -> String

showList :: [AccelerationStructureKHR] -> ShowS

Storable AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: AccelerationStructureKHR -> Int

alignment :: AccelerationStructureKHR -> Int

peekElemOff :: Ptr AccelerationStructureKHR -> Int -> IO AccelerationStructureKHR

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

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

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

peek :: Ptr AccelerationStructureKHR -> IO AccelerationStructureKHR

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

Zero AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: AccelerationStructureKHR

HasObjectType AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: AccelerationStructureKHR -> (ObjectType, Word64)

IsHandle AccelerationStructureKHR

Defined in Vulkan.Extensions.Handles

data PipelineLibraryCreateInfoKHR

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

Valid Usage

• Each element of pLibraries must have been created with PIPELINE_CREATE_LIBRARY_BIT_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR

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

See Also

Pipeline, RayTracingPipelineCreateInfoKHR, StructureType

Constructors

PipelineLibraryCreateInfoKHR

Fields

• libraries :: Vector Pipeline

  pLibraries is an array of pipeline libraries to use when creating a pipeline.

Instances

Show PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

showsPrec :: Int -> PipelineLibraryCreateInfoKHR -> ShowS

show :: PipelineLibraryCreateInfoKHR -> String

showList :: [PipelineLibraryCreateInfoKHR] -> ShowS

Generic PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Associated Types

type Rep PipelineLibraryCreateInfoKHR :: Type -> Type

Methods

from :: PipelineLibraryCreateInfoKHR -> Rep PipelineLibraryCreateInfoKHR x

to :: Rep PipelineLibraryCreateInfoKHR x -> PipelineLibraryCreateInfoKHR

FromCStruct PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

peekCStruct :: Ptr PipelineLibraryCreateInfoKHR -> IO PipelineLibraryCreateInfoKHR

ToCStruct PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

Methods

zero :: PipelineLibraryCreateInfoKHR

type Rep PipelineLibraryCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_library

type Rep PipelineLibraryCreateInfoKHR = D1 ('MetaData "PipelineLibraryCreateInfoKHR" "Vulkan.Extensions.VK_KHR_pipeline_library" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "PipelineLibraryCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "libraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector 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

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_SAMPLER_YCBCR_CONVERSION_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR_EXT :: DebugReportObjectTypeEXT

pattern DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_EXT :: DebugReportObjectTypeEXT

Instances

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

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

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

Zero DebugReportObjectTypeEXT

Defined in Vulkan.Extensions.VK_EXT_debug_report

Methods

zero :: DebugReportObjectTypeEXT

type SHADER_UNUSED_KHR = 4294967295

pattern SHADER_UNUSED_KHR :: Word32