1// Copyright 2014-2023 The Khronos Group Inc.
2//
3// SPDX-License-Identifier: CC-BY-4.0
4
5[[platformCreateSurface_imagepipe]]
6=== Fuchsia Platform
7
8[open,refpage='vkCreateImagePipeSurfaceFUCHSIA',desc='Create a slink:VkSurfaceKHR object for a Fuchsia ImagePipe',type='protos']
9--
10:refpage: vkCreateImagePipeSurfaceFUCHSIA
11
12To create a sname:VkSurfaceKHR object for a Fuchsia ImagePipe, call:
13
14include::{generated}/api/protos/vkCreateImagePipeSurfaceFUCHSIA.adoc[]
15
16  * pname:instance is the instance to associate with the surface.
17  * pname:pCreateInfo is a pointer to a
18    slink:VkImagePipeSurfaceCreateInfoFUCHSIA structure containing
19    parameters affecting the creation of the surface object.
20  * pname:pAllocator is the allocator used for host memory allocated for the
21    surface object when there is no more specific allocator available (see
22    <<memory-allocation,Memory Allocation>>).
23  * pname:pSurface is a pointer to a slink:VkSurfaceKHR handle in which the
24    created surface object is returned.
25
26include::{generated}/validity/protos/vkCreateImagePipeSurfaceFUCHSIA.adoc[]
27--
28
29[open,refpage='VkImagePipeSurfaceCreateInfoFUCHSIA',desc='Structure specifying parameters of a newly created ImagePipe surface object',type='structs']
30--
31The sname:VkImagePipeSurfaceCreateInfoFUCHSIA structure is defined as:
32
33include::{generated}/api/structs/VkImagePipeSurfaceCreateInfoFUCHSIA.adoc[]
34
35  * pname:sType is a elink:VkStructureType value identifying this structure.
36  * pname:pNext is `NULL` or a pointer to a structure extending this
37    structure.
38  * pname:flags is reserved for future use.
39  * pname:imagePipeHandle is a code:zx_handle_t referring to the ImagePipe
40    to associate with the surface.
41
42.Valid Usage
43****
44  * [[VUID-VkImagePipeSurfaceCreateInfoFUCHSIA-imagePipeHandle-04863]]
45    pname:imagePipeHandle must: be a valid code:zx_handle_t
46****
47
48include::{generated}/validity/structs/VkImagePipeSurfaceCreateInfoFUCHSIA.adoc[]
49--
50
51On Fuchsia, the surface pname:currentExtent is the special value
52[eq]#(0xFFFFFFFF, 0xFFFFFFFF)#, indicating that the surface size will be
53determined by the extent of a swapchain targeting the surface.
54
55[open,refpage='VkImagePipeSurfaceCreateFlagsFUCHSIA',desc='Reserved for future use',type='flags']
56--
57include::{generated}/api/flags/VkImagePipeSurfaceCreateFlagsFUCHSIA.adoc[]
58
59tname:VkImagePipeSurfaceCreateFlagsFUCHSIA is a bitmask type for setting a
60mask, but is currently reserved for future use.
61--
62