Modulevulkan-3.27GHC2021

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

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_acceleration_structure

and

VK_KHR_synchronization2 or

Vulkan Version 1.3

API Interactions

Interacts with VK_VERSION_1_4
Interacts with VK_KHR_maintenance5

SPIR-V Dependencies

SPV_EXT_opacity_micromap

Deprecation State

Promoted to VK_KHR_opacity_micromap extension

Contact

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

Extension Proposal

VK_EXT_opacity_micromap

Other Extension Metadata

Last Modified Date: 2022-08-24

Interactions and External Dependencies

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

Promotion to VK_KHR_opacity_micromap

Functionality in this extension is included in VK_KHR_opacity_micromap. The type, enum and command names are still aliases of the KHR functionality with some exceptions.

See the VK_KHR_opacity_micromap proposal for details on the differences.

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

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.

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.

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.

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.

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.

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

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.

36 types
15 values

Packagevulkan-3.27
Exports110
LanguageGHC2021
LicenceBSD-3-Clause
SourceVK_EXT_opacity_micromap.hs

valuecreateMicromapEXT

:: MonadIO io
=> Device
device is the logical device that creates the micromap 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.

The micromap data is stored in the object referred to by MicromapCreateInfoEXT::buffer. Once memory has been bound to that buffer, it must be populated by micromap build or micromap copy commands such as cmdBuildMicromapsEXT, buildMicromapsEXT, cmdCopyMicromapEXT, and copyMicromapEXT.

The expected usage for a trace capture/replay tool is that it will serialize and later deserialize the micromap data using micromap copy commands. During capture the tool will set CopyMicromapToMemoryInfoEXT::mode to COPY_MICROMAP_MODE_SERIALIZE_EXT, and during replay the tool will set CopyMemoryToMicromapInfoEXT::mode to COPY_MICROMAP_MODE_DESERIALIZE_EXT.

Valid Usage

The ::micromap 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
The device must have been created with at least 1 queue

Return Codes

Success

SUCCESS

Failure

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.

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

The input buffers passed to this command will be referenced by the implementation for the duration of the command’s execution on the device. Micromaps must be fully self-contained. The application can reuse or free any memory which was used by this command’s execution on the device 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, provided proper synchronization is used as described below.

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 | ACCESS_2_MICROMAP_WRITE_BIT_EXT). Accesses to MicromapBuildInfoEXT::dstMicromap must be synchronized with the PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT pipeline stage and an access type of ACCESS_2_MICROMAP_WRITE_BIT_EXT.

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 ::micromap feature must be enabled
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 set
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 the BUFFER_USAGE_STORAGE_BUFFER_BIT usage flag set
For each element of pInfos, if the value of MicromapBuildSizesInfoEXT::buildScratchSize, returned from a call to getMicromapBuildSizesEXT with an identical MicromapBuildInfoEXT structure, is not 0, scratchData.deviceAddress must be a valid DeviceAddress
For each element of pInfos, data.deviceAddress must be a valid DeviceAddress
For each element of pInfos, triangleArray.deviceAddress must be a valid DeviceAddress
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
The range of memory backing the dstMicromap member of any element of pInfos that is accessed by the execution of this command on the device must not overlap the memory backing the dstMicromap member of any other element of pInfos, which is accessed by the execution of this command on the device
The range of memory backing the dstMicromap member of any element of pInfos that is accessed by the execution of this command on the device must not overlap the memory backing the scratchData member of any element of pInfos (including the same element), which is accessed by the execution of this command on the device
The range of memory backing the scratchData member of any element of pInfos that is accessed by the execution of this command on the device must not overlap the memory backing the scratchData member of any other element of pInfos, which is accessed by the execution of this command on the device

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 QUEUE_COMPUTE_BIT operations
This command must only be called outside of a render pass instance
This command must not be called between suspended render pass instances
This command must only be called outside of a video coding scope
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	VK_QUEUE_COMPUTE_BIT	Action

Conditional Rendering

