Vulkan.Core10.BufferView

vkCreateBufferView - Create a new buffer view object

Valid Usage

• device must support at least one queue family with one of the QUEUE_COMPUTE_BIT or QUEUE_GRAPHICS_BIT capabilities

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid BufferViewCreateInfo structure

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• pView must be a valid pointer to a BufferView handle

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, AllocationCallbacks, BufferView, BufferViewCreateInfo, Device

A convenience wrapper to make a compatible pair of calls to createBufferView and destroyBufferView

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

vkDestroyBufferView - Destroy a buffer view object

Valid Usage

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

• If AllocationCallbacks were provided when bufferView was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when bufferView was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If bufferView is not NULL_HANDLE, bufferView must be a valid BufferView handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• If bufferView is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to bufferView must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, BufferView, Device

VkBufferViewCreateInfo - Structure specifying parameters of a newly created buffer view

Description

The buffer view has a buffer view usage identifying which descriptor types can be created from it. This usage can be defined by including the BufferUsageFlags2CreateInfo structure in the pNext chain, and specifying the usage value there. If this structure is not included, it is equal to the BufferCreateInfo::usage value used to create buffer.

Valid Usage

• offset must be less than the size of buffer

• If range is not equal to WHOLE_SIZE, range must be greater than 0

• If range is not equal to WHOLE_SIZE, range must be an integer multiple of the texel block size of format

• If range is not equal to WHOLE_SIZE, the number of texel buffer elements given by (⌊range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for format, must be less than or equal to PhysicalDeviceLimits::maxTexelBufferElements

• If range is not equal to WHOLE_SIZE, the sum of offset and range must be less than or equal to the size of buffer

• If range is equal to WHOLE_SIZE, the number of texel buffer elements given by (⌊(size - offset) / (texel block size)⌋ × (texels per block)) where size is the size of buffer, and texel block size and texels per block are as defined in the Compatible Formats table for format, must be less than or equal to PhysicalDeviceLimits::maxTexelBufferElements

• buffer must have been created with at least one of the BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT usage flags set

• If the buffer view usage contains BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, then format features of format must contain FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT

• If the buffer view usage contains BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, then format features of format must contain FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT

• If buffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object

• If buffer was created with the BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT usage flag set, offset must be a multiple of the effective alignment requirement of format for DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER as defined by minTexelBufferOffsetAlignment

• If buffer was created with the BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT usage flag set, offset must be a multiple of the effective alignment requirement of format for DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER as defined by minTexelBufferOffsetAlignment

• If the pNext chain includes a ExportMetalObjectCreateInfoEXT structure, its exportObjectType member must be EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT

• If the pNext chain includes a BufferUsageFlags2CreateInfo, its usage must not contain any other bit than BUFFER_USAGE_2_UNIFORM_TEXEL_BUFFER_BIT or BUFFER_USAGE_2_STORAGE_TEXEL_BUFFER_BIT

• If the pNext chain includes a BufferUsageFlags2CreateInfo, its usage must be a subset of the BufferCreateInfo::usage specified or BufferUsageFlags2CreateInfo::usage from BufferCreateInfo::pNext when creating buffer

• If Vulkan 1.3 is not supported and the ycbcr2plane444Formats feature is not enabled, format must not be FORMAT_G8_B8R8_2PLANE_444_UNORM, FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16, FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16, or FORMAT_G16_B16R16_2PLANE_444_UNORM

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of BufferUsageFlags2CreateInfo or ExportMetalObjectCreateInfoEXT

• The sType value of each structure in the pNext chain must be unique, with the exception of structures of type ExportMetalObjectCreateInfoEXT

• flags must be 0

• buffer must be a valid Buffer handle

• format must be a valid Format value

See Also

VK_VERSION_1_0, Buffer, BufferViewCreateFlags, DeviceSize, Format, StructureType, createBufferView

VkBufferView - Opaque handle to a buffer view object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, ExportMetalTextureInfoEXT, WriteDescriptorSet, createBufferView, destroyBufferView

VkBufferViewCreateFlags - Reserved for future use

Description

BufferViewCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_VERSION_1_0, BufferViewCreateInfo, Flags