vkCreateBufferCollectionFUCHSIA(3)

# vkCreateBufferCollectionFUCHSIA(3) Manual Page

## Name

vkCreateBufferCollectionFUCHSIA - Create a new buffer collection

Loading… please wait.

## C Specification

To create an VkBufferCollectionFUCHSIA for Vulkan to participate in the buffer collection:

    // Provided by VK_FUCHSIA_buffer_collection
    VkResult vkCreateBufferCollectionFUCHSIA(
        VkDevice                                    device,
        const VkBufferCollectionCreateInfoFUCHSIA*  pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkBufferCollectionFUCHSIA*                  pCollection);

## Parameters

- `device` is the logical device that creates the `VkBufferCollectionFUCHSIA`

- `pCreateInfo` is a pointer to a VkBufferCollectionCreateInfoFUCHSIA structure containing parameters affecting creation of the buffer collection

- `pAllocator` is a pointer to a VkAllocationCallbacks structure controlling host memory allocation as described in the Memory Allocation chapter

- `pBufferCollection` is a pointer to a VkBufferCollectionFUCHSIA handle in which the resulting buffer collection object is returned

## Description

Valid Usage (Implicit)

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

- VUID-vkCreateBufferCollectionFUCHSIA-pCreateInfo-parameter
  `pCreateInfo` must be a valid pointer to a valid VkBufferCollectionCreateInfoFUCHSIA structure

- VUID-vkCreateBufferCollectionFUCHSIA-pAllocator-parameter
  If `pAllocator` is not `NULL`, `pAllocator` must be a valid pointer to a valid VkAllocationCallbacks structure

- VUID-vkCreateBufferCollectionFUCHSIA-pCollection-parameter
  `pCollection` must be a valid pointer to a VkBufferCollectionFUCHSIA handle

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_INVALID_EXTERNAL_HANDLE`

  - `VK_ERROR_INITIALIZATION_FAILED`

Host Access

All functions referencing a VkBufferCollectionFUCHSIA must be externally synchronized with the exception of `vkCreateBufferCollectionFUCHSIA`.

## See Also

VK_FUCHSIA_buffer_collection, VkAllocationCallbacks, VkBufferCollectionCreateInfoFUCHSIA, VkBufferCollectionFUCHSIA, 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