mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-27 14:45:55 +00:00
53 lines
1.6 KiB
Plaintext
53 lines
1.6 KiB
Plaintext
|
vkCreateFramebuffer(3)
|
||
|
|
======================
|
||
|
|
|
||
|
|
Name
|
||
|
|
----
|
||
|
|
vkCreateFramebuffer - Create a new framebuffer object.
|
||
|
|
|
||
|
|
C Specification
|
||
|
|
---------------
|
||
|
|
|
||
|
|
include::../protos/vkCreateFramebuffer.txt[]
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
|
||
|
|
pname:device::
|
||
|
|
The device with which to create the framebuffer object.
|
||
|
|
|
||
|
|
pname:pCreateInfo::
|
||
|
|
A pointer to a structure containing information about how to create the object.
|
||
|
|
|
||
|
|
pname:pFramebuffer::
|
||
|
|
A pointer to a variable which will receive the handle to the new object.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
fname:vkCreateFramebuffer creates a new framebuffer object using the information contained in
|
||
|
|
pname:pCreateInfo and the device specified in pname:device. Upon success, a handle to
|
||
|
|
the new framebuffer object is deposited in the variable pointed to by pname:pFramebuffer.
|
||
|
|
pname:pCreateInfo should point to an instance of the slink:VkFramebufferCreateInfo structure,
|
||
|
|
the definition of which is:
|
||
|
|
|
||
|
|
include::../structs/VkFramebufferCreateInfo.txt[]
|
||
|
|
|
||
|
|
The attachments in pname:pAttachments correspond in order to the attachment descriptions
|
||
|
|
in the pname:renderPass. The attachment view must have the same format, sample count,
|
||
|
|
and initial layout as the render pass's attachment description. All attachment views
|
||
|
|
must also have dimensions at least as large as the framebuffer's pname:width,
|
||
|
|
pname:height, and pname:layers.
|
||
|
|
|
||
|
|
The framebuffer may be used in combination with any render pass that has the same
|
||
|
|
attachment count, and corresponding attachments have the same format and sample count.
|
||
|
|
|
||
|
|
include::../validity/protos/vkCreateFramebuffer.txt[]
|
||
|
|
|
||
|
|
See Also
|
||
|
|
--------
|
||
|
|
|
||
|
|
flink:vkCmdBeginRenderPass, flink:vkDestroyFramebuffer
|
||
|
|
|
||
|
|
include::footer.txt[]
|