vkCmdBuildMicromapsEXT is not affected by conditional rendering

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.

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

The input buffers passed to this command will be referenced by the implementation for the duration of the command. Micromaps must be fully self-contained. The application can reuse 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

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
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, and N is not 0, then 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 value of MicromapBuildSizesInfoEXT::buildScratchSize returned from a call to getMicromapBuildSizesEXT with an identical MicromapBuildInfoEXT structure
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
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

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

Failure

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 must be bound to device memory
The source micromap src must have been constructed prior to the execution of this command on the device

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 QUEUE_COMPUTE_BIT operations
This command must only be called outside of a render pass instance
This command must not be called between suspended render pass instances
This command must only be called outside of a video coding scope

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	VK_QUEUE_COMPUTE_BIT	Action

Conditional Rendering

vkCmdCopyMicromapEXT is not affected by conditional rendering

Description

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

Valid Usage

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
The source micromap src must have been constructed prior to the execution of this command

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

Failure

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 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 is equally compatible for use with 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 DeviceAddress

pInfo->dst.deviceAddress must be aligned to 256 bytes
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 QUEUE_COMPUTE_BIT operations
This command must only be called outside of a render pass instance
This command must not be called between suspended render pass instances
This command must only be called outside of a video coding scope

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	VK_QUEUE_COMPUTE_BIT	Action

Conditional Rendering

vkCmdCopyMicromapToMemoryEXT is not affected by conditional rendering

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 is compatible for use with either cmdCopyMemoryToMicromapEXT or copyMemoryToMicromapEXT.

Valid Usage

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

Failure

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_WRITE_BIT_EXT. Accesses to the buffer indicated by pInfo->src 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 copyMicromapToMemoryEXT or cmdCopyMicromapToMemoryEXT.

Valid Usage

pInfo->src.deviceAddress must be a valid DeviceAddress

pInfo->src.deviceAddress must be aligned to 256 bytes
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 QUEUE_COMPUTE_BIT operations
This command must only be called outside of a render pass instance
This command must not be called between suspended render pass instances
This command must only be called outside of a video coding scope

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	VK_QUEUE_COMPUTE_BIT	Action

Conditional Rendering

vkCmdCopyMemoryToMicromapEXT is not affected by conditional rendering

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

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

Failure

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

All queries used by this command must be unavailable
The buffer used to create each micromap in pMicromaps 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 on the device
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
queryPool must be a valid QueryPool handle
commandBuffer must be in the recording state
The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT operations
This command must only be called outside of a render pass instance
This command must not be called between suspended render pass instances
This command must only be called outside of a video coding scope
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	VK_QUEUE_COMPUTE_BIT	Action

Conditional Rendering

vkCmdWriteMicromapsPropertiesEXT is not affected by conditional rendering

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 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 or QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT then stride must be a multiple of the size of DeviceSize
If queryType is QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT or QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT then pData must point to a DeviceSize
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
All micromaps in pMicromaps must have been constructed prior to the execution of this command

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

Description

The dstMicromap, mode, data, scratchData, and triangleArray 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, 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

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.

For opacity micromaps, 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.

