C Specification

To set the constraints on a VkBuffer buffer collection, call:

// Provided by VK_FUCHSIA_buffer_collection
VkResult vkSetBufferCollectionBufferConstraintsFUCHSIA(
    VkDevice                                    device,
    VkBufferCollectionFUCHSIA                   collection,
    const VkBufferConstraintsInfoFUCHSIA*       pBufferConstraintsInfo);

Parameters

Description

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

Valid Usage

  • VUID-vkSetBufferCollectionBufferConstraintsFUCHSIA-collection-06403
    vkSetBufferCollectionImageConstraintsFUCHSIA or vkSetBufferCollectionBufferConstraintsFUCHSIA must not have already been called on collection

Valid Usage (Implicit)

  • VUID-vkSetBufferCollectionBufferConstraintsFUCHSIA-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkSetBufferCollectionBufferConstraintsFUCHSIA-collection-parameter
    collection must be a valid VkBufferCollectionFUCHSIA handle

  • VUID-vkSetBufferCollectionBufferConstraintsFUCHSIA-pBufferConstraintsInfo-parameter
    pBufferConstraintsInfo must be a valid pointer to a valid VkBufferConstraintsInfoFUCHSIA structure

  • VUID-vkSetBufferCollectionBufferConstraintsFUCHSIA-collection-parent
    collection must have been created, allocated, or retrieved from device

Return Codes
On success, this command returns

  • VK_SUCCESS

On failure, this command returns

  • VK_ERROR_INITIALIZATION_FAILED

  • VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_FORMAT_NOT_SUPPORTED

See Also

VK_FUCHSIA_buffer_collection, VkBufferCollectionFUCHSIA, VkBufferConstraintsInfoFUCHSIA, VkDevice

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