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

75 lines
1.8 KiB
Plaintext

VkImageCreateInfo(3)
====================
Name
----
VkImageCreateInfo - Structure specifying the parameters of a newly created image object.
C Specification
---------------
include::../structs/VkImageCreateInfo.txt[]
Fields
------
pname:sType::
Structure type. Must be ename:VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO.
pname:pNext::
Pointer to next structure in the structure chain when applicable.
pname:imageType::
Type of the image (see elink:VkImageType for more detail).
pname:format::
Format of the texels of the image (see elink:VkFormat for more detail).
pname:extent::
Width, height, and depth of the image in texels.
pname:mipLevels::
Number of mip levels of the image.
pname:arrayLayers::
Number of layers of the image.
pname:samples::
Number of samples of the image.
pname:tiling::
Image tiling mode of the image (see elink:VkImageTiling for more detail).
pname:usage::
Allowed usages of the image (see elink:VkImageUsageFlags for more detail).
pname:flags::
Other properties of the image (see elink:VkImageCreateFlags for more detail).
pname:sharingMode::
Sharing mode used for the image (see elink:VkSharingMode for more detail).
pname:queueFamilyIndexCount::
Number of queue families that can access the image in case
pname:sharingMode is ename:VK_SHARING_MODE_CONCURRENT.
pname:pQueueFamilyIndices::
Array of pname:queueFamilyIndexCount queue family indices specifying the
set of queue families that can access the image in case
pname:sharingMode is ename:VK_SHARING_MODE_CONCURRENT.
Description
-----------
This structure is used to specify the parameters of image objects created using
flink:vkCreateImage.
include::../validity/structs/VkImageCreateInfo.txt[]
See Also
--------
flink:vkCreateImage
include::footer.txt[]