For displacement micromaps, the data at data is interpreted as discussed in Displacement Micromap Encoding.

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, for each member of pUsageCounts or ppUsageCounts, format must be a valid value from OpacityMicromapFormatEXT
If type is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV, for each member of pUsageCounts or ppUsageCounts, format must be a valid value from DisplacementMicromapFormatNV
If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of pUsageCounts or ppUsageCounts, if format is OPACITY_MICROMAP_FORMAT_2_STATE_EXT, subdivisionLevel must be less than or equal to ::maxOpacity2StateSubdivisionLevel
If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of pUsageCounts or ppUsageCounts, if format is OPACITY_MICROMAP_FORMAT_4_STATE_EXT, subdivisionLevel must be less than or equal to ::maxOpacity4StateSubdivisionLevel
If type is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV, for each member of pUsageCounts or ppUsageCounts, subdivisionLevel must be less than or equal to PhysicalDeviceDisplacementMicromapPropertiesNV::maxDisplacementMicromapSubdivisionLevel
If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of triangleArray, format must be a valid value from OpacityMicromapFormatEXT
If type is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV, for each member of triangleArray, format must be a valid value from DisplacementMicromapFormatNV
If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of triangleArray, if format is OPACITY_MICROMAP_FORMAT_2_STATE_EXT, subdivisionLevel must be less than or equal to ::maxOpacity2StateSubdivisionLevel
If type is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of triangleArray, if format is OPACITY_MICROMAP_FORMAT_4_STATE_EXT, subdivisionLevel must be less than or equal to ::maxOpacity4StateSubdivisionLevel
If type is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV, for each member of triangleArray, subdivisionLevel must be less than or equal to PhysicalDeviceDisplacementMicromapPropertiesNV::maxDisplacementMicromapSubdivisionLevel

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

Constructors

MicromapBuildInfoEXT
- 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.
- usageCounts :: Vector MicromapUsageEXT
  pUsageCounts is a pointer to an array of MicromapUsageEXT structures.
- data' :: DeviceOrHostAddressConstKHR
  data is the device or host address of memory which contains the data for the micromap.
- scratchData :: DeviceOrHostAddressKHR
  scratchData is the device or host address of memory that will be used as scratch memory for the build.
- triangleArray :: DeviceOrHostAddressConstKHR
  triangleArray is the device or host address of memory containing the MicromapTriangleEXT data
- triangleArrayStride :: DeviceSize
  triangleArrayStride is the stride in bytes between each element of triangleArray

Instances3Show, ToCStruct, Zero

Show MicromapBuildInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct MicromapBuildInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapBuildInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

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

The expected usage for this is that a trace capture/replay tool will add the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT flag and BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT to all buffers used as storage for a micromap with MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT included in createFlags. This also means that the tool will need to add MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT to memory allocations to allow the BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT 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. Applications and tools should avoid mixing application-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, ::micromapCaptureReplay must be TRUE
If createFlags includes MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT and device was created with multiple physical devices, the bufferDeviceAddressMultiDevice feature must be enabled
buffer must have been created with the BUFFER_USAGE_MICROMAP_STORAGE_BIT_EXT usage flag set
buffer must not have been created with BUFFER_CREATE_SPARSE_RESIDENCY_BIT
The sum of offset and size must be less than or equal to 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
If deviceAddress is not 0, deviceAddress must be a valid DeviceAddress value

Constructors

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

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq MicromapCreateInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show MicromapCreateInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable MicromapCreateInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct MicromapCreateInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct MicromapCreateInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapCreateInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata MicromapVersionInfoEXT

VkMicromapVersionInfoEXT - Micromap version information

Description

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 that is loaded in memory. Using arrays would necessitate extra memory copies of the UUIDs.

Valid Usage (Implicit)

Constructors

MicromapVersionInfoEXT
- 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

Instances4Show, FromCStruct, ToCStruct, Zero

Show MicromapVersionInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct MicromapVersionInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct MicromapVersionInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapVersionInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata CopyMicromapInfoEXT

VkCopyMicromapInfoEXT - Parameters for copying a micromap

Valid Usage

mode must be COPY_MICROMAP_MODE_COMPACT_EXT or COPY_MICROMAP_MODE_CLONE_EXT

If mode is COPY_MICROMAP_MODE_COMPACT_EXT, src must have been constructed with BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT in the build

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
Both of dst, and src must have been created, allocated, or retrieved from the same Device

Constructors

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

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq CopyMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show CopyMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable CopyMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct CopyMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct CopyMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero CopyMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata 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

Constructors

CopyMicromapToMemoryInfoEXT
- src :: MicromapEXT
  src is the source micromap for the copy
- dst :: DeviceOrHostAddressKHR
  dst is the device or host address of memory which is the target for the copy
