VkBufferUsageFlagBits2KHR(3)

# VkBufferUsageFlagBits2KHR(3) Manual Page

## Name

VkBufferUsageFlagBits2KHR - Bitmask controlling how a pipeline is created

Loading… please wait.

## C Specification

Bits which can be set in VkBufferUsageFlags2CreateInfoKHR::`usage`, specifying usage behavior of a buffer, are:

    // Provided by VK_KHR_maintenance5
    // Flag bits for VkBufferUsageFlagBits2KHR
    typedef VkFlags64 VkBufferUsageFlagBits2KHR;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_TRANSFER_SRC_BIT_KHR = 0x00000001ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_TRANSFER_DST_BIT_KHR = 0x00000002ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR = 0x00000004ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_STORAGE_TEXEL_BUFFER_BIT_KHR = 0x00000008ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_UNIFORM_BUFFER_BIT_KHR = 0x00000010ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_STORAGE_BUFFER_BIT_KHR = 0x00000020ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_INDEX_BUFFER_BIT_KHR = 0x00000040ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_VERTEX_BUFFER_BIT_KHR = 0x00000080ULL;
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_INDIRECT_BUFFER_BIT_KHR = 0x00000100ULL;
    // Provided by VK_KHR_maintenance5 with VK_AMDX_shader_enqueue
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX = 0x02000000ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_conditional_rendering
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_CONDITIONAL_RENDERING_BIT_EXT = 0x00000200ULL;
    // Provided by VK_KHR_maintenance5 with VK_KHR_ray_tracing_pipeline
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_SHADER_BINDING_TABLE_BIT_KHR = 0x00000400ULL;
    // Provided by VK_KHR_maintenance5 with VK_NV_ray_tracing
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_RAY_TRACING_BIT_NV = 0x00000400ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_transform_feedback
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_TRANSFORM_FEEDBACK_BUFFER_BIT_EXT = 0x00000800ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_transform_feedback
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT = 0x00001000ULL;
    // Provided by VK_KHR_maintenance5 with VK_KHR_video_decode_queue
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_VIDEO_DECODE_SRC_BIT_KHR = 0x00002000ULL;
    // Provided by VK_KHR_maintenance5 with VK_KHR_video_decode_queue
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_VIDEO_DECODE_DST_BIT_KHR = 0x00004000ULL;
    #ifdef VK_ENABLE_BETA_EXTENSIONS
    // Provided by VK_KHR_maintenance5 with VK_KHR_video_encode_queue
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_VIDEO_ENCODE_DST_BIT_KHR = 0x00008000ULL;
    #endif
    #ifdef VK_ENABLE_BETA_EXTENSIONS
    // Provided by VK_KHR_maintenance5 with VK_KHR_video_encode_queue
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_VIDEO_ENCODE_SRC_BIT_KHR = 0x00010000ULL;
    #endif
    // Provided by VK_KHR_maintenance5 with (VK_VERSION_1_2 or VK_KHR_buffer_device_address) or VK_EXT_buffer_device_address
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_SHADER_DEVICE_ADDRESS_BIT_KHR = 0x00020000ULL;
    // Provided by VK_KHR_acceleration_structure with VK_KHR_maintenance5
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR = 0x00080000ULL;
    // Provided by VK_KHR_acceleration_structure with VK_KHR_maintenance5
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR = 0x00100000ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_descriptor_buffer
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT = 0x00200000ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_descriptor_buffer
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT = 0x00400000ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_descriptor_buffer
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT = 0x04000000ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_opacity_micromap
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_MICROMAP_BUILD_INPUT_READ_ONLY_BIT_EXT = 0x00800000ULL;
    // Provided by VK_KHR_maintenance5 with VK_EXT_opacity_micromap
    static const VkBufferUsageFlagBits2KHR VK_BUFFER_USAGE_2_MICROMAP_STORAGE_BIT_EXT = 0x01000000ULL;

## Description

- `VK_BUFFER_USAGE_2_TRANSFER_SRC_BIT_KHR` specifies that the buffer can be used as the source of a transfer command (see the definition of `VK_PIPELINE_STAGE_TRANSFER_BIT`).

- `VK_BUFFER_USAGE_2_TRANSFER_DST_BIT_KHR` specifies that the buffer can be used as the destination of a transfer command.

- `VK_BUFFER_USAGE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR` specifies that the buffer can be used to create a `VkBufferView` suitable for occupying a `VkDescriptorSet` slot of type `VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER`.

- `VK_BUFFER_USAGE_2_STORAGE_TEXEL_BUFFER_BIT_KHR` specifies that the buffer can be used to create a `VkBufferView` suitable for occupying a `VkDescriptorSet` slot of type `VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER`.

