Vulkan.Extensions.VK_FUCHSIA_buffer_collection

vkCreateBufferCollectionFUCHSIA - Create a new buffer collection

Valid Usage (Implicit)

• device must be a valid Device handle

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

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

• pCollection must be a valid pointer to a BufferCollectionFUCHSIA handle

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED

• ERROR_INVALID_EXTERNAL_HANDLE

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

Host Access

All functions referencing a BufferCollectionFUCHSIA must be externally synchronized with the exception of createBufferCollectionFUCHSIA.

See Also

VK_FUCHSIA_buffer_collection, AllocationCallbacks, BufferCollectionCreateInfoFUCHSIA, BufferCollectionFUCHSIA, Device

A convenience wrapper to make a compatible pair of calls to createBufferCollectionFUCHSIA and destroyBufferCollectionFUCHSIA

To ensure that destroyBufferCollectionFUCHSIA 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.

vkSetBufferCollectionBufferConstraintsFUCHSIA - Set buffer-based constraints for a buffer collection

Description

setBufferCollectionBufferConstraintsFUCHSIA may fail if the implementation does not support the constraints specified in the bufferCollectionConstraints structure. If that occurs, setBufferCollectionBufferConstraintsFUCHSIA will return ERROR_FORMAT_NOT_SUPPORTED.

Return Codes

Success

• SUCCESS

Failure

• ERROR_FORMAT_NOT_SUPPORTED

• ERROR_INITIALIZATION_FAILED

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionFUCHSIA, BufferConstraintsInfoFUCHSIA, Device

vkSetBufferCollectionImageConstraintsFUCHSIA - Set image-based constraints for a buffer collection

Description

setBufferCollectionImageConstraintsFUCHSIA may fail if pImageConstraintsInfo->formatConstraintsCount is larger than the implementation-defined limit. If that occurs, setBufferCollectionImageConstraintsFUCHSIA will return ERROR_INITIALIZATION_FAILED.

setBufferCollectionImageConstraintsFUCHSIA may fail if the implementation does not support any of the formats described by the pImageConstraintsInfo structure. If that occurs, setBufferCollectionImageConstraintsFUCHSIA will return ERROR_FORMAT_NOT_SUPPORTED.

Return Codes

Success

• SUCCESS

Failure

• ERROR_FORMAT_NOT_SUPPORTED

• ERROR_INITIALIZATION_FAILED

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionFUCHSIA, Device, ImageConstraintsInfoFUCHSIA

vkDestroyBufferCollectionFUCHSIA - Destroy a buffer collection

Valid Usage

• Image and Buffer objects that referenced collection upon creation by inclusion of a BufferCollectionImageCreateInfoFUCHSIA or BufferCollectionBufferCreateInfoFUCHSIA chained to their ImageCreateInfo or BufferCreateInfo structures respectively, may outlive collection

Valid Usage (Implicit)

• device must be a valid Device handle

• collection must be a valid BufferCollectionFUCHSIA handle

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

• collection must have been created, allocated, or retrieved from device

See Also

VK_FUCHSIA_buffer_collection, AllocationCallbacks, BufferCollectionFUCHSIA, Device

vkGetBufferCollectionPropertiesFUCHSIA - Retrieve properties from a buffer collection

Description

For image-based buffer collections, upon calling getBufferCollectionPropertiesFUCHSIA, Sysmem will choose an element of the ImageConstraintsInfoFUCHSIA::pImageCreateInfos established by the preceding call to setBufferCollectionImageConstraintsFUCHSIA. The index of the element chosen is stored in and can be retrieved from BufferCollectionPropertiesFUCHSIA::createInfoIndex.

For buffer-based buffer collections, a single BufferCreateInfo is specified as BufferConstraintsInfoFUCHSIA::createInfo. BufferCollectionPropertiesFUCHSIA::createInfoIndex will therefore always be zero.

getBufferCollectionPropertiesFUCHSIA may fail if Sysmem is unable to resolve the constraints of all of the participants in the buffer collection. If that occurs, getBufferCollectionPropertiesFUCHSIA will return ERROR_INITIALIZATION_FAILED.

Valid Usage

• Prior to calling getBufferCollectionPropertiesFUCHSIA, the constraints on the buffer collection must have been set by either setBufferCollectionImageConstraintsFUCHSIA or setBufferCollectionBufferConstraintsFUCHSIA

Valid Usage (Implicit)

• device must be a valid Device handle

• collection must be a valid BufferCollectionFUCHSIA handle

• pProperties must be a valid pointer to a BufferCollectionPropertiesFUCHSIA structure

• collection must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionFUCHSIA, BufferCollectionPropertiesFUCHSIA, Device