- mode :: CopyMicromapModeEXT
  mode is a CopyMicromapModeEXT value specifying additional operations to perform during the copy.

Instances3Show, ToCStruct, Zero

Show CopyMicromapToMemoryInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct CopyMicromapToMemoryInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero CopyMicromapToMemoryInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata 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

Constructors

CopyMemoryToMicromapInfoEXT
- src :: DeviceOrHostAddressConstKHR
  src is the device or host address of 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.

Instances3Show, ToCStruct, Zero

Show CopyMemoryToMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct CopyMemoryToMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero CopyMemoryToMicromapInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata MicromapBuildSizesInfoEXT

VkMicromapBuildSizesInfoEXT - Structure specifying build sizes for a micromap

Valid Usage (Implicit)

Constructors

MicromapBuildSizesInfoEXT
- 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 can be destroyed after the acceleration structure build concludes.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq MicromapBuildSizesInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show MicromapBuildSizesInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable MicromapBuildSizesInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct MicromapBuildSizesInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct MicromapBuildSizesInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapBuildSizesInfoEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata MicromapUsageEXT

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

Description

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

Constructors

MicromapUsageEXT
- 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

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq MicromapUsageEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show MicromapUsageEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable MicromapUsageEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct MicromapUsageEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct MicromapUsageEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapUsageEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata 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. If the application wishes to use a Device with any features described by PhysicalDeviceOpacityMicromapFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

Constructors

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

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceOpacityMicromapFeaturesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show PhysicalDeviceOpacityMicromapFeaturesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable PhysicalDeviceOpacityMicromapFeaturesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct PhysicalDeviceOpacityMicromapFeaturesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct PhysicalDeviceOpacityMicromapFeaturesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero PhysicalDeviceOpacityMicromapFeaturesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

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

Structure Chaining

Extends the structure

PhysicalDeviceProperties2

Constructors

PhysicalDeviceOpacityMicromapPropertiesEXT
- maxOpacity2StateSubdivisionLevel :: Word32
  maxOpacity2StateSubdivisionLevel is the maximum allowed subdivisionLevel when format is OPACITY_MICROMAP_FORMAT_2_STATE_KHR
- maxOpacity4StateSubdivisionLevel :: Word32
  maxOpacity4StateSubdivisionLevel is the maximum allowed subdivisionLevel when format is OPACITY_MICROMAP_FORMAT_4_STATE_KHR

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceOpacityMicromapPropertiesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show PhysicalDeviceOpacityMicromapPropertiesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable PhysicalDeviceOpacityMicromapPropertiesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FromCStruct PhysicalDeviceOpacityMicromapPropertiesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct PhysicalDeviceOpacityMicromapPropertiesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero PhysicalDeviceOpacityMicromapPropertiesEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

datadata AccelerationStructureTrianglesOpacityMicromapEXT

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

Description

If AccelerationStructureTrianglesOpacityMicromapEXT is included in the pNext chain of a AccelerationStructureDenseGeometryFormatTrianglesDataAMDX or 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 present. If indexType is INDEX_TYPE_NONE_KHR, then the index used is the index of the triangle in the geometry.

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

indexType must be INDEX_TYPE_UINT16, INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_KHR
If indexType is not INDEX_TYPE_NONE_KHR, then indexStride must be a multiple of the size in bytes of indexType
If indexType is not INDEX_TYPE_NONE_KHR, then indexStride must be less than or equal to 232-1
If micromap is not NULL_HANDLE, the type used to construct micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, the format member of each element of pUsageCounts or ppUsageCounts must be a valid value from OpacityMicromapFormatEXT
If micromap is not NULL_HANDLE, the type used to build micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of pUsageCounts or ppUsageCounts with format equal to OPACITY_MICROMAP_FORMAT_2_STATE_EXT, subdivisionLevel must be less than or equal to ::maxOpacity2StateSubdivisionLevel
If micromap is not NULL_HANDLE, the type used to build micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT, for each member of pUsageCounts or ppUsageCounts with format equal to OPACITY_MICROMAP_FORMAT_4_STATE_EXT, subdivisionLevel must be less than or equal to ::maxOpacity4StateSubdivisionLevel
If micromap is not NULL_HANDLE, the type used to construct micromap is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV, the format member of each element of pUsageCounts or ppUsageCounts must be a valid value from DisplacementMicromapFormatNV
If micromap is not NULL_HANDLE, the type used to construct micromap is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV, for each member of pUsageCounts or ppUsageCounts subdivisionLevel must be less than or equal to PhysicalDeviceDisplacementMicromapPropertiesNV::maxDisplacementMicromapSubdivisionLevel

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
If micromap is not NULL_HANDLE, micromap must be a valid MicromapEXT handle

