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