Vulkan-Docs/doc/specs/vulkan/man/vkCreateFramebuffer.txt

58 lines
1.4 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkCreateFramebuffer(3)
======================
Name
----
vkCreateFramebuffer - Create a new framebuffer object.
C Specification
---------------
// refBegin vkCreateFramebuffer Create a new framebuffer object.
To create a framebuffer, call:
include::../protos/vkCreateFramebuffer.txt[]
Parameters
----------
* pname:device is the logical device that creates the framebuffer.
* pname:pCreateInfo points to a slink:VkFramebufferCreateInfo structure
which describes additional information about framebuffer creation.
* pname:pAllocator controls host memory allocation as described in the
<<memory-allocation, Memory Allocation>> chapter.
* pname:pFramebuffer points to a sname:VkFramebuffer handle in which the
resulting framebuffer object is returned.
Description
-----------
include::../validity/protos/vkCreateFramebuffer.txt[]
See Also
--------
slink:VkAllocationCallbacks, slink:VkDevice, slink:VkFramebuffer, slink: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.
include::footer.txt[]