Structure Chaining

Extends the structures

Constructors

AccelerationStructureTrianglesOpacityMicromapEXT
- indexType :: IndexType
  indexType is the type of triangle indices used when indexing this micromap.
- indexBuffer :: DeviceOrHostAddressConstKHR
  indexBuffer is a device or host address of memory containing the triangle indices. When indexType is INDEX_TYPE_NONE_KHR it must be NULL.
- indexStride :: DeviceSize
  indexStride is the byte stride between triangle indices.
- baseTriangle :: Word32
  baseTriangle is the base value added to the non-negative triangle indices.
- 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.

Instances3Show, ToCStruct, Zero

Show AccelerationStructureTrianglesOpacityMicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
ToCStruct AccelerationStructureTrianglesOpacityMicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero AccelerationStructureTrianglesOpacityMicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

newtypenewtype MicromapTypeEXT

VkMicromapTypeEXT - Type of micromap

Description

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

MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV is a micromap containing data to control the displacement of subtriangles within a triangle.

Constructors

MicromapTypeEXT Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq MicromapTypeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Ord MicromapTypeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Read MicromapTypeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show MicromapTypeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable MicromapTypeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapTypeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

patternpattern MICROMAP_TYPE_OPACITY_MICROMAP_EXT :: MicromapTypeEXT

patternpattern MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV :: MicromapTypeEXT

typetype BuildMicromapFlagsEXT = BuildMicromapFlagBitsEXT

newtypenewtype BuildMicromapFlagBitsEXT

VkBuildMicromapFlagBitsEXT - Bitmask specifying additional parameters for micromap builds

Description

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

BUILD_MICROMAP_PREFER_FAST_BUILD_BIT_EXT specifies that the given micromap build should prioritize build time over trace performance.
BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT specifies that the micromap can act as the source for a copy micromap command with mode of COPY_MICROMAP_MODE_COMPACT_EXT to produce a compacted micromap.

Constructors

BuildMicromapFlagBitsEXT Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Ord BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Read BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Bits BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FiniteBits BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero BuildMicromapFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

patternpattern BUILD_MICROMAP_PREFER_FAST_TRACE_BIT_EXT :: BuildMicromapFlagBitsEXT

patternpattern BUILD_MICROMAP_PREFER_FAST_BUILD_BIT_EXT :: BuildMicromapFlagBitsEXT

patternpattern BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT :: BuildMicromapFlagBitsEXT

typetype MicromapCreateFlagsEXT = MicromapCreateFlagBitsEXT

newtypenewtype MicromapCreateFlagBitsEXT

VkMicromapCreateFlagBitsEXT - Bitmask specifying additional creation parameters for micromap

Description

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

Constructors

MicromapCreateFlagBitsEXT Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Ord MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Read MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Bits MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
FiniteBits MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero MicromapCreateFlagBitsEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

patternpattern MICROMAP_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT :: MicromapCreateFlagBitsEXT

newtypenewtype CopyMicromapModeEXT

VkCopyMicromapModeEXT - Micromap copy mode

Description

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.

COPY_MICROMAP_MODE_SERIALIZE_EXT serializes the micromap to a semi-opaque format which can be reloaded on a compatible implementation.
COPY_MICROMAP_MODE_DESERIALIZE_EXT deserializes the semi-opaque serialization format in the buffer to the micromap.
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.

