Vulkan.Extensions.VK_EXT_opacity_micromap

Name

VK_EXT_opacity_micromap - device extension

VK_EXT_opacity_micromap

Name String

VK_EXT_opacity_micromap

Extension Type

Device extension

Registered Extension Number

397

Revision

2

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_acceleration_structure to be enabled for any device-level functionality
• Requires VK_KHR_synchronization2 to be enabled for any device-level functionality

Contact

• Christoph Kubisch @pixeljetstream%0A*Here describe the issue or question you have about the VK_EXT_opacity_micromap extension*
• Eric Werness

Other Extension Metadata

Last Modified Date

2022-08-24

Interactions and External Dependencies

• This extension requires SPV_EXT_opacity_micromap
• This extension provides API support for GLSL_EXT_opacity_micromap

Contributors

• Christoph Kubisch, NVIDIA
• Eric Werness, NVIDIA
• Josh Barczak, Intel
• Stu Smith, AMD

Description

When adding adding transparency to a ray traced scene, an application can choose between further tessellating the geometry or using an any hit shader to allow the ray through specific parts of the geometry. These options have the downside of either significantly increasing memory consumption or adding runtime overhead to run shader code in the middle of traversal, respectively.

This extension adds the ability to add an opacity micromap to geometry when building an acceleration structure. The opacity micromap compactly encodes opacity information which can be read by the implementation to mark parts of triangles as opaque or transparent. The format is externally visible to allow the application to compress its internal geometry and surface representations into the compressed format ahead of time. The compressed format subdivides each triangle into a set of subtriangles, each of which can be assigned either two or four opacity values. These opacity values can control if a ray hitting that subtriangle is treated as an opaque hit, complete miss, or possible hit, depending on the controls described in Ray Opacity Micromap.

This extension provides:

• a MicromapEXT structure to store the micromap,
• functions similar to acceleration structure build functions to build the opacity micromap array, and
• a structure to extend AccelerationStructureGeometryTrianglesDataKHR to attach a micromap to the geometry of the acceleration structure.

New Object Types

• MicromapEXT

New Commands

• buildMicromapsEXT

• cmdBuildMicromapsEXT
• cmdCopyMemoryToMicromapEXT
• cmdCopyMicromapEXT
• cmdCopyMicromapToMemoryEXT
• cmdWriteMicromapsPropertiesEXT
• copyMemoryToMicromapEXT
• copyMicromapEXT
• copyMicromapToMemoryEXT
• createMicromapEXT
• destroyMicromapEXT
• getDeviceMicromapCompatibilityEXT
• getMicromapBuildSizesEXT
• writeMicromapsPropertiesEXT

New Structures

• CopyMemoryToMicromapInfoEXT

• CopyMicromapInfoEXT
• CopyMicromapToMemoryInfoEXT
• MicromapBuildInfoEXT
• MicromapBuildSizesInfoEXT
• MicromapCreateInfoEXT
• MicromapTriangleEXT
• MicromapUsageEXT
• MicromapVersionInfoEXT

• Extending AccelerationStructureGeometryTrianglesDataKHR:

  • AccelerationStructureTrianglesOpacityMicromapEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceOpacityMicromapFeaturesEXT

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceOpacityMicromapPropertiesEXT

New Enums

• BuildMicromapFlagBitsEXT

• BuildMicromapModeEXT
• CopyMicromapModeEXT
• MicromapCreateFlagBitsEXT
• MicromapTypeEXT
• OpacityMicromapFormatEXT
• OpacityMicromapSpecialIndexEXT

New Bitmasks

• BuildMicromapFlagsEXT

• MicromapCreateFlagsEXT

New Enum Constants

• EXT_OPACITY_MICROMAP_EXTENSION_NAME

• EXT_OPACITY_MICROMAP_SPEC_VERSION

• Extending AccessFlagBits2:

  • ACCESS_2_MICROMAP_READ_BIT_EXT
  • ACCESS_2_MICROMAP_WRITE_BIT_EXT

• Extending BufferUsageFlagBits:

  • BUFFER_USAGE_MICROMAP_BUILD_INPUT_READ_ONLY_BIT_EXT
  • BUFFER_USAGE_MICROMAP_STORAGE_BIT_EXT

• Extending BuildAccelerationStructureFlagBitsKHR:

  • BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_EXT
  • BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_EXT
  • BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_EXT

• Extending GeometryInstanceFlagBitsKHR:

  • GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_EXT
  • GEOMETRY_INSTANCE_FORCE_OPACITY_MICROMAP_2_STATE_EXT

• Extending ObjectType:

  • OBJECT_TYPE_MICROMAP_EXT

• Extending PipelineCreateFlagBits:

  • PIPELINE_CREATE_RAY_TRACING_OPACITY_MICROMAP_BIT_EXT

• Extending PipelineStageFlagBits2:

  • PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT

• Extending QueryType:

  • QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT
  • QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_ACCELERATION_STRUCTURE_TRIANGLES_OPACITY_MICROMAP_EXT
  • STRUCTURE_TYPE_COPY_MEMORY_TO_MICROMAP_INFO_EXT
  • STRUCTURE_TYPE_COPY_MICROMAP_INFO_EXT
  • STRUCTURE_TYPE_COPY_MICROMAP_TO_MEMORY_INFO_EXT
  • STRUCTURE_TYPE_MICROMAP_BUILD_INFO_EXT
  • STRUCTURE_TYPE_MICROMAP_BUILD_SIZES_INFO_EXT
  • STRUCTURE_TYPE_MICROMAP_CREATE_INFO_EXT
  • STRUCTURE_TYPE_MICROMAP_VERSION_INFO_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_OPACITY_MICROMAP_FEATURES_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_OPACITY_MICROMAP_PROPERTIES_EXT

Reference code