VkImportMemoryBufferCollectionFUCHSIA - Structure to specify the Sysmem buffer to import

Structure Chaining

Extends the structure

• MemoryAllocateInfo

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionFUCHSIA, StructureType

VkBufferCollectionImageCreateInfoFUCHSIA - Create a VkBufferCollectionFUCHSIA-compatible VkImage

Structure Chaining

Extends the structure

• ImageCreateInfo

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionFUCHSIA, StructureType

VkBufferCollectionBufferCreateInfoFUCHSIA - Create a VkBufferCollectionFUCHSIA-compatible VkBuffer

Structure Chaining

Extends the structure

• BufferCreateInfo

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionFUCHSIA, StructureType

VkBufferCollectionCreateInfoFUCHSIA - Structure specifying desired parameters to create the buffer collection

Valid Usage (Implicit)

See Also

VK_FUCHSIA_buffer_collection, StructureType, createBufferCollectionFUCHSIA

VkBufferCollectionPropertiesFUCHSIA - Structure specifying the negotiated format chosen by Sysmem

Description

sysmemColorSpace is only set for image-based buffer collections where the constraints were specified using ImageConstraintsInfoFUCHSIA in a call to setBufferCollectionImageConstraintsFUCHSIA.

For image-based buffer collections, createInfoIndex will identify both the ImageConstraintsInfoFUCHSIA::pImageCreateInfos element and the ImageConstraintsInfoFUCHSIA::pFormatConstraints element chosen by Sysmem when setBufferCollectionImageConstraintsFUCHSIA was called. The value of sysmemColorSpaceIndex will be an index to one of the color spaces provided in the ImageFormatConstraintsInfoFUCHSIA::pColorSpaces array.

The implementation must have formatFeatures with all bits set that were set in ImageFormatConstraintsInfoFUCHSIA::requiredFormatFeatures, by the call to setBufferCollectionImageConstraintsFUCHSIA, at createInfoIndex (other bits could be set as well).

Valid Usage (Implicit)

See Also

VK_FUCHSIA_buffer_collection, ChromaLocation, ComponentMapping, FormatFeatureFlags, SamplerYcbcrModelConversion, SamplerYcbcrRange, StructureType, SysmemColorSpaceFUCHSIA, getBufferCollectionPropertiesFUCHSIA

VkBufferConstraintsInfoFUCHSIA - Structure buffer-based buffer collection constraints

Valid Usage

• The requiredFormatFeatures bitmask of FormatFeatureFlagBits must be chosen from among the buffer compatible format features listed in buffer compatible format features

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_CONSTRAINTS_INFO_FUCHSIA

• pNext must be NULL

• createInfo must be a valid BufferCreateInfo structure

• requiredFormatFeatures must be a valid combination of FormatFeatureFlagBits values

• bufferCollectionConstraints must be a valid BufferCollectionConstraintsInfoFUCHSIA structure

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionConstraintsInfoFUCHSIA, BufferCreateInfo, FormatFeatureFlags, StructureType, setBufferCollectionBufferConstraintsFUCHSIA

VkSysmemColorSpaceFUCHSIA - Structure describing the buffer collections color space

Valid Usage (Implicit)

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionPropertiesFUCHSIA, ImageFormatConstraintsInfoFUCHSIA, StructureType

VkImageFormatConstraintsInfoFUCHSIA - Structure image-based buffer collection constraints

Valid Usage (Implicit)

See Also

VK_FUCHSIA_buffer_collection, FormatFeatureFlags, ImageConstraintsInfoFUCHSIA, ImageCreateInfo, ImageFormatConstraintsFlagsFUCHSIA, StructureType, SysmemColorSpaceFUCHSIA

VkImageConstraintsInfoFUCHSIA - Structure of image-based buffer collection constraints

Valid Usage

• All elements of pFormatConstraints must have at least one bit set in its ImageFormatConstraintsInfoFUCHSIA::requiredFormatFeatures

• If pFormatConstraints->imageCreateInfo->usage contains IMAGE_USAGE_SAMPLED_BIT, then pFormatConstraints->requiredFormatFeatures must contain FORMAT_FEATURE_SAMPLED_IMAGE_BIT

• If pFormatConstraints->imageCreateInfo->usage contains IMAGE_USAGE_STORAGE_BIT, then pFormatConstraints->requiredFormatFeatures must contain FORMAT_FEATURE_STORAGE_IMAGE_BIT

• If pFormatConstraints->imageCreateInfo->usage contains IMAGE_USAGE_COLOR_ATTACHMENT_BIT, then pFormatConstraints->requiredFormatFeatures must contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT

• If pFormatConstraints->imageCreateInfo->usage contains IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, then pFormatConstraints->requiredFormatFeatures must contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT

• If pFormatConstraints->imageCreateInfo->usage contains IMAGE_USAGE_INPUT_ATTACHMENT_BIT, then pFormatConstraints->requiredFormatFeatures must contain at least one of FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT

• If the attachmentFragmentShadingRate feature is enabled, and pFormatConstraints->imageCreateInfo->usage contains IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, then pFormatConstraints->requiredFormatFeatures must contain FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_CONSTRAINTS_INFO_FUCHSIA

• pNext must be NULL

• pFormatConstraints must be a valid pointer to an array of formatConstraintsCount valid ImageFormatConstraintsInfoFUCHSIA structures

• bufferCollectionConstraints must be a valid BufferCollectionConstraintsInfoFUCHSIA structure

• flags must be a valid combination of ImageConstraintsInfoFlagBitsFUCHSIA values

• formatConstraintsCount must be greater than 0

See Also

VK_FUCHSIA_buffer_collection, BufferCollectionConstraintsInfoFUCHSIA, ImageConstraintsInfoFlagsFUCHSIA, ImageFormatConstraintsInfoFUCHSIA, StructureType, setBufferCollectionImageConstraintsFUCHSIA

VkBufferCollectionConstraintsInfoFUCHSIA - Structure of general buffer collection constraints

Description

Sysmem uses all buffer count parameters in combination to determine the number of buffers it will allocate. Sysmem defines buffer count constraints in fuchsia.sysmem/constraints.fidl.

Camping as referred to by minBufferCountForCamping, is the number of buffers that should be available for the participant that are not for transient use. This number of buffers is required for the participant to logically operate.

Slack as referred to by minBufferCountForDedicatedSlack and minBufferCountForSharedSlack, refers to the number of buffers desired by participants for optimal performance. minBufferCountForDedicatedSlack refers to the current participant. minBufferCountForSharedSlack refers to buffer slack for all participants in the collection.

Valid Usage (Implicit)

See Also

VK_FUCHSIA_buffer_collection, BufferConstraintsInfoFUCHSIA, ImageConstraintsInfoFUCHSIA, StructureType

VkImageFormatConstraintsFlagsFUCHSIA - Reserved for future use

Description

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

See Also

VK_FUCHSIA_buffer_collection, Flags, ImageFormatConstraintsInfoFUCHSIA

VkImageConstraintsInfoFlagBitsFUCHSIA - Bitmask specifying image constraints flags

Description

General hints about the type of memory that should be allocated by Sysmem based on the expected usage of the images in the buffer collection include:

• IMAGE_CONSTRAINTS_INFO_CPU_READ_RARELY_FUCHSIA

• IMAGE_CONSTRAINTS_INFO_CPU_READ_OFTEN_FUCHSIA

• IMAGE_CONSTRAINTS_INFO_CPU_WRITE_RARELY_FUCHSIA

• IMAGE_CONSTRAINTS_INFO_CPU_WRITE_OFTEN_FUCHSIA

For protected memory:

• IMAGE_CONSTRAINTS_INFO_PROTECTED_OPTIONAL_FUCHSIA specifies that protected memory is optional for the buffer collection.

Note that if all participants in the buffer collection (Vulkan or otherwise) specify that protected memory is optional, Sysmem will not allocate protected memory.

See Also

VK_FUCHSIA_buffer_collection, ImageConstraintsInfoFlagsFUCHSIA

VkBufferCollectionFUCHSIA - Opaque handle to a buffer collection object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_FUCHSIA_buffer_collection, BufferCollectionBufferCreateInfoFUCHSIA, BufferCollectionImageCreateInfoFUCHSIA, ImportMemoryBufferCollectionFUCHSIA, createBufferCollectionFUCHSIA, destroyBufferCollectionFUCHSIA, getBufferCollectionPropertiesFUCHSIA, setBufferCollectionBufferConstraintsFUCHSIA, setBufferCollectionImageConstraintsFUCHSIA

VkDebugReportObjectTypeEXT - Specify the type of an object handle

Description

'

DebugReportObjectTypeEXT and Vulkan Handle Relationship

The primary expected use of ERROR_VALIDATION_FAILED_EXT is for validation layer testing to prevent invalid commands from reaching the ICD. It is not expected that an application would see this error code during normal use of the validation layers. If an application returns TRUE in DebugUtilsMessengerCallbackDataEXT, the validation layers will return this error code instead of passing the command down the dispatch chain.

See Also

PFN_vkDebugReportCallbackEXT, VK_EXT_debug_marker, VK_EXT_debug_report, DebugMarkerObjectNameInfoEXT, DebugMarkerObjectTagInfoEXT, debugReportMessageEXT