- `VK_BUFFER_USAGE_2_UNIFORM_BUFFER_BIT_KHR` specifies that the buffer can be used in a `VkDescriptorBufferInfo` suitable for occupying a `VkDescriptorSet` slot either of type `VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER` or `VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC`.

- `VK_BUFFER_USAGE_2_STORAGE_BUFFER_BIT_KHR` specifies that the buffer can be used in a `VkDescriptorBufferInfo` suitable for occupying a `VkDescriptorSet` slot either of type `VK_DESCRIPTOR_TYPE_STORAGE_BUFFER` or `VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC`.

- `VK_BUFFER_USAGE_2_INDEX_BUFFER_BIT_KHR` specifies that the buffer is suitable for passing as the `buffer` parameter to vkCmdBindIndexBuffer2KHR and vkCmdBindIndexBuffer.

- `VK_BUFFER_USAGE_2_VERTEX_BUFFER_BIT_KHR` specifies that the buffer is suitable for passing as an element of the `pBuffers` array to vkCmdBindVertexBuffers.

- `VK_BUFFER_USAGE_2_INDIRECT_BUFFER_BIT_KHR` specifies that the buffer is suitable for passing as the `buffer` parameter to vkCmdDrawIndirect, vkCmdDrawIndexedIndirect, vkCmdDrawMeshTasksIndirectNV, vkCmdDrawMeshTasksIndirectCountNV, `vkCmdDrawMeshTasksIndirectEXT`, `vkCmdDrawMeshTasksIndirectCountEXT`, vkCmdDrawClusterIndirectHUAWEI, or vkCmdDispatchIndirect. It is also suitable for passing as the `buffer` member of `VkIndirectCommandsStreamNV`, or `sequencesCountBuffer` or `sequencesIndexBuffer` or `preprocessedBuffer` member of `VkGeneratedCommandsInfoNV`

- `VK_BUFFER_USAGE_2_CONDITIONAL_RENDERING_BIT_EXT` specifies that the buffer is suitable for passing as the `buffer` parameter to vkCmdBeginConditionalRenderingEXT.

- `VK_BUFFER_USAGE_2_TRANSFORM_FEEDBACK_BUFFER_BIT_EXT` specifies that the buffer is suitable for using for binding as a transform feedback buffer with vkCmdBindTransformFeedbackBuffersEXT.

- `VK_BUFFER_USAGE_2_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT` specifies that the buffer is suitable for using as a counter buffer with vkCmdBeginTransformFeedbackEXT and vkCmdEndTransformFeedbackEXT.

- `VK_BUFFER_USAGE_2_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT` specifies that the buffer is suitable to contain sampler and combined image sampler descriptors when bound as a descriptor buffer. Buffers containing combined image sampler descriptors must also specify `VK_BUFFER_USAGE_2_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT`.

- `VK_BUFFER_USAGE_2_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT` specifies that the buffer is suitable to contain resource descriptors when bound as a descriptor buffer.

- `VK_BUFFER_USAGE_2_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT` specifies that the buffer, when bound, can be used by the implementation to support push descriptors when using descriptor buffers.

- `VK_BUFFER_USAGE_2_RAY_TRACING_BIT_NV` specifies that the buffer is suitable for use in vkCmdTraceRaysNV.

- `VK_BUFFER_USAGE_2_SHADER_BINDING_TABLE_BIT_KHR` specifies that the buffer is suitable for use as a Shader Binding Table.

- `VK_BUFFER_USAGE_2_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT_KHR` specifies that the buffer is suitable for use as a read-only input to an acceleration structure build.

- `VK_BUFFER_USAGE_2_ACCELERATION_STRUCTURE_STORAGE_BIT_KHR` specifies that the buffer is suitable for storage space for a VkAccelerationStructureKHR.

- `VK_BUFFER_USAGE_2_SHADER_DEVICE_ADDRESS_BIT_KHR` specifies that the buffer can be used to retrieve a buffer device address via vkGetBufferDeviceAddress and use that address to access the buffer’s memory from a shader.

- `VK_BUFFER_USAGE_2_VIDEO_DECODE_SRC_BIT_KHR` specifies that the buffer can be used as the source video bitstream buffer in a video decode operation.

- `VK_BUFFER_USAGE_2_VIDEO_DECODE_DST_BIT_KHR` is reserved for future use.

- `VK_BUFFER_USAGE_2_VIDEO_ENCODE_DST_BIT_KHR` specifies that the buffer can be used as the destination video bitstream buffer in a video encode operation.

- `VK_BUFFER_USAGE_2_VIDEO_ENCODE_SRC_BIT_KHR` is reserved for future use.

- `VK_BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX` specifies that the buffer can be used for as scratch memory for execution graph dispatch.

## See Also

VK_KHR_maintenance5

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0