uint32_t BarycentricsToSpaceFillingCurveIndex(float u, float v, uint32_t level)
{
    u = clamp(u, 0.0f, 1.0f);
    v = clamp(v, 0.0f, 1.0f);

    uint32_t iu, iv, iw;

    // Quantize barycentric coordinates
    float fu = u * (1u << level);
    float fv = v * (1u << level);

    iu = (uint32_t)fu;
    iv = (uint32_t)fv;

    float uf = fu - float(iu);
    float vf = fv - float(iv);

    if (iu >= (1u << level)) iu = (1u << level) - 1u;
    if (iv >= (1u << level)) iv = (1u << level) - 1u;

    uint32_t iuv = iu + iv;

    if (iuv >= (1u << level))
        iu -= iuv - (1u << level) + 1u;

    iw = ~(iu + iv);

    if (uf + vf >= 1.0f && iuv < (1u link:https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html# level) - 1u) --iw;

    uint32_t b0 = ~(iu ^ iw);
    b0 &= ((1u << level) - 1u);
    uint32_t t = (iu ^ iv) & b0;

    uint32_t f = t;
    f ^= f [^] 1u;
    f ^= f >> 2u;
    f ^= f >> 4u;
    f ^= f >> 8u;
    uint32_t b1 = ((f ^ iu) & ~b0) | t;

    // Interleave bits
    b0 = (b0 | (b0 << 8u)) & 0x00ff00ffu;
    b0 = (b0 | (b0 << 4u)) & 0x0f0f0f0fu;
    b0 = (b0 | (b0 << 2u)) & 0x33333333u;
    b0 = (b0 | (b0 << 1u)) & 0x55555555u;
    b1 = (b1 | (b1 << 8u)) & 0x00ff00ffu;
    b1 = (b1 | (b1 << 4u)) & 0x0f0f0f0fu;
    b1 = (b1 | (b1 << 2u)) & 0x33333333u;
    b1 = (b1 | (b1 << 1u)) & 0x55555555u;

    return b0 | (b1 << 1u);
}

Issues

1. Is the build actually similar to an acceleration structure build?

• Resolved: The build should be much lighter-weight than an acceleration structure build, but the infrastructure is similar enough that it makes sense to keep the concepts compatible.

1. Why does VkMicromapUsageEXT not have type/pNext?

• Resolved: There can be a very large number of these structures, so doubling the size of these can be significant memory consumption. Also, an application may be loading these directly from a file which is more compatible with it being a flat structure. The including structures are extensible and are probably a more suitable place to add extensibility.

1. Why is there a SPIR-V extension?

• Resolved: There is a ray flag. To be consistent with how the existing ray tracing extensions work that ray flag needs its own extension.

1. Should there be indirect micromap build?

• Resolved: Not for now. There is more in-depth usage metadata required and it seems less likely that something like a GPU culling system would need to change the counts for a micromap.

1. Should micromaps have a micromap device address?

• Resolved: There is no need right now (can just use the handle) but that is a bit different from acceleration structures, though the two are not completely parallel in their usage.

1. Why are the alignment requirements defined as a mix of hardcoded values and caps?

• Resolved: This is most parallel with the definition of VK_KHR_acceleration_structure and maintaining commonality makes it easier for applications to share memory.

Version History

• Revision 2, 2022-06-22 (Eric Werness)

  • EXTify and clean up for discussion

• Revision 1, 2022-01-01 (Eric Werness)

  • Initial revision

See Also

AccelerationStructureTrianglesOpacityMicromapEXT, BuildMicromapFlagBitsEXT, BuildMicromapFlagsEXT, BuildMicromapModeEXT, CopyMemoryToMicromapInfoEXT, CopyMicromapInfoEXT, CopyMicromapModeEXT, CopyMicromapToMemoryInfoEXT, MicromapBuildInfoEXT, MicromapBuildSizesInfoEXT, MicromapCreateFlagBitsEXT, MicromapCreateFlagsEXT, MicromapCreateInfoEXT, MicromapEXT, MicromapTriangleEXT, MicromapTypeEXT, MicromapUsageEXT, MicromapVersionInfoEXT, OpacityMicromapFormatEXT, OpacityMicromapSpecialIndexEXT, PhysicalDeviceOpacityMicromapFeaturesEXT, PhysicalDeviceOpacityMicromapPropertiesEXT, buildMicromapsEXT, cmdBuildMicromapsEXT, cmdCopyMemoryToMicromapEXT, cmdCopyMicromapEXT, cmdCopyMicromapToMemoryEXT, cmdWriteMicromapsPropertiesEXT, copyMemoryToMicromapEXT, copyMicromapEXT, copyMicromapToMemoryEXT, createMicromapEXT, destroyMicromapEXT, getDeviceMicromapCompatibilityEXT, getMicromapBuildSizesEXT, writeMicromapsPropertiesEXT

Document Notes

For more information, see the Vulkan Specification

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

Documentation

createMicromapEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that creates the acceleration structure object.

-> MicromapCreateInfoEXT

pCreateInfo is a pointer to a MicromapCreateInfoEXT structure containing parameters affecting creation of the micromap.

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

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

-> io MicromapEXT

vkCreateMicromapEXT - Create a new micromap object

Description

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

Populating the data in the object after allocating and binding memory is done with commands such as cmdBuildMicromapsEXT, buildMicromapsEXT, cmdCopyMicromapEXT, and copyMicromapEXT.

The input buffers passed to micromap build commands will be referenced by the implementation for the duration of the command. Micromaps 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 a subsequent acceleration structure build using the micromap or traversal of that acceleration structure.

Valid Usage

• The micromap feature must be enabled

• If MicromapCreateInfoEXT::deviceAddress is not zero, the micromapCaptureReplay 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 MicromapCreateInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pMicromap must be a valid pointer to a MicromapEXT handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

See Also

VK_EXT_opacity_micromap, AllocationCallbacks, Device, MicromapCreateInfoEXT, MicromapEXT

withMicromapEXT :: forall io r. MonadIO io => Device -> MicromapCreateInfoEXT -> Maybe AllocationCallbacks -> (io MicromapEXT -> (MicromapEXT -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createMicromapEXT and destroyMicromapEXT

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

cmdBuildMicromapsEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("infos" ::: Vector MicromapBuildInfoEXT)

pInfos is a pointer to an array of infoCount MicromapBuildInfoEXT structures defining the data used to build each micromap.

-> io ()

vkCmdBuildMicromapsEXT - Build a micromap

Description

The cmdBuildMicromapsEXT command provides the ability to initiate multiple micromaps builds, however there is no ordering or synchronization implied between any of the individual micromap builds.

Note

This means that there cannot be any memory aliasing between any micromap memories or scratch memories being used by any of the builds.

Accesses to the micromap scratch buffers as identified by the MicromapBuildInfoEXT::scratchData buffer device addresses must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_2_MICROMAP_READ_BIT_EXT or ACCESS_2_MICROMAP_WRITE_BIT_EXT. Similarly for accesses to MicromapBuildInfoEXT::dstMicromap.

Accesses to other input buffers as identified by any used values of MicromapBuildInfoEXT::data or MicromapBuildInfoEXT::triangleArray must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_SHADER_READ_BIT.

Valid Usage

• For each pInfos[i], dstMicromap must have been created with a value of MicromapCreateInfoEXT::size greater than or equal to the memory size required by the build operation, as returned by getMicromapBuildSizesEXT with pBuildInfo = pInfos[i]

• The mode member of each element of pInfos must be a valid BuildMicromapModeEXT value
• The dstMicromap member of any element of pInfos must be a valid MicromapEXT handle
• For each element of pInfos its type member must match the value of MicromapCreateInfoEXT::type when its dstMicromap was created
• The range of memory backing the dstMicromap member of any element of pInfos that is accessed by this command must not overlap the memory backing the dstMicromap member of any other element of pInfos, which is accessed by this command
• The range of memory backing the dstMicromap member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any element of pInfos (including the same element), which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any other element of pInfos, which is accessed by this command
• For each element of pInfos, the buffer used to create its dstMicromap member must be bound to device memory
• If pInfos[i].mode is BUILD_MICROMAP_MODE_BUILD_EXT, all addresses between pInfos[i].scratchData.deviceAddress and pInfos[i].scratchData.deviceAddress + N - 1 must be in the buffer device address range of the same buffer, where N is given by the buildScratchSize member of the MicromapBuildSizesInfoEXT structure returned from a call to getMicromapBuildSizesEXT with an identical MicromapBuildInfoEXT structure and primitive count
• The buffers from which the buffer device addresses for all of the data and triangleArray members of all pInfos[i] are queried must have been created with the BUFFER_USAGE_MICROMAP_BUILD_INPUT_READ_ONLY_BIT_EXT usage flag
• For each element of pInfos[i] the buffer from which the buffer device address pInfos[i].scratchData.deviceAddress is queried must have been created with BUFFER_USAGE_STORAGE_BUFFER_BIT usage flag
• For each element of pInfos, its scratchData.deviceAddress, data.deviceAddress, and triangleArray.deviceAddress members must be valid device addresses obtained from getBufferDeviceAddress
• For each element of pInfos, if scratchData.deviceAddress, data.deviceAddress, or triangleArray.deviceAddress is the address of a non-sparse buffer then it must be bound completely and contiguously to a single DeviceMemory object
• For each element of pInfos, its scratchData.deviceAddress member must be a multiple of PhysicalDeviceAccelerationStructurePropertiesKHR::minAccelerationStructureScratchOffsetAlignment
• For each element of pInfos, its triangleArray.deviceAddress and data.deviceAddress members must be a multiple of 256

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfos must be a valid pointer to an array of infoCount valid MicromapBuildInfoEXT 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
• This command must only be called outside of a video coding scope
• 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	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	Compute	Action

See Also

VK_EXT_opacity_micromap, CommandBuffer, MicromapBuildInfoEXT

buildMicromapsEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the Device for which the micromaps are being built.

-> DeferredOperationKHR

deferredOperation is an optional DeferredOperationKHR to request deferral for this command.

-> ("infos" ::: Vector MicromapBuildInfoEXT)

pInfos is a pointer to an array of infoCount MicromapBuildInfoEXT structures defining the geometry used to build each micromap.

-> io Result

vkBuildMicromapsEXT - Build a micromap on the host

Description

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

The buildMicromapsEXT command provides the ability to initiate multiple micromaps builds, however there is no ordering or synchronization implied between any of the individual micromap builds.

Note

This means that there cannot be any memory aliasing between any micromap memories or scratch memories being used by any of the builds.

Valid Usage

• For each pInfos[i], dstMicromap must have been created with a value of MicromapCreateInfoEXT::size greater than or equal to the memory size required by the build operation, as returned by getMicromapBuildSizesEXT with pBuildInfo = pInfos[i]

• The mode member of each element of pInfos must be a valid BuildMicromapModeEXT value
• The dstMicromap member of any element of pInfos must be a valid MicromapEXT handle
• For each element of pInfos its type member must match the value of MicromapCreateInfoEXT::type when its dstMicromap was created
• The range of memory backing the dstMicromap member of any element of pInfos that is accessed by this command must not overlap the memory backing the dstMicromap member of any other element of pInfos, which is accessed by this command
• The range of memory backing the dstMicromap member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any element of pInfos (including the same element), which is accessed by this command
• The range of memory backing the scratchData member of any element of pInfos that is accessed by this command must not overlap the memory backing the scratchData member of any other element of pInfos, which is accessed by this command
• For each element of pInfos, the buffer used to create its dstMicromap member must be bound to host-visible device memory
• For each element of pInfos, all referenced addresses of pInfos[i].data.hostAddress must be valid host memory
• For each element of pInfos, all referenced addresses of pInfos[i].triangleArray.hostAddress must be valid host memory
• The ::micromapHostCommands feature must be enabled
• If pInfos[i].mode is BUILD_MICROMAP_MODE_BUILD_EXT, all addresses between pInfos[i].scratchData.hostAddress and pInfos[i].scratchData.hostAddress + N - 1 must be valid host memory, where N is given by the buildScratchSize member of the MicromapBuildSizesInfoEXT structure returned from a call to getMicromapBuildSizesEXT with an identical MicromapBuildInfoEXT structure and primitive count
• For each element of pInfos, the buffer used to create its dstMicromap member must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid Device handle

• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid DeferredOperationKHR handle
• pInfos must be a valid pointer to an array of infoCount valid MicromapBuildInfoEXT structures
• infoCount must be greater than 0
• If deferredOperation 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

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_EXT_opacity_micromap, DeferredOperationKHR, Device, MicromapBuildInfoEXT

destroyMicromapEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the micromap.

-> MicromapEXT

micromap is the micromap to destroy.

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

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

-> io ()

vkDestroyMicromapEXT - Destroy a micromap object

Valid Usage

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

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

Valid Usage (Implicit)

• device must be a valid Device handle

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

Host Synchronization

• Host access to micromap must be externally synchronized

See Also

VK_EXT_opacity_micromap, AllocationCallbacks, Device, MicromapEXT

cmdCopyMicromapEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> CopyMicromapInfoEXT

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

-> io ()

vkCmdCopyMicromapEXT - Copy a micromap

Description

This command copies the pInfo->src micromap to the pInfo->dst micromap in the manner specified by pInfo->mode.

Accesses to pInfo->src and pInfo->dst must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_2_MICROMAP_READ_BIT_EXT or ACCESS_2_MICROMAP_WRITE_BIT_EXT as appropriate.

Valid Usage

• The buffer used to create pInfo->src must be bound to device memory

• The buffer used to create pInfo->dst must be bound to device memory

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfo must be a valid pointer to a valid CopyMicromapInfoEXT 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
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

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

See Also

VK_EXT_opacity_micromap, CommandBuffer, CopyMicromapInfoEXT

copyMicromapEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device which owns the micromaps.

-> DeferredOperationKHR

deferredOperation is an optional DeferredOperationKHR to request deferral for this command.

-> CopyMicromapInfoEXT

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

-> io Result

vkCopyMicromapEXT - Copy a micromap on the host

Description

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

Valid Usage

• If deferredOperation is not NULL_HANDLE, it must be a valid DeferredOperationKHR object

• Any previous deferred operation that was associated with deferredOperation must be complete
• The buffer used to create pInfo->src must be bound to host-visible device memory
• The buffer used to create pInfo->dst must be bound to host-visible device memory
• The ::micromapHostCommands feature must be enabled
• The buffer used to create pInfo->src must be bound to memory that was not allocated with multiple instances
• The buffer used to create pInfo->dst must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid Device handle

• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid DeferredOperationKHR handle
• pInfo must be a valid pointer to a valid CopyMicromapInfoEXT structure
• If deferredOperation 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

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_EXT_opacity_micromap, CopyMicromapInfoEXT, DeferredOperationKHR, Device

cmdCopyMicromapToMemoryEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> CopyMicromapToMemoryInfoEXT

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

-> io ()

vkCmdCopyMicromapToMemoryEXT - Copy a micromap to device memory

Description

Accesses to pInfo->src must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_2_MICROMAP_READ_BIT_EXT. Accesses to the buffer indicated by pInfo->dst.deviceAddress must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_TRANSFER_WRITE_BIT.

This command produces the same results as copyMicromapToMemoryEXT, 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 cmdCopyMemoryToMicromapEXT or copyMemoryToMicromapEXT.

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 getDeviceMicromapCompatibilityEXT The serialized data is written to the buffer (or read from the buffer) according to the host endianness.

Valid Usage

• pInfo->dst.deviceAddress must be a valid device address for a buffer bound to device memory

• pInfo->dst.deviceAddress must be aligned to 256 bytes
• If the buffer pointed to by pInfo->dst.deviceAddress is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer used to create pInfo->src must be bound to device memory

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfo must be a valid pointer to a valid CopyMicromapToMemoryInfoEXT 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
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

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

See Also

VK_EXT_opacity_micromap, CommandBuffer, CopyMicromapToMemoryInfoEXT

copyMicromapToMemoryEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device which owns pInfo->src.

-> DeferredOperationKHR

deferredOperation is an optional DeferredOperationKHR to request deferral for this command.

-> CopyMicromapToMemoryInfoEXT

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

-> io Result

vkCopyMicromapToMemoryEXT - Serialize a micromap on the host

Description

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

This command produces the same results as cmdCopyMicromapToMemoryEXT, 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 cmdCopyMemoryToMicromapEXT or copyMemoryToMicromapEXT.

Valid Usage

• If deferredOperation is not NULL_HANDLE, it must be a valid DeferredOperationKHR object

• Any previous deferred operation that was associated with deferredOperation must be complete
• The buffer used to create pInfo->src must be bound to host-visible device memory
• pInfo->dst.hostAddress must be a valid host pointer
• pInfo->dst.hostAddress must be aligned to 16 bytes
• The ::micromapHostCommands feature must be enabled
• The buffer used to create pInfo->src must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid Device handle

• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid DeferredOperationKHR handle
• pInfo must be a valid pointer to a valid CopyMicromapToMemoryInfoEXT structure
• If deferredOperation 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

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_EXT_opacity_micromap, CopyMicromapToMemoryInfoEXT, DeferredOperationKHR, Device

cmdCopyMemoryToMicromapEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> CopyMemoryToMicromapInfoEXT

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

-> io ()

vkCmdCopyMemoryToMicromapEXT - Copy device memory to a micromap

Description

Accesses to pInfo->dst must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_2_MICROMAP_READ_BIT_EXT. Accesses to the buffer indicated by pInfo->src.deviceAddress must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_TRANSFER_READ_BIT.

This command can accept micromaps produced by either cmdCopyMicromapToMemoryEXT or copyMicromapToMemoryEXT.

Valid Usage

• pInfo->src.deviceAddress must be a valid device address for a buffer bound to device memory

• pInfo->src.deviceAddress must be aligned to 256 bytes
• If the buffer pointed to by pInfo->src.deviceAddress is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• The buffer used to create pInfo->dst must be bound to device memory

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInfo must be a valid pointer to a valid CopyMemoryToMicromapInfoEXT 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
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

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

See Also

VK_EXT_opacity_micromap, CommandBuffer, CopyMemoryToMicromapInfoEXT

copyMemoryToMicromapEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device which owns pInfo->dst.

-> DeferredOperationKHR

deferredOperation is an optional DeferredOperationKHR to request deferral for this command.

-> CopyMemoryToMicromapInfoEXT

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

-> io Result

vkCopyMemoryToMicromapEXT - Deserialize a micromap on the host

Description

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

This command can accept micromaps produced by either cmdCopyMicromapToMemoryEXT or copyMicromapToMemoryEXT.

Valid Usage

• If deferredOperation is not NULL_HANDLE, it must be a valid DeferredOperationKHR object

• Any previous deferred operation that was associated with deferredOperation must be complete
• pInfo->src.hostAddress must be a valid host pointer
• pInfo->src.hostAddress must be aligned to 16 bytes
• The buffer used to create pInfo->dst must be bound to host-visible device memory
• The ::micromapHostCommands feature must be enabled
• The buffer used to create pInfo->dst must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid Device handle

• If deferredOperation is not NULL_HANDLE, deferredOperation must be a valid DeferredOperationKHR handle
• pInfo must be a valid pointer to a valid CopyMemoryToMicromapInfoEXT structure
• If deferredOperation 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

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_EXT_opacity_micromap, CopyMemoryToMicromapInfoEXT, DeferredOperationKHR, Device

cmdWriteMicromapsPropertiesEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("micromaps" ::: Vector MicromapEXT)

pMicromaps is a pointer to an array of existing previously built micromaps.

-> 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 micromapCount number of results.

-> io ()

vkCmdWriteMicromapsPropertiesEXT - Write micromap result parameters to query results.

Description

Accesses to any of the micromaps listed in pMicromaps must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_2_MICROMAP_READ_BIT_EXT.

• If queryType is QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT, then the value written out is the number of bytes required by a serialized micromap.
• If queryType is QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT, then the value written out is the number of bytes required by a compacted micromap.

Valid Usage

• queryPool must have been created with a queryType matching queryType

• The queries identified by queryPool and firstQuery must be unavailable
• The buffer used to create each micromap in pMicrmaps must be bound to device memory
• The sum of query plus micromapCount must be less than or equal to the number of queries in queryPool
• All micromaps in pMicromaps must have been constructed prior to the execution of this command
• All micromaps in pMicromaps must have been constructed with BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT if queryType is QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT
• queryType must be QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT or QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

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

See Also

VK_EXT_opacity_micromap, CommandBuffer, MicromapEXT, QueryPool, QueryType

writeMicromapsPropertiesEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device which owns the micromaps in pMicromaps.

-> ("micromaps" ::: Vector MicromapEXT)

pMicromaps is a pointer to an array of existing previously built micromaps.

-> QueryType

queryType is a QueryType value specifying the property to be queried.

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

-> ("stride" ::: Word64)

stride is the stride in bytes between results for individual queries within pData.

-> io ()

vkWriteMicromapsPropertiesEXT - Query micromap meta-data on the host

Description

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

Valid Usage

• All micromaps in pMicromaps must have been constructed prior to the execution of this command

• All micromaps in pMicromaps must have been constructed with BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT if queryType is QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT
• queryType must be QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT or QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT
• If queryType is QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT, then stride must be a multiple of the size of DeviceSize
• If queryType is QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT, then pData must point to a DeviceSize
• If queryType is
• dataSize must be greater than or equal to micromapCount*stride
• The buffer used to create each micromap in pMicromaps must be bound to host-visible device memory
• The ::micromapHostCommands feature must be enabled
• The buffer used to create each micromap in pMicromaps must be bound to memory that was not allocated with multiple instances

Valid Usage (Implicit)

• device must be a valid Device handle

• pMicromaps must be a valid pointer to an array of micromapCount valid MicromapEXT handles
• queryType must be a valid QueryType value
• pData must be a valid pointer to an array of dataSize bytes
• micromapCount must be greater than 0
• dataSize must be greater than 0
• Each element of pMicromaps must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_EXT_opacity_micromap, Device, MicromapEXT, QueryType

getDeviceMicromapCompatibilityEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device to check the version against.

-> MicromapVersionInfoEXT

pVersionInfo is a pointer to a MicromapVersionInfoEXT structure specifying version information to check against the device.

-> io AccelerationStructureCompatibilityKHR

vkGetDeviceMicromapCompatibilityEXT - Check if a serialized micromap is compatible with the current device

Valid Usage

• The micromap feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pVersionInfo must be a valid pointer to a valid MicromapVersionInfoEXT structure
• pCompatibility must be a valid pointer to a AccelerationStructureCompatibilityKHR value

See Also

VK_EXT_opacity_micromap, AccelerationStructureCompatibilityKHR, Device, MicromapVersionInfoEXT

getMicromapBuildSizesEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that will be used for creating the micromap.

-> AccelerationStructureBuildTypeKHR

buildType defines whether host or device operations (or both) are being queried for.

-> MicromapBuildInfoEXT

pBuildInfo is a pointer to a MicromapBuildInfoEXT structure describing parameters of a build operation.

-> io ("sizeInfo" ::: MicromapBuildSizesInfoEXT)

vkGetMicromapBuildSizesEXT - Retrieve the required size for a micromap

Description

The dstMicromap and mode members of pBuildInfo are ignored. Any DeviceOrHostAddressKHR members of pBuildInfo are ignored by this command.

A micromap created with the micromapSize returned by this command supports any build with a MicromapBuildInfoEXT structure subject to the following properties:

• The build command is a host build command, and buildType is ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR or ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR
• The build command is a device build command, and buildType is ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR or ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR

• For MicromapBuildInfoEXT:

  • Its type, and flags members are equal to pBuildInfo->type and pBuildInfo->flags, respectively.
  • The sum of usage information in either pUsageCounts or ppUsageCounts is equal to the sum of usage information in either pBuildInfo->pUsageCounts or pBuildInfo->ppUsageCounts.

Similarly, the buildScratchSize value will support any build command specifying the BUILD_MICROMAP_MODE_BUILD_EXT mode under the above conditions.

Valid Usage

• The micromap 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

• buildType must be a valid AccelerationStructureBuildTypeKHR value
• pBuildInfo must be a valid pointer to a valid MicromapBuildInfoEXT structure
• pSizeInfo must be a valid pointer to a MicromapBuildSizesInfoEXT structure

See Also

VK_EXT_opacity_micromap, AccelerationStructureBuildTypeKHR, Device, MicromapBuildInfoEXT, MicromapBuildSizesInfoEXT

data MicromapBuildInfoEXT

VkMicromapBuildInfoEXT - Structure specifying the data used to build a micromap

Description

Only one of pUsageCounts or ppUsageCounts can be a valid pointer, the other must be NULL. The elements of the non-NULL array describe the total counts used to build each micromap. Each element contains a count which is the number of micromap triangles of that format and subdivisionLevel contained in the micromap. Multiple elements with the same format and subdivisionLevel are allowed and the total count for that format and subdivisionLevel is the sum of the count for each element.

Each micromap triangle refers to one element in triangleArray which contains the format and subdivisionLevel for that particular triangle as well as a dataOffset in bytes which is the location relative to data where that triangle’s micromap data begins. The data at triangleArray is laid out as a 4 byte unsigned integer for the dataOffset followed by a 2 byte unsigned integer for the subdivision level then a 2 byte unsigned integer for the format. In practice, compilers compile MicromapTriangleEXT to match this pattern.

The data at data is packed as either one bit per element for OPACITY_MICROMAP_FORMAT_2_STATE_EXT or two bits per element for OPACITY_MICROMAP_FORMAT_4_STATE_EXT and is packed from LSB to MSB in each byte. The data at each index in those bytes is interpreted as discussed in Ray Opacity Micromap.

Valid Usage

• Only one of pUsageCounts or ppUsageCounts can be a valid pointer, the other must be NULL.

• If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT the format member of MicromapUsageEXT must be a valid value from OpacityMicromapFormatEXT
• If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT the format member of MicromapTriangleEXT must be a valid value from OpacityMicromapFormatEXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MICROMAP_BUILD_INFO_EXT

• pNext must be NULL
• type must be a valid MicromapTypeEXT value
• flags must be a valid combination of BuildMicromapFlagBitsEXT values
• If usageCountsCount is not 0, and pUsageCounts is not NULL, pUsageCounts must be a valid pointer to an array of usageCountsCount MicromapUsageEXT structures
• If usageCountsCount is not 0, and ppUsageCounts is not NULL, ppUsageCounts must be a valid pointer to an array of usageCountsCount valid pointers to MicromapUsageEXT structures

See Also

VK_EXT_opacity_micromap, BuildMicromapFlagsEXT, BuildMicromapModeEXT, DeviceOrHostAddressConstKHR, DeviceOrHostAddressKHR, DeviceSize, MicromapEXT, MicromapTypeEXT, MicromapUsageEXT, StructureType, buildMicromapsEXT, cmdBuildMicromapsEXT, getMicromapBuildSizesEXT

Constructors

MicromapBuildInfoEXT

Fields

• type' :: MicromapTypeEXT

  type is a MicromapTypeEXT value specifying the type of micromap being built.

• flags :: BuildMicromapFlagsEXT

  flags is a bitmask of BuildMicromapFlagBitsEXT specifying additional parameters of the micromap.

• mode :: BuildMicromapModeEXT

  mode is a BuildMicromapModeEXT value specifying the type of operation to perform.

• dstMicromap :: MicromapEXT

  dstMicromap is a pointer to the target micromap for the build.

• usageCountsCount :: Word32

  usageCountsCount specifies the number of usage counts structures that will be used to determine the size of this micromap.

• usageCounts :: Vector MicromapUsageEXT

  pUsageCounts is a pointer to an array of MicromapUsageEXT structures.

• data' :: DeviceOrHostAddressConstKHR

  data is the device or host address to memory which contains the data for the micromap.

• scratchData :: DeviceOrHostAddressKHR

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

• triangleArray :: DeviceOrHostAddressConstKHR

  triangleArray is the device or host address to memory containing the MicromapTriangleEXT data

• triangleArrayStride :: DeviceSize

  triangleArrayStride is the stride in bytes between each element of triangleArray

Instances

Show MicromapBuildInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapBuildInfoEXT -> ShowS

show :: MicromapBuildInfoEXT -> String

showList :: [MicromapBuildInfoEXT] -> ShowS

ToCStruct MicromapBuildInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr MicromapBuildInfoEXT -> MicromapBuildInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MicromapBuildInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MicromapBuildInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapBuildInfoEXT

data MicromapCreateInfoEXT

VkMicromapCreateInfoEXT - Structure specifying the parameters of a newly created micromap 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 micromap on the same implementation. The micromap must also be placed on an identically created buffer and at the same offset.

Applications should avoid creating micromaps with application-provided addresses and implementation-provided addresses in the same process, to reduce the likelihood of ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR errors.

Note

The expected usage for this is that a trace capture/replay tool will add the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT flag to all buffers that use BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT, and will add BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT to all buffers used as storage for a micromap where deviceAddress is not zero. This also means that the tool will need to add MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT to memory allocations to allow the flag to be set where the application may not have otherwise required it. During capture the tool will save the queried opaque device addresses in the trace. During replay, the buffers will be created specifying the original address so any address values stored in the trace data will remain valid.

Implementations are expected to separate such buffers in the GPU address space so normal allocations will avoid using these addresses. Apps/tools should avoid mixing app-provided and implementation-provided addresses for buffers created with BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT, to avoid address space allocation conflicts.

If the micromap will be the target of a build operation, the required size for a micromap can be queried with getMicromapBuildSizesEXT.

Valid Usage

• If deviceAddress is not zero, createFlags must include MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT

• If createFlags includes MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT, PhysicalDeviceOpacityMicromapFeaturesEXT::micromapCaptureReplay must be TRUE
• buffer must have been created with a usage value containing BUFFER_USAGE_MICROMAP_STORAGE_BIT_EXT
• buffer must not have been created with BUFFER_CREATE_SPARSE_RESIDENCY_BIT
• The sum of offset and size must be less than the size of buffer
• offset must be a multiple of 256 bytes

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MICROMAP_CREATE_INFO_EXT

• pNext must be NULL
• createFlags must be a valid combination of MicromapCreateFlagBitsEXT values
• buffer must be a valid Buffer handle
• type must be a valid MicromapTypeEXT value

See Also

VK_EXT_opacity_micromap, Buffer, DeviceAddress, DeviceSize, MicromapCreateFlagsEXT, MicromapTypeEXT, StructureType, createMicromapEXT

Constructors

MicromapCreateInfoEXT

Fields

• createFlags :: MicromapCreateFlagsEXT

  createFlags is a bitmask of MicromapCreateFlagBitsEXT specifying additional creation parameters of the micromap.

• buffer :: Buffer

  buffer is the buffer on which the micromap will be stored.

• offset :: DeviceSize

  offset is an offset in bytes from the base address of the buffer at which the micromap will be stored, and must be a multiple of 256.

• size :: DeviceSize

  size is the size required for the micromap.

• type' :: MicromapTypeEXT

  type is a MicromapTypeEXT value specifying the type of micromap that will be created.

• deviceAddress :: DeviceAddress

  deviceAddress is the device address requested for the micromap if the micromapCaptureReplay feature is being used.

Instances

Storable MicromapCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: MicromapCreateInfoEXT -> Int

alignment :: MicromapCreateInfoEXT -> Int

peekElemOff :: Ptr MicromapCreateInfoEXT -> Int -> IO MicromapCreateInfoEXT

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

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

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

peek :: Ptr MicromapCreateInfoEXT -> IO MicromapCreateInfoEXT

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

Show MicromapCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapCreateInfoEXT -> ShowS

show :: MicromapCreateInfoEXT -> String

showList :: [MicromapCreateInfoEXT] -> ShowS

Eq MicromapCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: MicromapCreateInfoEXT -> MicromapCreateInfoEXT -> Bool

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

FromCStruct MicromapCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr MicromapCreateInfoEXT -> IO MicromapCreateInfoEXT

ToCStruct MicromapCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr MicromapCreateInfoEXT -> MicromapCreateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MicromapCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MicromapCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapCreateInfoEXT

data MicromapVersionInfoEXT

VkMicromapVersionInfoEXT - Micromap version information

Description

Note

pVersionData is a pointer to an array of 2×UUID_SIZE uint8_t values instead of two UUID_SIZE arrays as the expected use case for this member is to be pointed at the header of a previously serialized micromap (via cmdCopyMicromapToMemoryEXT or copyMicromapToMemoryEXT) that is loaded in memory. Using arrays would necessitate extra memory copies of the UUIDs.

Valid Usage (Implicit)

See Also

VK_EXT_opacity_micromap, StructureType, getDeviceMicromapCompatibilityEXT

Constructors

MicromapVersionInfoEXT

Fields

• versionData :: ByteString

  pVersionData is a pointer to the version header of a micromap as defined in cmdCopyMicromapToMemoryEXT

  pVersionData must be a valid pointer to an array of \(2 \times \mathtt{VK\_UUID\_SIZE}\) uint8_t values

Instances

Show MicromapVersionInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapVersionInfoEXT -> ShowS

show :: MicromapVersionInfoEXT -> String

showList :: [MicromapVersionInfoEXT] -> ShowS

FromCStruct MicromapVersionInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr MicromapVersionInfoEXT -> IO MicromapVersionInfoEXT

ToCStruct MicromapVersionInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr MicromapVersionInfoEXT -> MicromapVersionInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MicromapVersionInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MicromapVersionInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapVersionInfoEXT

data CopyMicromapInfoEXT

VkCopyMicromapInfoEXT - Parameters for copying a micromap

Valid Usage

• mode must be COPY_MICROMAP_MODE_COMPACT_EXT or COPY_MICROMAP_MODE_CLONE_EXT

• The source acceleration structure src must have been constructed prior to the execution of this command
• If mode is COPY_MICROMAP_MODE_COMPACT_EXT, src must have been constructed with BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT in the build
• The buffer used to create src must be bound to device memory
• The buffer used to create dst must be bound to device memory

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MICROMAP_INFO_EXT

• pNext must be NULL
• src must be a valid MicromapEXT handle
• dst must be a valid MicromapEXT handle
• mode must be a valid CopyMicromapModeEXT value
• Both of dst, and src must have been created, allocated, or retrieved from the same Device

See Also

VK_EXT_opacity_micromap, CopyMicromapModeEXT, MicromapEXT, StructureType, cmdCopyMicromapEXT, copyMicromapEXT

Constructors

CopyMicromapInfoEXT

Fields

• src :: MicromapEXT

  src is the source micromap for the copy.

• dst :: MicromapEXT

  dst is the target micromap for the copy.

• mode :: CopyMicromapModeEXT

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

Instances

Storable CopyMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: CopyMicromapInfoEXT -> Int

alignment :: CopyMicromapInfoEXT -> Int

peekElemOff :: Ptr CopyMicromapInfoEXT -> Int -> IO CopyMicromapInfoEXT

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

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

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

peek :: Ptr CopyMicromapInfoEXT -> IO CopyMicromapInfoEXT

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

Show CopyMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> CopyMicromapInfoEXT -> ShowS

show :: CopyMicromapInfoEXT -> String

showList :: [CopyMicromapInfoEXT] -> ShowS

Eq CopyMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: CopyMicromapInfoEXT -> CopyMicromapInfoEXT -> Bool

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

FromCStruct CopyMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr CopyMicromapInfoEXT -> IO CopyMicromapInfoEXT

ToCStruct CopyMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr CopyMicromapInfoEXT -> CopyMicromapInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CopyMicromapInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: CopyMicromapInfoEXT

data CopyMicromapToMemoryInfoEXT

VkCopyMicromapToMemoryInfoEXT - Parameters for serializing a micromap

Valid Usage

• The source micromap src must have been constructed prior to the execution of this command

• The memory pointed to by dst must be at least as large as the serialization size of src, as reported by writeMicromapsPropertiesEXT or cmdWriteMicromapsPropertiesEXT with a query type of QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT
• mode must be COPY_MICROMAP_MODE_SERIALIZE_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MICROMAP_TO_MEMORY_INFO_EXT

• pNext must be NULL
• src must be a valid MicromapEXT handle
• mode must be a valid CopyMicromapModeEXT value

See Also

VK_EXT_opacity_micromap, CopyMicromapModeEXT, DeviceOrHostAddressKHR, MicromapEXT, StructureType, cmdCopyMicromapToMemoryEXT, copyMicromapToMemoryEXT

Constructors

CopyMicromapToMemoryInfoEXT

Fields

• src :: MicromapEXT

  src is the source micromap for the copy

• dst :: DeviceOrHostAddressKHR

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

• mode :: CopyMicromapModeEXT

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

Instances

Show CopyMicromapToMemoryInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> CopyMicromapToMemoryInfoEXT -> ShowS

show :: CopyMicromapToMemoryInfoEXT -> String

showList :: [CopyMicromapToMemoryInfoEXT] -> ShowS

ToCStruct CopyMicromapToMemoryInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr CopyMicromapToMemoryInfoEXT -> CopyMicromapToMemoryInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CopyMicromapToMemoryInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyMicromapToMemoryInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: CopyMicromapToMemoryInfoEXT

data CopyMemoryToMicromapInfoEXT

VkCopyMemoryToMicromapInfoEXT - Parameters for deserializing a micromap

Valid Usage

• The source memory pointed to by src must contain data previously serialized using cmdCopyMicromapToMemoryEXT

• mode must be COPY_MICROMAP_MODE_DESERIALIZE_EXT
• The data in src must have a format compatible with the destination physical device as returned by getDeviceMicromapCompatibilityEXT
• dst must have been created with a size greater than or equal to that used to serialize the data in src

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_MEMORY_TO_MICROMAP_INFO_EXT

• pNext must be NULL
• dst must be a valid MicromapEXT handle
• mode must be a valid CopyMicromapModeEXT value

See Also

VK_EXT_opacity_micromap, CopyMicromapModeEXT, DeviceOrHostAddressConstKHR, MicromapEXT, StructureType, cmdCopyMemoryToMicromapEXT, copyMemoryToMicromapEXT

Constructors

CopyMemoryToMicromapInfoEXT

Fields

• src :: DeviceOrHostAddressConstKHR

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

• dst :: MicromapEXT

  dst is the target micromap for the copy.

• mode :: CopyMicromapModeEXT

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

Instances

Show CopyMemoryToMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> CopyMemoryToMicromapInfoEXT -> ShowS

show :: CopyMemoryToMicromapInfoEXT -> String

showList :: [CopyMemoryToMicromapInfoEXT] -> ShowS

ToCStruct CopyMemoryToMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr CopyMemoryToMicromapInfoEXT -> CopyMemoryToMicromapInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CopyMemoryToMicromapInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyMemoryToMicromapInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: CopyMemoryToMicromapInfoEXT

data MicromapBuildSizesInfoEXT

VkMicromapBuildSizesInfoEXT - Structure specifying build sizes for a micromap

Valid Usage (Implicit)

See Also

VK_EXT_opacity_micromap, Bool32, DeviceSize, StructureType, getMicromapBuildSizesEXT

Constructors

MicromapBuildSizesInfoEXT

Fields

• micromapSize :: DeviceSize

  micromapSize is the size in bytes required in a MicromapEXT for a build or update operation.

• buildScratchSize :: DeviceSize

  buildScratchSize is the size in bytes required in a scratch buffer for a build operation.

• discardable :: Bool

  discardable indicates whether or not the micromap object may be destroyed after an acceleration structure build or update. A false value means that acceleration structures built with this micromap may contain references to the data contained therein, and the application must not destroy the micromap until ray traversal has concluded. A true value means that the information in the micromap will be copied by value into the acceleration structure, and the micromap may be destroyed after the acceleration structure build concludes.

Instances

Storable MicromapBuildSizesInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: MicromapBuildSizesInfoEXT -> Int

alignment :: MicromapBuildSizesInfoEXT -> Int

peekElemOff :: Ptr MicromapBuildSizesInfoEXT -> Int -> IO MicromapBuildSizesInfoEXT

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

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

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

peek :: Ptr MicromapBuildSizesInfoEXT -> IO MicromapBuildSizesInfoEXT

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

Show MicromapBuildSizesInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapBuildSizesInfoEXT -> ShowS

show :: MicromapBuildSizesInfoEXT -> String

showList :: [MicromapBuildSizesInfoEXT] -> ShowS

Eq MicromapBuildSizesInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: MicromapBuildSizesInfoEXT -> MicromapBuildSizesInfoEXT -> Bool

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

FromCStruct MicromapBuildSizesInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr MicromapBuildSizesInfoEXT -> IO MicromapBuildSizesInfoEXT

ToCStruct MicromapBuildSizesInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr MicromapBuildSizesInfoEXT -> MicromapBuildSizesInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MicromapBuildSizesInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MicromapBuildSizesInfoEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapBuildSizesInfoEXT

data MicromapUsageEXT

VkMicromapUsageEXT - Structure specifying the usage information used to build a micromap

Valid Usage

• If the MicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT then format must be OPACITY_MICROMAP_FORMAT_2_STATE_EXT or OPACITY_MICROMAP_FORMAT_4_STATE_EXT.

• If the MicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT and format is OPACITY_MICROMAP_FORMAT_2_STATE_EXT then subdivisionLevel must be less than or equal to maxOpacity2StateSubdivisionLevel of PhysicalDeviceOpacityMicromapPropertiesEXT
• If the MicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT and format is OPACITY_MICROMAP_FORMAT_4_STATE_EXT then subdivisionLevel must be less than or equal to maxOpacity4StateSubdivisionLevel of PhysicalDeviceOpacityMicromapPropertiesEXT

The format is interpreted based on the type of the micromap using it.

See Also

VK_EXT_opacity_micromap, AccelerationStructureTrianglesOpacityMicromapEXT, MicromapBuildInfoEXT

Constructors

MicromapUsageEXT

Fields

• count :: Word32

  count is the number of triangles in the usage format defined by the subdivisionLevel and format below in the micromap

• subdivisionLevel :: Word32

  subdivisionLevel is the subdivision level of this usage format

• format :: Word32

  format is the format of this usage format

Instances

Storable MicromapUsageEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: MicromapUsageEXT -> Int

alignment :: MicromapUsageEXT -> Int

peekElemOff :: Ptr MicromapUsageEXT -> Int -> IO MicromapUsageEXT

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

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

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

peek :: Ptr MicromapUsageEXT -> IO MicromapUsageEXT

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

Show MicromapUsageEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapUsageEXT -> ShowS

show :: MicromapUsageEXT -> String

showList :: [MicromapUsageEXT] -> ShowS

Eq MicromapUsageEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: MicromapUsageEXT -> MicromapUsageEXT -> Bool

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

FromCStruct MicromapUsageEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr MicromapUsageEXT -> IO MicromapUsageEXT

ToCStruct MicromapUsageEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr MicromapUsageEXT -> MicromapUsageEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MicromapUsageEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MicromapUsageEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapUsageEXT

data MicromapTriangleEXT

VkMicromapTriangleEXT - Structure specifying the micromap format and data for a triangle

Valid Usage

• If the MicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT then format must be OPACITY_MICROMAP_FORMAT_2_STATE_EXT or OPACITY_MICROMAP_FORMAT_4_STATE_EXT.

• If the MicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT and format is OPACITY_MICROMAP_FORMAT_2_STATE_EXT then subdivisionLevel must be less than or equal to maxOpacity2StateSubdivisionLevel of PhysicalDeviceOpacityMicromapPropertiesEXT
• If the MicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT and format is OPACITY_MICROMAP_FORMAT_4_STATE_EXT then subdivisionLevel must be less than or equal to maxOpacity4StateSubdivisionLevel of PhysicalDeviceOpacityMicromapPropertiesEXT

The format is interpreted based on the type of the micromap using it.

See Also

VK_EXT_opacity_micromap

Constructors

MicromapTriangleEXT

Fields

• dataOffset :: Word32

  dataOffset is the offset in bytes of the start of the data for this triangle. This is a byte aligned value.

• subdivisionLevel :: Word16

  subdivisionLevel is the subdivision level of this triangle

• format :: Word16

  format is the format of this triangle

Instances

Storable MicromapTriangleEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: MicromapTriangleEXT -> Int

alignment :: MicromapTriangleEXT -> Int

peekElemOff :: Ptr MicromapTriangleEXT -> Int -> IO MicromapTriangleEXT

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

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

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

peek :: Ptr MicromapTriangleEXT -> IO MicromapTriangleEXT

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

Show MicromapTriangleEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapTriangleEXT -> ShowS

show :: MicromapTriangleEXT -> String

showList :: [MicromapTriangleEXT] -> ShowS

Eq MicromapTriangleEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: MicromapTriangleEXT -> MicromapTriangleEXT -> Bool

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

FromCStruct MicromapTriangleEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr MicromapTriangleEXT -> IO MicromapTriangleEXT

ToCStruct MicromapTriangleEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr MicromapTriangleEXT -> MicromapTriangleEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MicromapTriangleEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MicromapTriangleEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapTriangleEXT

data PhysicalDeviceOpacityMicromapFeaturesEXT

VkPhysicalDeviceOpacityMicromapFeaturesEXT - Structure describing the ray tracing opacity micromap features that can be supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceOpacityMicromapFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceOpacityMicromapFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_EXT_opacity_micromap, Bool32, StructureType

Constructors

PhysicalDeviceOpacityMicromapFeaturesEXT

Fields

• micromap :: Bool

  micromap indicates whether the implementation supports the micromap array feature.

• micromapCaptureReplay :: Bool

  micromapCaptureReplay indicates whether the implementation supports capture and replay of addresses for micromap arrays.

• micromapHostCommands :: Bool

  micromapHostCommands indicates whether the implementation supports host side micromap array commands.

Instances

Storable PhysicalDeviceOpacityMicromapFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: PhysicalDeviceOpacityMicromapFeaturesEXT -> Int

alignment :: PhysicalDeviceOpacityMicromapFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceOpacityMicromapFeaturesEXT -> Int -> IO PhysicalDeviceOpacityMicromapFeaturesEXT

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

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

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

peek :: Ptr PhysicalDeviceOpacityMicromapFeaturesEXT -> IO PhysicalDeviceOpacityMicromapFeaturesEXT

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

Show PhysicalDeviceOpacityMicromapFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> PhysicalDeviceOpacityMicromapFeaturesEXT -> ShowS

show :: PhysicalDeviceOpacityMicromapFeaturesEXT -> String

showList :: [PhysicalDeviceOpacityMicromapFeaturesEXT] -> ShowS

Eq PhysicalDeviceOpacityMicromapFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: PhysicalDeviceOpacityMicromapFeaturesEXT -> PhysicalDeviceOpacityMicromapFeaturesEXT -> Bool

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

FromCStruct PhysicalDeviceOpacityMicromapFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr PhysicalDeviceOpacityMicromapFeaturesEXT -> IO PhysicalDeviceOpacityMicromapFeaturesEXT

ToCStruct PhysicalDeviceOpacityMicromapFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr PhysicalDeviceOpacityMicromapFeaturesEXT -> PhysicalDeviceOpacityMicromapFeaturesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceOpacityMicromapFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceOpacityMicromapFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: PhysicalDeviceOpacityMicromapFeaturesEXT

data PhysicalDeviceOpacityMicromapPropertiesEXT

VkPhysicalDeviceOpacityMicromapPropertiesEXT - Structure describing the opacity micromap properties of a physical device

Description

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

Valid Usage (Implicit)

See Also

VK_EXT_opacity_micromap, StructureType

Constructors

PhysicalDeviceOpacityMicromapPropertiesEXT

Fields

• maxOpacity2StateSubdivisionLevel :: Word32

  maxOpacity2StateSubdivisionLevel is the maximum allowed subdivisionLevel when format is OPACITY_MICROMAP_FORMAT_2_STATE_EXT

• maxOpacity4StateSubdivisionLevel :: Word32

  maxOpacity4StateSubdivisionLevel is the maximum allowed subdivisionLevel when format is OPACITY_MICROMAP_FORMAT_4_STATE_EXT

Instances

Storable PhysicalDeviceOpacityMicromapPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: PhysicalDeviceOpacityMicromapPropertiesEXT -> Int

alignment :: PhysicalDeviceOpacityMicromapPropertiesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceOpacityMicromapPropertiesEXT -> Int -> IO PhysicalDeviceOpacityMicromapPropertiesEXT

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

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

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

peek :: Ptr PhysicalDeviceOpacityMicromapPropertiesEXT -> IO PhysicalDeviceOpacityMicromapPropertiesEXT

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

Show PhysicalDeviceOpacityMicromapPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> PhysicalDeviceOpacityMicromapPropertiesEXT -> ShowS

show :: PhysicalDeviceOpacityMicromapPropertiesEXT -> String

showList :: [PhysicalDeviceOpacityMicromapPropertiesEXT] -> ShowS

Eq PhysicalDeviceOpacityMicromapPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: PhysicalDeviceOpacityMicromapPropertiesEXT -> PhysicalDeviceOpacityMicromapPropertiesEXT -> Bool

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

FromCStruct PhysicalDeviceOpacityMicromapPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

peekCStruct :: Ptr PhysicalDeviceOpacityMicromapPropertiesEXT -> IO PhysicalDeviceOpacityMicromapPropertiesEXT

ToCStruct PhysicalDeviceOpacityMicromapPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr PhysicalDeviceOpacityMicromapPropertiesEXT -> PhysicalDeviceOpacityMicromapPropertiesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceOpacityMicromapPropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceOpacityMicromapPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: PhysicalDeviceOpacityMicromapPropertiesEXT

data AccelerationStructureTrianglesOpacityMicromapEXT

VkAccelerationStructureTrianglesOpacityMicromapEXT - Structure specifying an opacity micromap in a bottom-level acceleration structure

Description

If AccelerationStructureTrianglesOpacityMicromapEXT is included in the pNext chain of a AccelerationStructureGeometryTrianglesDataKHR structure, that geometry will reference that micromap.

For each triangle in the geometry, the acceleration structure build fetches an index from indexBuffer using indexType and indexStride. If that value is the unsigned cast of one of the values from OpacityMicromapSpecialIndexEXT then that triangle behaves as described for that special value in Ray Opacity Micromap. Otherwise that triangle uses the opacity micromap information from micromap at that index plus baseTriangle.

Only one of pUsageCounts or ppUsageCounts can be a valid pointer, the other must be NULL. The elements of the non-NULL array describe the total count used to build this geometry. For a given format and subdivisionLevel the number of triangles in this geometry matching those values after indirection and special index handling must be equal to the sum of matching count provided.

If micromap is NULL_HANDLE, then every value read from indexBuffer must be one of the values in OpacityMicromapSpecialIndexEXT.

Valid Usage

• Only one of pUsageCounts or ppUsageCounts can be a valid pointer, the other must be NULL.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACCELERATION_STRUCTURE_TRIANGLES_OPACITY_MICROMAP_EXT

• indexType must be a valid IndexType value
• If usageCountsCount is not 0, and pUsageCounts is not NULL, pUsageCounts must be a valid pointer to an array of usageCountsCount MicromapUsageEXT structures
• If usageCountsCount is not 0, and ppUsageCounts is not NULL, ppUsageCounts must be a valid pointer to an array of usageCountsCount valid pointers to MicromapUsageEXT structures
• micromap must be a valid MicromapEXT handle

See Also

VK_EXT_opacity_micromap, DeviceOrHostAddressConstKHR, DeviceSize, IndexType, MicromapEXT, MicromapUsageEXT, StructureType

Constructors

AccelerationStructureTrianglesOpacityMicromapEXT

Fields

• indexType :: IndexType

  indexType is the type of triangle indices used when indexing this micromap

• indexBuffer :: DeviceOrHostAddressConstKHR

  indexBuffer is the address containing the triangle indices

• indexStride :: DeviceSize

  indexStride is the byte stride between triangle indices

• baseTriangle :: Word32

  baseTriangle is the base value added to the non-negative triangle indices

• usageCountsCount :: Word32

  usageCountsCount specifies the number of usage counts structures that will be used to determine the size of this micromap.

• usageCounts :: Vector MicromapUsageEXT

  pUsageCounts is a pointer to an array of MicromapUsageEXT structures.

• micromap :: MicromapEXT

  micromap is the handle to the micromap object to include in this geometry

Instances

Show AccelerationStructureTrianglesOpacityMicromapEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> AccelerationStructureTrianglesOpacityMicromapEXT -> ShowS

show :: AccelerationStructureTrianglesOpacityMicromapEXT -> String

showList :: [AccelerationStructureTrianglesOpacityMicromapEXT] -> ShowS

ToCStruct AccelerationStructureTrianglesOpacityMicromapEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

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

pokeCStruct :: Ptr AccelerationStructureTrianglesOpacityMicromapEXT -> AccelerationStructureTrianglesOpacityMicromapEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AccelerationStructureTrianglesOpacityMicromapEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AccelerationStructureTrianglesOpacityMicromapEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: AccelerationStructureTrianglesOpacityMicromapEXT

newtype MicromapTypeEXT

VkMicromapTypeEXT - Type of micromap

See Also

VK_EXT_opacity_micromap, MicromapBuildInfoEXT, MicromapCreateInfoEXT

Constructors

MicromapTypeEXT Int32

Bundled Patterns

pattern MICROMAP_TYPE_OPACITY_MICROMAP_EXT :: MicromapTypeEXT

MICROMAP_TYPE_OPACITY_MICROMAP_EXT is a micromap containing data to control the opacity of a triangle

Instances

Storable MicromapTypeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: MicromapTypeEXT -> Int

alignment :: MicromapTypeEXT -> Int

peekElemOff :: Ptr MicromapTypeEXT -> Int -> IO MicromapTypeEXT

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

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

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

peek :: Ptr MicromapTypeEXT -> IO MicromapTypeEXT

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

Read MicromapTypeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS MicromapTypeEXT

readList :: ReadS [MicromapTypeEXT]

readPrec :: ReadPrec MicromapTypeEXT

readListPrec :: ReadPrec [MicromapTypeEXT]

Show MicromapTypeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapTypeEXT -> ShowS

show :: MicromapTypeEXT -> String

showList :: [MicromapTypeEXT] -> ShowS

Eq MicromapTypeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: MicromapTypeEXT -> MicromapTypeEXT -> Bool

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

Ord MicromapTypeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: MicromapTypeEXT -> MicromapTypeEXT -> Ordering

(<) :: MicromapTypeEXT -> MicromapTypeEXT -> Bool

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

(>) :: MicromapTypeEXT -> MicromapTypeEXT -> Bool

(>=) :: MicromapTypeEXT -> MicromapTypeEXT -> Bool

max :: MicromapTypeEXT -> MicromapTypeEXT -> MicromapTypeEXT

min :: MicromapTypeEXT -> MicromapTypeEXT -> MicromapTypeEXT

Zero MicromapTypeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapTypeEXT

type BuildMicromapFlagsEXT = BuildMicromapFlagBitsEXT

newtype BuildMicromapFlagBitsEXT

VkBuildMicromapFlagBitsEXT - Bitmask specifying additional parameters for micromap builds

See Also

VK_EXT_opacity_micromap, BuildMicromapFlagsEXT

Constructors

BuildMicromapFlagBitsEXT Flags

Bundled Patterns

pattern BUILD_MICROMAP_PREFER_FAST_TRACE_BIT_EXT :: BuildMicromapFlagBitsEXT

BUILD_MICROMAP_PREFER_FAST_TRACE_BIT_EXT indicates that the given micromap build should prioritize trace performance over build time.

pattern BUILD_MICROMAP_PREFER_FAST_BUILD_BIT_EXT :: BuildMicromapFlagBitsEXT

BUILD_MICROMAP_PREFER_FAST_BUILD_BIT_EXT indicates that the given micromap build should prioritize build time over trace performance.

pattern BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT :: BuildMicromapFlagBitsEXT

Instances

Bits BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(.&.) :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT

(.|.) :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT

xor :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT

complement :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT

shift :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

rotate :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

zeroBits :: BuildMicromapFlagBitsEXT

bit :: Int -> BuildMicromapFlagBitsEXT

setBit :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

clearBit :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

complementBit :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

testBit :: BuildMicromapFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: BuildMicromapFlagBitsEXT -> Maybe Int

bitSize :: BuildMicromapFlagBitsEXT -> Int

isSigned :: BuildMicromapFlagBitsEXT -> Bool

shiftL :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

unsafeShiftL :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

shiftR :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

unsafeShiftR :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

rotateL :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

rotateR :: BuildMicromapFlagBitsEXT -> Int -> BuildMicromapFlagBitsEXT

popCount :: BuildMicromapFlagBitsEXT -> Int

FiniteBits BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

finiteBitSize :: BuildMicromapFlagBitsEXT -> Int

countLeadingZeros :: BuildMicromapFlagBitsEXT -> Int

countTrailingZeros :: BuildMicromapFlagBitsEXT -> Int

Storable BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: BuildMicromapFlagBitsEXT -> Int

alignment :: BuildMicromapFlagBitsEXT -> Int

peekElemOff :: Ptr BuildMicromapFlagBitsEXT -> Int -> IO BuildMicromapFlagBitsEXT

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

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

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

peek :: Ptr BuildMicromapFlagBitsEXT -> IO BuildMicromapFlagBitsEXT

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

Read BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS BuildMicromapFlagBitsEXT

readList :: ReadS [BuildMicromapFlagBitsEXT]

readPrec :: ReadPrec BuildMicromapFlagBitsEXT

readListPrec :: ReadPrec [BuildMicromapFlagBitsEXT]

Show BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> BuildMicromapFlagBitsEXT -> ShowS

show :: BuildMicromapFlagBitsEXT -> String

showList :: [BuildMicromapFlagBitsEXT] -> ShowS

Eq BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> Bool

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

Ord BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> Ordering

(<) :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> Bool

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

(>) :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> Bool

(>=) :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> Bool

max :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT

min :: BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT -> BuildMicromapFlagBitsEXT

Zero BuildMicromapFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: BuildMicromapFlagBitsEXT

type MicromapCreateFlagsEXT = MicromapCreateFlagBitsEXT

newtype MicromapCreateFlagBitsEXT

VkMicromapCreateFlagBitsEXT - Bitmask specifying additional creation parameters for micromap

See Also

VK_EXT_opacity_micromap, MicromapCreateFlagsEXT

Constructors

MicromapCreateFlagBitsEXT Flags

Bundled Patterns

pattern MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT :: MicromapCreateFlagBitsEXT

MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT specifies that the micromap’s address can be saved and reused on a subsequent run.

Instances

Bits MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(.&.) :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT

(.|.) :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT

xor :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT

complement :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT

shift :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

rotate :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

zeroBits :: MicromapCreateFlagBitsEXT

bit :: Int -> MicromapCreateFlagBitsEXT

setBit :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

clearBit :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

complementBit :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

testBit :: MicromapCreateFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: MicromapCreateFlagBitsEXT -> Maybe Int

bitSize :: MicromapCreateFlagBitsEXT -> Int

isSigned :: MicromapCreateFlagBitsEXT -> Bool

shiftL :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

unsafeShiftL :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

shiftR :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

unsafeShiftR :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

rotateL :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

rotateR :: MicromapCreateFlagBitsEXT -> Int -> MicromapCreateFlagBitsEXT

popCount :: MicromapCreateFlagBitsEXT -> Int

FiniteBits MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

finiteBitSize :: MicromapCreateFlagBitsEXT -> Int

countLeadingZeros :: MicromapCreateFlagBitsEXT -> Int

countTrailingZeros :: MicromapCreateFlagBitsEXT -> Int

Storable MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: MicromapCreateFlagBitsEXT -> Int

alignment :: MicromapCreateFlagBitsEXT -> Int

peekElemOff :: Ptr MicromapCreateFlagBitsEXT -> Int -> IO MicromapCreateFlagBitsEXT

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

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

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

peek :: Ptr MicromapCreateFlagBitsEXT -> IO MicromapCreateFlagBitsEXT

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

Read MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS MicromapCreateFlagBitsEXT

readList :: ReadS [MicromapCreateFlagBitsEXT]

readPrec :: ReadPrec MicromapCreateFlagBitsEXT

readListPrec :: ReadPrec [MicromapCreateFlagBitsEXT]

Show MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> MicromapCreateFlagBitsEXT -> ShowS

show :: MicromapCreateFlagBitsEXT -> String

showList :: [MicromapCreateFlagBitsEXT] -> ShowS

Eq MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> Bool

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

Ord MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> Ordering

(<) :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> Bool

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

(>) :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> Bool

(>=) :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> Bool

max :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT

min :: MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT -> MicromapCreateFlagBitsEXT

Zero MicromapCreateFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: MicromapCreateFlagBitsEXT

newtype CopyMicromapModeEXT

VkCopyMicromapModeEXT - Micromap copy mode

See Also

VK_EXT_opacity_micromap, CopyMemoryToMicromapInfoEXT, CopyMicromapInfoEXT, CopyMicromapToMemoryInfoEXT

Constructors

CopyMicromapModeEXT Int32

Bundled Patterns

pattern COPY_MICROMAP_MODE_CLONE_EXT :: CopyMicromapModeEXT

COPY_MICROMAP_MODE_CLONE_EXT creates a direct copy of the micromap specified in src into the one specified by dst. The dst micromap must have been created with the same parameters as src.

pattern COPY_MICROMAP_MODE_SERIALIZE_EXT :: CopyMicromapModeEXT

COPY_MICROMAP_MODE_SERIALIZE_EXT serializes the micromap to a semi-opaque format which can be reloaded on a compatible implementation.

pattern COPY_MICROMAP_MODE_DESERIALIZE_EXT :: CopyMicromapModeEXT

COPY_MICROMAP_MODE_DESERIALIZE_EXT deserializes the semi-opaque serialization format in the buffer to the micromap.

pattern COPY_MICROMAP_MODE_COMPACT_EXT :: CopyMicromapModeEXT

COPY_MICROMAP_MODE_COMPACT_EXT creates a more compact version of a micromap src into dst. The micromap dst must have been created with a size at least as large as that returned by cmdWriteMicromapsPropertiesEXT after the build of the micromap specified by src.

Instances

Storable CopyMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: CopyMicromapModeEXT -> Int

alignment :: CopyMicromapModeEXT -> Int

peekElemOff :: Ptr CopyMicromapModeEXT -> Int -> IO CopyMicromapModeEXT

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

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

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

peek :: Ptr CopyMicromapModeEXT -> IO CopyMicromapModeEXT

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

Read CopyMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS CopyMicromapModeEXT

readList :: ReadS [CopyMicromapModeEXT]

readPrec :: ReadPrec CopyMicromapModeEXT

readListPrec :: ReadPrec [CopyMicromapModeEXT]

Show CopyMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> CopyMicromapModeEXT -> ShowS

show :: CopyMicromapModeEXT -> String

showList :: [CopyMicromapModeEXT] -> ShowS

Eq CopyMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> Bool

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

Ord CopyMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> Ordering

(<) :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> Bool

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

(>) :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> Bool

(>=) :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> Bool

max :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> CopyMicromapModeEXT

min :: CopyMicromapModeEXT -> CopyMicromapModeEXT -> CopyMicromapModeEXT

Zero CopyMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: CopyMicromapModeEXT

newtype BuildMicromapModeEXT

VkBuildMicromapModeEXT - Enum specifying the type of build operation to perform

See Also

VK_EXT_opacity_micromap, MicromapBuildInfoEXT

Constructors

BuildMicromapModeEXT Int32

Bundled Patterns

pattern BUILD_MICROMAP_MODE_BUILD_EXT :: BuildMicromapModeEXT

BUILD_MICROMAP_MODE_BUILD_EXT specifies that the destination micromap will be built using the specified data.

Instances

Storable BuildMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: BuildMicromapModeEXT -> Int

alignment :: BuildMicromapModeEXT -> Int

peekElemOff :: Ptr BuildMicromapModeEXT -> Int -> IO BuildMicromapModeEXT

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

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

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

peek :: Ptr BuildMicromapModeEXT -> IO BuildMicromapModeEXT

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

Read BuildMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS BuildMicromapModeEXT

readList :: ReadS [BuildMicromapModeEXT]

readPrec :: ReadPrec BuildMicromapModeEXT

readListPrec :: ReadPrec [BuildMicromapModeEXT]

Show BuildMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> BuildMicromapModeEXT -> ShowS

show :: BuildMicromapModeEXT -> String

showList :: [BuildMicromapModeEXT] -> ShowS

Eq BuildMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> Bool

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

Ord BuildMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> Ordering

(<) :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> Bool

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

(>) :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> Bool

(>=) :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> Bool

max :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> BuildMicromapModeEXT

min :: BuildMicromapModeEXT -> BuildMicromapModeEXT -> BuildMicromapModeEXT

Zero BuildMicromapModeEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: BuildMicromapModeEXT

newtype OpacityMicromapFormatEXT

VkOpacityMicromapFormatEXT - Format enum for opacity micromaps

See Also

VK_EXT_opacity_micromap

Constructors

OpacityMicromapFormatEXT Int32

Bundled Patterns

pattern OPACITY_MICROMAP_FORMAT_2_STATE_EXT :: OpacityMicromapFormatEXT

OPACITY_MICROMAP_FORMAT_2_STATE_EXT indicates that the given micromap format has one bit per subtriangle encoding either fully opaque or fully transparent.

pattern OPACITY_MICROMAP_FORMAT_4_STATE_EXT :: OpacityMicromapFormatEXT

OPACITY_MICROMAP_FORMAT_4_STATE_EXT indicates that the given micromap format has two bits per subtriangle encoding four modes which can be interpreted as described in ray traversal.

Instances

Storable OpacityMicromapFormatEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: OpacityMicromapFormatEXT -> Int

alignment :: OpacityMicromapFormatEXT -> Int

peekElemOff :: Ptr OpacityMicromapFormatEXT -> Int -> IO OpacityMicromapFormatEXT

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

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

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

peek :: Ptr OpacityMicromapFormatEXT -> IO OpacityMicromapFormatEXT

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

Read OpacityMicromapFormatEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS OpacityMicromapFormatEXT

readList :: ReadS [OpacityMicromapFormatEXT]

readPrec :: ReadPrec OpacityMicromapFormatEXT

readListPrec :: ReadPrec [OpacityMicromapFormatEXT]

Show OpacityMicromapFormatEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> OpacityMicromapFormatEXT -> ShowS

show :: OpacityMicromapFormatEXT -> String

showList :: [OpacityMicromapFormatEXT] -> ShowS

Eq OpacityMicromapFormatEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> Bool

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

Ord OpacityMicromapFormatEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> Ordering

(<) :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> Bool

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

(>) :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> Bool

(>=) :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> Bool

max :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT

min :: OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT -> OpacityMicromapFormatEXT

Zero OpacityMicromapFormatEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: OpacityMicromapFormatEXT

newtype OpacityMicromapSpecialIndexEXT

VkOpacityMicromapSpecialIndexEXT - Enum for special indices in the opacity micromap

See Also

VK_EXT_opacity_micromap

Constructors

OpacityMicromapSpecialIndexEXT Int32

Bundled Patterns

pattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_TRANSPARENT_EXT :: OpacityMicromapSpecialIndexEXT

OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_TRANSPARENT_EXT specifies that the entire triangle is fully transparent.

pattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_OPAQUE_EXT :: OpacityMicromapSpecialIndexEXT

OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_OPAQUE_EXT specifies that the entire triangle is fully opaque.

pattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_TRANSPARENT_EXT :: OpacityMicromapSpecialIndexEXT

OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_TRANSPARENT_EXT specifies that the entire triangle is unknown-transparent.

pattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_OPAQUE_EXT :: OpacityMicromapSpecialIndexEXT

OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_OPAQUE_EXT specifies that the entire triangle is unknown-opaque.

Instances

Storable OpacityMicromapSpecialIndexEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

sizeOf :: OpacityMicromapSpecialIndexEXT -> Int

alignment :: OpacityMicromapSpecialIndexEXT -> Int

peekElemOff :: Ptr OpacityMicromapSpecialIndexEXT -> Int -> IO OpacityMicromapSpecialIndexEXT

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

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

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

peek :: Ptr OpacityMicromapSpecialIndexEXT -> IO OpacityMicromapSpecialIndexEXT

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

Read OpacityMicromapSpecialIndexEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

readsPrec :: Int -> ReadS OpacityMicromapSpecialIndexEXT

readList :: ReadS [OpacityMicromapSpecialIndexEXT]

readPrec :: ReadPrec OpacityMicromapSpecialIndexEXT

readListPrec :: ReadPrec [OpacityMicromapSpecialIndexEXT]

Show OpacityMicromapSpecialIndexEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

showsPrec :: Int -> OpacityMicromapSpecialIndexEXT -> ShowS

show :: OpacityMicromapSpecialIndexEXT -> String

showList :: [OpacityMicromapSpecialIndexEXT] -> ShowS

Eq OpacityMicromapSpecialIndexEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

(==) :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> Bool

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

Ord OpacityMicromapSpecialIndexEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

compare :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> Ordering

(<) :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> Bool

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

(>) :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> Bool

(>=) :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> Bool

max :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT

min :: OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT -> OpacityMicromapSpecialIndexEXT

Zero OpacityMicromapSpecialIndexEXT

Defined in Vulkan.Extensions.VK_EXT_opacity_micromap

Methods

zero :: OpacityMicromapSpecialIndexEXT

type EXT_OPACITY_MICROMAP_SPEC_VERSION = 2

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

type EXT_OPACITY_MICROMAP_EXTENSION_NAME = "VK_EXT_opacity_micromap"

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

newtype DeferredOperationKHR

VkDeferredOperationKHR - A deferred operation

Description

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

See Also

VK_KHR_deferred_host_operations, buildAccelerationStructuresKHR, buildMicromapsEXT, copyAccelerationStructureKHR, copyAccelerationStructureToMemoryKHR, copyMemoryToAccelerationStructureKHR, copyMemoryToMicromapEXT, copyMicromapEXT, copyMicromapToMemoryEXT, createDeferredOperationKHR, createRayTracingPipelinesKHR, deferredOperationJoinKHR, destroyDeferredOperationKHR, getDeferredOperationMaxConcurrencyKHR, getDeferredOperationResultKHR

Constructors

DeferredOperationKHR Word64

Instances

Storable DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: DeferredOperationKHR -> Int

alignment :: DeferredOperationKHR -> Int

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

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

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

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

peek :: Ptr DeferredOperationKHR -> IO DeferredOperationKHR

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

Show DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DeferredOperationKHR -> ShowS

show :: DeferredOperationKHR -> String

showList :: [DeferredOperationKHR] -> ShowS

Eq DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: DeferredOperationKHR -> DeferredOperationKHR -> Ordering

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

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

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

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

max :: DeferredOperationKHR -> DeferredOperationKHR -> DeferredOperationKHR

min :: DeferredOperationKHR -> DeferredOperationKHR -> DeferredOperationKHR

HasObjectType DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DeferredOperationKHR -> (ObjectType, Word64)

IsHandle DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Zero DeferredOperationKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DeferredOperationKHR

newtype MicromapEXT

VkMicromapEXT - Opaque handle to a micromap object

See Also

VK_EXT_opacity_micromap, AccelerationStructureTrianglesOpacityMicromapEXT, CopyMemoryToMicromapInfoEXT, CopyMicromapInfoEXT, CopyMicromapToMemoryInfoEXT, MicromapBuildInfoEXT, cmdWriteMicromapsPropertiesEXT, createMicromapEXT, destroyMicromapEXT, writeMicromapsPropertiesEXT

Constructors

MicromapEXT Word64

Instances

Storable MicromapEXT

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: MicromapEXT -> Int

alignment :: MicromapEXT -> Int

peekElemOff :: Ptr MicromapEXT -> Int -> IO MicromapEXT

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

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

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

peek :: Ptr MicromapEXT -> IO MicromapEXT

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

Show MicromapEXT

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> MicromapEXT -> ShowS

show :: MicromapEXT -> String

showList :: [MicromapEXT] -> ShowS

Eq MicromapEXT

Defined in Vulkan.Extensions.Handles

Methods

(==) :: MicromapEXT -> MicromapEXT -> Bool

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

Ord MicromapEXT

Defined in Vulkan.Extensions.Handles

Methods

compare :: MicromapEXT -> MicromapEXT -> Ordering

(<) :: MicromapEXT -> MicromapEXT -> Bool

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

(>) :: MicromapEXT -> MicromapEXT -> Bool

(>=) :: MicromapEXT -> MicromapEXT -> Bool

max :: MicromapEXT -> MicromapEXT -> MicromapEXT

min :: MicromapEXT -> MicromapEXT -> MicromapEXT

HasObjectType MicromapEXT

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: MicromapEXT -> (ObjectType, Word64)

IsHandle MicromapEXT

Defined in Vulkan.Extensions.Handles

Zero MicromapEXT

Defined in Vulkan.Extensions.Handles

Methods

zero :: MicromapEXT

data DeviceOrHostAddressKHR

Constructors

DeviceAddress DeviceAddress

HostAddress (Ptr ())

Instances

Show DeviceOrHostAddressKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> DeviceOrHostAddressKHR -> ShowS

show :: DeviceOrHostAddressKHR -> String

showList :: [DeviceOrHostAddressKHR] -> ShowS

ToCStruct DeviceOrHostAddressKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

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_acceleration_structure

Methods

zero :: DeviceOrHostAddressKHR

data DeviceOrHostAddressConstKHR

Constructors

DeviceAddressConst DeviceAddress

HostAddressConst (Ptr ())

Instances

Show DeviceOrHostAddressConstKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> DeviceOrHostAddressConstKHR -> ShowS

show :: DeviceOrHostAddressConstKHR -> String

showList :: [DeviceOrHostAddressConstKHR] -> ShowS

ToCStruct DeviceOrHostAddressConstKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

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_acceleration_structure

Methods

zero :: DeviceOrHostAddressConstKHR

newtype GeometryInstanceFlagBitsKHR

VkGeometryInstanceFlagBitsKHR - Instance flag bits

Description

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

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, GeometryInstanceFlagsKHR

Constructors

GeometryInstanceFlagBitsKHR Flags

Bundled Patterns

pattern GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR :: GeometryInstanceFlagBitsKHR

GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR disables face culling for this instance.

pattern GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR :: GeometryInstanceFlagBitsKHR

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

pattern GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR :: GeometryInstanceFlagBitsKHR

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

pattern GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR :: GeometryInstanceFlagBitsKHR

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

pattern GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_EXT :: GeometryInstanceFlagBitsKHR

pattern GEOMETRY_INSTANCE_FORCE_OPACITY_MICROMAP_2_STATE_EXT :: GeometryInstanceFlagBitsKHR

Instances

Bits GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

xor :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

complement :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

shift :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

rotate :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

zeroBits :: GeometryInstanceFlagBitsKHR

bit :: Int -> GeometryInstanceFlagBitsKHR

setBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

clearBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

complementBit :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

testBit :: GeometryInstanceFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: GeometryInstanceFlagBitsKHR -> Maybe Int

bitSize :: GeometryInstanceFlagBitsKHR -> Int

isSigned :: GeometryInstanceFlagBitsKHR -> Bool

shiftL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

unsafeShiftL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

shiftR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

unsafeShiftR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

rotateL :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

rotateR :: GeometryInstanceFlagBitsKHR -> Int -> GeometryInstanceFlagBitsKHR

popCount :: GeometryInstanceFlagBitsKHR -> Int

FiniteBits GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

finiteBitSize :: GeometryInstanceFlagBitsKHR -> Int

countLeadingZeros :: GeometryInstanceFlagBitsKHR -> Int

countTrailingZeros :: GeometryInstanceFlagBitsKHR -> Int

Storable GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: GeometryInstanceFlagBitsKHR -> Int

alignment :: GeometryInstanceFlagBitsKHR -> Int

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

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

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

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

peek :: Ptr GeometryInstanceFlagBitsKHR -> IO GeometryInstanceFlagBitsKHR

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

Read GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS GeometryInstanceFlagBitsKHR

readList :: ReadS [GeometryInstanceFlagBitsKHR]

readPrec :: ReadPrec GeometryInstanceFlagBitsKHR

readListPrec :: ReadPrec [GeometryInstanceFlagBitsKHR]

Show GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> GeometryInstanceFlagBitsKHR -> ShowS

show :: GeometryInstanceFlagBitsKHR -> String

showList :: [GeometryInstanceFlagBitsKHR] -> ShowS

Eq GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

Ord GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> Ordering

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

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

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

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

max :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

min :: GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR -> GeometryInstanceFlagBitsKHR

Zero GeometryInstanceFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: GeometryInstanceFlagBitsKHR

type GeometryInstanceFlagsKHR = GeometryInstanceFlagBitsKHR

newtype BuildAccelerationStructureFlagBitsKHR

VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds

Description

Note

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

See Also

VK_KHR_acceleration_structure, VK_NV_ray_tracing, BuildAccelerationStructureFlagsKHR

Constructors

BuildAccelerationStructureFlagBitsKHR Flags

Bundled Patterns

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_EXT :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_EXT :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_EXT :: BuildAccelerationStructureFlagBitsKHR

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

pattern BUILD_ACCELERATION_STRUCTURE_MOTION_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

Instances

Bits BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

xor :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

complement :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

shift :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

rotate :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

zeroBits :: BuildAccelerationStructureFlagBitsKHR

bit :: Int -> BuildAccelerationStructureFlagBitsKHR

setBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

clearBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

complementBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

testBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: BuildAccelerationStructureFlagBitsKHR -> Maybe Int

bitSize :: BuildAccelerationStructureFlagBitsKHR -> Int

isSigned :: BuildAccelerationStructureFlagBitsKHR -> Bool

shiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

unsafeShiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

shiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

unsafeShiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

rotateL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

rotateR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR

popCount :: BuildAccelerationStructureFlagBitsKHR -> Int

FiniteBits BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

finiteBitSize :: BuildAccelerationStructureFlagBitsKHR -> Int

countLeadingZeros :: BuildAccelerationStructureFlagBitsKHR -> Int

countTrailingZeros :: BuildAccelerationStructureFlagBitsKHR -> Int

Storable BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: BuildAccelerationStructureFlagBitsKHR -> Int

alignment :: BuildAccelerationStructureFlagBitsKHR -> Int

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

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

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

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

peek :: Ptr BuildAccelerationStructureFlagBitsKHR -> IO BuildAccelerationStructureFlagBitsKHR

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

Read BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS BuildAccelerationStructureFlagBitsKHR

readList :: ReadS [BuildAccelerationStructureFlagBitsKHR]

readPrec :: ReadPrec BuildAccelerationStructureFlagBitsKHR

readListPrec :: ReadPrec [BuildAccelerationStructureFlagBitsKHR]

Show BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> BuildAccelerationStructureFlagBitsKHR -> ShowS

show :: BuildAccelerationStructureFlagBitsKHR -> String

showList :: [BuildAccelerationStructureFlagBitsKHR] -> ShowS

Eq BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

Ord BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Ordering

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

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

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

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

max :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

min :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR

Zero BuildAccelerationStructureFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: BuildAccelerationStructureFlagBitsKHR

type BuildAccelerationStructureFlagsKHR = BuildAccelerationStructureFlagBitsKHR

newtype AccelerationStructureBuildTypeKHR

VkAccelerationStructureBuildTypeKHR - Acceleration structure build type

See Also

VK_KHR_acceleration_structure, getAccelerationStructureBuildSizesKHR, getMicromapBuildSizesEXT

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

Storable AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

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

Read AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS AccelerationStructureBuildTypeKHR

readList :: ReadS [AccelerationStructureBuildTypeKHR]

readPrec :: ReadPrec AccelerationStructureBuildTypeKHR

readListPrec :: ReadPrec [AccelerationStructureBuildTypeKHR]

Show AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> AccelerationStructureBuildTypeKHR -> ShowS

show :: AccelerationStructureBuildTypeKHR -> String

showList :: [AccelerationStructureBuildTypeKHR] -> ShowS

Eq AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

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

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

Ord AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

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

Zero AccelerationStructureBuildTypeKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: AccelerationStructureBuildTypeKHR

newtype AccelerationStructureCompatibilityKHR

VkAccelerationStructureCompatibilityKHR - Acceleration structure compatibility

See Also

VK_KHR_acceleration_structure, getDeviceAccelerationStructureCompatibilityKHR, getDeviceMicromapCompatibilityEXT

Constructors

AccelerationStructureCompatibilityKHR Int32

Bundled Patterns

pattern ACCELERATION_STRUCTURE_COMPATIBILITY_COMPATIBLE_KHR :: AccelerationStructureCompatibilityKHR

ACCELERATION_STRUCTURE_COMPATIBILITY_COMPATIBLE_KHR if the pVersionData version acceleration structure is compatible with device.

pattern ACCELERATION_STRUCTURE_COMPATIBILITY_INCOMPATIBLE_KHR :: AccelerationStructureCompatibilityKHR

ACCELERATION_STRUCTURE_COMPATIBILITY_INCOMPATIBLE_KHR if the pVersionData version acceleration structure is not compatible with device.

Instances

Storable AccelerationStructureCompatibilityKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

sizeOf :: AccelerationStructureCompatibilityKHR -> Int

alignment :: AccelerationStructureCompatibilityKHR -> Int

peekElemOff :: Ptr AccelerationStructureCompatibilityKHR -> Int -> IO AccelerationStructureCompatibilityKHR

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

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

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

peek :: Ptr AccelerationStructureCompatibilityKHR -> IO AccelerationStructureCompatibilityKHR

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

Read AccelerationStructureCompatibilityKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

readsPrec :: Int -> ReadS AccelerationStructureCompatibilityKHR

readList :: ReadS [AccelerationStructureCompatibilityKHR]

readPrec :: ReadPrec AccelerationStructureCompatibilityKHR

readListPrec :: ReadPrec [AccelerationStructureCompatibilityKHR]

Show AccelerationStructureCompatibilityKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

showsPrec :: Int -> AccelerationStructureCompatibilityKHR -> ShowS

show :: AccelerationStructureCompatibilityKHR -> String

showList :: [AccelerationStructureCompatibilityKHR] -> ShowS

Eq AccelerationStructureCompatibilityKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

(==) :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> Bool

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

Ord AccelerationStructureCompatibilityKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

compare :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> Ordering

(<) :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> Bool

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

(>) :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> Bool

(>=) :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> Bool

max :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR

min :: AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR -> AccelerationStructureCompatibilityKHR

Zero AccelerationStructureCompatibilityKHR

Defined in Vulkan.Extensions.VK_KHR_acceleration_structure

Methods

zero :: AccelerationStructureCompatibilityKHR