Constructors

CopyMicromapModeEXT Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq CopyMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Ord CopyMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Read CopyMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show CopyMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable CopyMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero CopyMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

patternpattern COPY_MICROMAP_MODE_CLONE_EXT :: CopyMicromapModeEXT

patternpattern COPY_MICROMAP_MODE_SERIALIZE_EXT :: CopyMicromapModeEXT

patternpattern COPY_MICROMAP_MODE_DESERIALIZE_EXT :: CopyMicromapModeEXT

patternpattern COPY_MICROMAP_MODE_COMPACT_EXT :: CopyMicromapModeEXT

newtypenewtype BuildMicromapModeEXT

VkBuildMicromapModeEXT - Enum specifying the type of build operation to perform

Description

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

Constructors

BuildMicromapModeEXT Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq BuildMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Ord BuildMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Read BuildMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Show BuildMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Storable BuildMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap
Zero BuildMicromapModeEXTDefined in vulkan-3.27 · Vulkan.Extensions.VK_EXT_opacity_micromap

patternpattern BUILD_MICROMAP_MODE_BUILD_EXT :: BuildMicromapModeEXT

typetype OpacityMicromapFormatEXT = OpacityMicromapFormatKHR

typetype OpacityMicromapSpecialIndexEXT = OpacityMicromapSpecialIndexKHR

typetype MicromapTriangleEXT = MicromapTriangleKHR

typetype EXT_OPACITY_MICROMAP_SPEC_VERSION = 2

patternpattern EXT_OPACITY_MICROMAP_SPEC_VERSION :: Integral a => a

typetype EXT_OPACITY_MICROMAP_EXTENSION_NAME = "VK_EXT_opacity_micromap"

patternpattern EXT_OPACITY_MICROMAP_EXTENSION_NAME :: (Eq a, IsString a) => a

newtypenewtype DeferredOperationKHR

VkDeferredOperationKHR - A deferred operation

Description

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

Constructors

DeferredOperationKHR Word64

Instances7Eq, Ord, Show, Storable, HasObjectType, IsHandle, …

Eq DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Ord DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Show DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Storable DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles
HasObjectType DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles
IsHandle DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Zero DeferredOperationKHRDefined in vulkan-3.27 · Vulkan.Extensions.Handles

newtypenewtype MicromapEXT

VkMicromapEXT - Opaque handle to a micromap object

Constructors

MicromapEXT Word64

Instances7Eq, Ord, Show, Storable, HasObjectType, IsHandle, …

Eq MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Ord MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Show MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Storable MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles
HasObjectType MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles
IsHandle MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Zero MicromapEXTDefined in vulkan-3.27 · Vulkan.Extensions.Handles

datadata MicromapTriangleKHR

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

Description

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

Constructors

MicromapTriangleKHR
- 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

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq MicromapTriangleKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Show MicromapTriangleKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Storable MicromapTriangleKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
FromCStruct MicromapTriangleKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
ToCStruct MicromapTriangleKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Zero MicromapTriangleKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap

datadata DeviceOrHostAddressKHR

Constructors

DeviceAddress DeviceAddress
HostAddress (Ptr ())

Instances3Show, ToCStruct, Zero

Show DeviceOrHostAddressKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
ToCStruct DeviceOrHostAddressKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Zero DeviceOrHostAddressKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure

datadata DeviceOrHostAddressConstKHR

Constructors

DeviceAddressConst DeviceAddress
HostAddressConst (Ptr ())

Instances3Show, ToCStruct, Zero

Show DeviceOrHostAddressConstKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
ToCStruct DeviceOrHostAddressConstKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Zero DeviceOrHostAddressConstKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure

newtypenewtype GeometryInstanceFlagBitsKHR

VkGeometryInstanceFlagBitsKHR - Instance flag bits

Description

GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR disables face culling for this instance.

GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR specifies 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.
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.
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.
GEOMETRY_INSTANCE_FORCE_OPACITY_MICROMAP_2_STATE_BIT_KHR forces the micromap format to 2 state mode as described in traversal.
GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_BIT_KHR disables any opacity micromaps referenced by acceleration structures referenced by this instance as described in traversal.

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

Constructors

GeometryInstanceFlagBitsKHR Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Ord GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Read GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Show GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Bits GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
FiniteBits GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Storable GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Zero GeometryInstanceFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure

patternpattern GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_BIT_KHR :: GeometryInstanceFlagBitsKHR

patternpattern GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR :: GeometryInstanceFlagBitsKHR

patternpattern GEOMETRY_INSTANCE_FORCE_OPACITY_MICROMAP_2_STATE_BIT_KHR :: GeometryInstanceFlagBitsKHR

patternpattern GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR :: GeometryInstanceFlagBitsKHR

patternpattern GEOMETRY_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT_KHR :: GeometryInstanceFlagBitsKHR

patternpattern GEOMETRY_INSTANCE_TRIANGLE_FLIP_FACING_BIT_KHR :: GeometryInstanceFlagBitsKHR

typetype GeometryInstanceFlagsKHR = GeometryInstanceFlagBitsKHR

newtypenewtype BuildAccelerationStructureFlagBitsKHR

VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds

Description

BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR specifies 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 . For sphere and LSS primitives, only positions and radii may be updated, the provided index buffers and flags must remain unchanged from the initial build.

BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR specifies 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.
BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR specifies that the given acceleration structure build should prioritize trace performance over build time.
BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR specifies that the given acceleration structure build should prioritize build time over trace performance.
BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR specifies 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.
BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_BIT_KHR specifies that the opacity micromaps associated with the specified acceleration structure may change with an acceleration structure update.
BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_BIT_EXT specifies that the data of the opacity micromaps associated with the specified acceleration structure may change with an acceleration structure update.
BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_BIT_KHR specifies that the specified acceleration structure may be referenced in an instance with GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_BIT_KHR set.
VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_CLUSTER_OPACITY_MICROMAPS_BIT_NV specifies that opacity micromaps may be associated with the given cluster acceleration structure.
BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_BIT_KHR specifies that the specified acceleration structure can be used when fetching the vertex and radius positions of a hit LSS or sphere primitive, or vertex positions of a hit triangle.
BUILD_ACCELERATION_STRUCTURE_MICROMAP_LOSSY_BIT_KHR specifies that micromaps can be compressed with a lossy encoding as described in Ray Opacity Micromap, which may support additional subdivision levels.
BUILD_ACCELERATION_STRUCTURE_ALLOW_DISPLACEMENT_MICROMAP_UPDATE_BIT_NV specifies that the displacement micromaps associated with the specified acceleration structure may change with an acceleration structure update.

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

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

Constructors

BuildAccelerationStructureFlagBitsKHR Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Ord BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Read BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Show BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Bits BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
FiniteBits BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Storable BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Zero BuildAccelerationStructureFlagBitsKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DISPLACEMENT_MICROMAP_UPDATE_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_BIT_EXT :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_MICROMAP_LOSSY_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_MOTION_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

patternpattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR

typetype BuildAccelerationStructureFlagsKHR = BuildAccelerationStructureFlagBitsKHR

newtypenewtype AccelerationStructureBuildTypeKHR

VkAccelerationStructureBuildTypeKHR - Acceleration structure build type

Description

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

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

Constructors

AccelerationStructureBuildTypeKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq AccelerationStructureBuildTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Ord AccelerationStructureBuildTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Read AccelerationStructureBuildTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Show AccelerationStructureBuildTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Storable AccelerationStructureBuildTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Zero AccelerationStructureBuildTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure

patternpattern ACCELERATION_STRUCTURE_BUILD_TYPE_DEVICE_KHR :: AccelerationStructureBuildTypeKHR

patternpattern ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_KHR :: AccelerationStructureBuildTypeKHR

