54 lines
2.1 KiB
Plaintext
54 lines
2.1 KiB
Plaintext
// Copyright (c) 2014-2019 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
[[platformCreateSurface_imagepipe,platformCreateSurface_imagepipe]]
|
|
|
|
=== Fuchsia Platform
|
|
|
|
[open,refpage='vkCreateImagePipeSurfaceFUCHSIA',desc='Create a slink:VkSurfaceKHR object for a Fuchsia ImagePipe',type='protos']
|
|
--
|
|
|
|
To create a sname:VkSurfaceKHR object for a Fuchsia ImagePipe, call:
|
|
|
|
include::../../api/protos/vkCreateImagePipeSurfaceFUCHSIA.txt[]
|
|
|
|
* pname:instance is the instance to associate with the surface.
|
|
* pname:pCreateInfo is a pointer to an instance of the
|
|
slink:VkImagePipeSurfaceCreateInfoFUCHSIA structure containing
|
|
parameters affecting the creation of the surface object.
|
|
* pname:pAllocator is the allocator used for host memory allocated for the
|
|
surface object when there is no more specific allocator available (see
|
|
<<memory-allocation,Memory Allocation>>).
|
|
* pname:pSurface points to a slink:VkSurfaceKHR handle in which the
|
|
created surface object is returned.
|
|
|
|
include::../../validity/protos/vkCreateImagePipeSurfaceFUCHSIA.txt[]
|
|
--
|
|
|
|
[open,refpage='VkImagePipeSurfaceCreateInfoFUCHSIA',desc='Structure specifying parameters of a newly created ImagePipe surface object',type='structs']
|
|
--
|
|
|
|
The sname:VkImagePipeSurfaceCreateInfoFUCHSIA structure is defined as:
|
|
|
|
include::../../api/structs/VkImagePipeSurfaceCreateInfoFUCHSIA.txt[]
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:flags is reserved for future use.
|
|
* pname:imagePipeHandle is a code:zx_handle_t referring to the ImagePipe
|
|
to associate with the surface.
|
|
|
|
.Valid Usage
|
|
****
|
|
* [[VUID-VkImagePipeSurfaceCreateInfoFUCHSIA-imagePipeHandle-00000]]
|
|
pname:imagePipeHandle must: be a valid code:zx_handle_t
|
|
****
|
|
|
|
include::../../validity/structs/VkImagePipeSurfaceCreateInfoFUCHSIA.txt[]
|
|
--
|
|
|
|
On Fuchsia, the surface pname:currentExtent is the special value
|
|
[eq]#(0xFFFFFFFF, 0xFFFFFFFF)#, indicating that the surface size will be
|
|
determined by the extent of a swapchain targeting the surface.
|