vkSetBufferCollectionImageConstraintsFUCHSIA(3)

# vkSetBufferCollectionImageConstraintsFUCHSIA(3) Manual Page

## Name

vkSetBufferCollectionImageConstraintsFUCHSIA - Set image-based constraints for a buffer collection

Loading… please wait.

## C Specification

Setting the constraints on the buffer collection initiates the format negotiation and allocation of the buffer collection. To set the constraints on a VkImage buffer collection, call:

    // Provided by VK_FUCHSIA_buffer_collection
    VkResult vkSetBufferCollectionImageConstraintsFUCHSIA(
        VkDevice                                    device,
        VkBufferCollectionFUCHSIA                   collection,
        const VkImageConstraintsInfoFUCHSIA*        pImageConstraintsInfo);

## Parameters

- `device` is the logical device

- `collection` is the VkBufferCollectionFUCHSIA handle

- `pImageConstraintsInfo` is a pointer to a VkImageConstraintsInfoFUCHSIA structure

## Description

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

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

Valid Usage

- VUID-vkSetBufferCollectionImageConstraintsFUCHSIA-collection-06394
  `vkSetBufferCollectionImageConstraintsFUCHSIA` or `vkSetBufferCollectionBufferConstraintsFUCHSIA` must not have already been called on `collection`

Valid Usage (Implicit)

- VUID-vkSetBufferCollectionImageConstraintsFUCHSIA-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkSetBufferCollectionImageConstraintsFUCHSIA-collection-parameter
  `collection` must be a valid VkBufferCollectionFUCHSIA handle

- VUID-vkSetBufferCollectionImageConstraintsFUCHSIA-pImageConstraintsInfo-parameter
  `pImageConstraintsInfo` must be a valid pointer to a valid VkImageConstraintsInfoFUCHSIA structure

- VUID-vkSetBufferCollectionImageConstraintsFUCHSIA-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_FORMAT_NOT_SUPPORTED

  - VK_ERROR_INITIALIZATION_FAILED

  - VK_ERROR_OUT_OF_HOST_MEMORY

  - VK_ERROR_UNKNOWN

  - VK_ERROR_VALIDATION_FAILED

## See Also

VK_FUCHSIA_buffer_collection, VkBufferCollectionFUCHSIA, VkDevice, VkImageConstraintsInfoFUCHSIA

## 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-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0