vkCreateFramebuffer(3)

# vkCreateFramebuffer(3) Manual Page

## Name

vkCreateFramebuffer - Create a new framebuffer object

## C Specification

To create a framebuffer, call:

    VkResult vkCreateFramebuffer(
        VkDevice                                    device,
        const VkFramebufferCreateInfo*              pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkFramebuffer*                              pFramebuffer);

## Parameters

- `device` is the logical device that creates the framebuffer.

- `pCreateInfo` is a pointer to a VkFramebufferCreateInfo structure describing additional information about framebuffer creation.

- `pAllocator` controls host memory allocation as described in the Memory Allocation chapter.

- `pFramebuffer` is a pointer to a VkFramebuffer handle in which the resulting framebuffer object is returned.

## Description

Valid Usage

- If `pCreateInfo`->`flags` does not include `VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR`, and `attachmentCount` is not `0`, each element of `pCreateInfo`->`pAttachments` must have been created on `device`

Valid Usage (Implicit)

- `device` must be a valid `VkDevice` handle

- `pCreateInfo` must be a valid pointer to a valid `VkFramebufferCreateInfo` structure

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

- `pFramebuffer` must be a valid pointer to a `VkFramebuffer` handle

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

## See Also

VkAllocationCallbacks, VkDevice, VkFramebuffer, VkFramebufferCreateInfo

## 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 (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.