patternpattern ACCELERATION_STRUCTURE_BUILD_TYPE_HOST_OR_DEVICE_KHR :: AccelerationStructureBuildTypeKHR

newtypenewtype AccelerationStructureCompatibilityKHR

VkAccelerationStructureCompatibilityKHR - Acceleration structure compatibility

Description

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

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

Constructors

AccelerationStructureCompatibilityKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq AccelerationStructureCompatibilityKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Ord AccelerationStructureCompatibilityKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Read AccelerationStructureCompatibilityKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Show AccelerationStructureCompatibilityKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Storable AccelerationStructureCompatibilityKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure
Zero AccelerationStructureCompatibilityKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_acceleration_structure

patternpattern ACCELERATION_STRUCTURE_COMPATIBILITY_COMPATIBLE_KHR :: AccelerationStructureCompatibilityKHR

patternpattern ACCELERATION_STRUCTURE_COMPATIBILITY_INCOMPATIBLE_KHR :: AccelerationStructureCompatibilityKHR

newtypenewtype OpacityMicromapFormatKHR

VkOpacityMicromapFormatKHR - Format enum for opacity micromaps

Description

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

OPACITY_MICROMAP_FORMAT_4_STATE_KHR specifies that the given micromap format has two bits per subtriangle encoding four modes which can be interpreted as described in Ray Opacity Micromap.

For compactness, these values are stored as 16-bit in some structures.

Constructors

OpacityMicromapFormatKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq OpacityMicromapFormatKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Ord OpacityMicromapFormatKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Read OpacityMicromapFormatKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Show OpacityMicromapFormatKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Storable OpacityMicromapFormatKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Zero OpacityMicromapFormatKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap

patternpattern OPACITY_MICROMAP_FORMAT_2_STATE_KHR :: OpacityMicromapFormatKHR

patternpattern OPACITY_MICROMAP_FORMAT_4_STATE_KHR :: OpacityMicromapFormatKHR

newtypenewtype OpacityMicromapSpecialIndexKHR

VkOpacityMicromapSpecialIndexKHR - Enum for special indices in the opacity micromap

Description

OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_TRANSPARENT_KHR specifies that the entire triangle is fully transparent.

OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_OPAQUE_KHR specifies that the entire triangle is fully opaque.
OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_TRANSPARENT_KHR specifies that the entire triangle is unknown-transparent.
OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_OPAQUE_KHR specifies that the entire triangle is unknown-opaque.
VK_OPACITY_MICROMAP_SPECIAL_INDEX_CLUSTER_GEOMETRY_DISABLE_OPACITY_MICROMAP_NV specifies that Opacity Micromap will be disabled for this triangle and opacity value will be picked from VkClusterAccelerationStructureBuildTriangleClusterInfoNV::baseGeometryIndexAndGeometryFlags instead. Note that this special index is only valid for Cluster Geometry.

Constructors

OpacityMicromapSpecialIndexKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq OpacityMicromapSpecialIndexKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Ord OpacityMicromapSpecialIndexKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Read OpacityMicromapSpecialIndexKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Show OpacityMicromapSpecialIndexKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Storable OpacityMicromapSpecialIndexKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap
Zero OpacityMicromapSpecialIndexKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_opacity_micromap

patternpattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_OPAQUE_KHR :: OpacityMicromapSpecialIndexKHR

patternpattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_TRANSPARENT_KHR :: OpacityMicromapSpecialIndexKHR

patternpattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_OPAQUE_KHR :: OpacityMicromapSpecialIndexKHR

patternpattern OPACITY_MICROMAP_SPECIAL_INDEX_FULLY_UNKNOWN_TRANSPARENT_KHR :: OpacityMicromapSpecialIndexKHR

patternpattern PIPELINE_CREATE_2_RAY_TRACING_OPACITY_MICROMAP_BIT_EXT :: PipelineCreateFlagBits2

Description

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage

Valid Usage (Implicit)

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also