VKCREATEFRAMEBUFFER(3)

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 points to a VkFramebufferCreateInfo structure which describes additional information about framebuffer creation.

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

    • pFramebuffer points to a VkFramebuffer handle in which the resulting framebuffer object is returned.

DESCRIPTION
Valid Usage (Implicit)

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkFramebufferCreateInfo structure

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

    • pFramebuffer must be a 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 at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCreateFramebuffer

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.