1// Copyright (c) 2021 BlackBerry Limited.
2//
3// SPDX-License-Identifier: CC-BY-4.0
4
5[[platformCreateSurface_screen]]
6=== QNX Screen Platform
7
8[open,refpage='vkCreateScreenSurfaceQNX',desc='Create a slink:VkSurfaceKHR object for a QNX Screen window',type='protos']
9--
10To create a sname:VkSurfaceKHR object for a QNX Screen surface, call:
11
12include::{generated}/api/protos/vkCreateScreenSurfaceQNX.adoc[]
13
14  * pname:instance is the instance to associate the surface with.
15  * pname:pCreateInfo is a pointer to a slink:VkScreenSurfaceCreateInfoQNX
16    structure containing parameters affecting the creation of the surface
17    object.
18  * pname:pAllocator is the allocator used for host memory allocated for the
19    surface object when there is no more specific allocator available (see
20    <<memory-allocation,Memory Allocation>>).
21  * pname:pSurface is a pointer to a slink:VkSurfaceKHR handle in which the
22    created surface object is returned.
23
24include::{generated}/validity/protos/vkCreateScreenSurfaceQNX.adoc[]
25--
26
27[open,refpage='VkScreenSurfaceCreateInfoQNX',desc='Structure specifying parameters of a newly created QNX Screen surface object',type='structs']
28--
29The sname:VkScreenSurfaceCreateInfoQNX structure is defined as:
30
31include::{generated}/api/structs/VkScreenSurfaceCreateInfoQNX.adoc[]
32
33  * pname:sType is a elink:VkStructureType value identifying this structure.
34  * pname:pNext is `NULL` or a pointer to a structure extending this
35    structure.
36  * pname:flags is reserved for future use.
37  * pname:context and pname:window are QNX Screen code:context and
38    code:window to associate the surface with.
39
40.Valid Usage
41****
42  * [[VUID-VkScreenSurfaceCreateInfoQNX-context-04741]]
43    pname:context must: point to a valid QNX Screen code:struct
44    _screen_context
45  * [[VUID-VkScreenSurfaceCreateInfoQNX-window-04742]]
46    pname:window must: point to a valid QNX Screen code:struct
47    _screen_window
48****
49
50include::{generated}/validity/structs/VkScreenSurfaceCreateInfoQNX.adoc[]
51--
52
53[open,refpage='VkScreenSurfaceCreateFlagsQNX',desc='Reserved for future use',type='flags']
54--
55include::{generated}/api/flags/VkScreenSurfaceCreateFlagsQNX.adoc[]
56
57tname:VkScreenSurfaceCreateFlagsQNX is a bitmask type for setting a mask,
58but is currently reserved for future use.
59--
60