1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
// Copyright (c) 2018-2020 The Brenwill Workshop Ltd.
//
// SPDX-License-Identifier: CC-BY-4.0
[[platformCreateSurface_macos]]
=== macOS Platform
[open,refpage='vkCreateMacOSSurfaceMVK',desc='Create a VkSurfaceKHR object for a macOS NSView',type='protos']
--
:refpage: vkCreateMacOSSurfaceMVK
To create a sname:VkSurfaceKHR object for a macOS code:NSView or
basetype:CAMetalLayer, call:
include::{generated}/api/protos/vkCreateMacOSSurfaceMVK.adoc[]
ifdef::VK_EXT_metal_surface[]
[NOTE]
.Note
====
The `vkCreateMacOSSurfaceMVK` function is considered deprecated and has been
superseded by flink:vkCreateMetalSurfaceEXT from the
`apiext:VK_EXT_metal_surface` extension.
====
endif::VK_EXT_metal_surface[]
* pname:instance is the instance with which to associate the surface.
* pname:pCreateInfo is a pointer to a slink:VkMacOSSurfaceCreateInfoMVK
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 is a pointer to a slink:VkSurfaceKHR handle in which the
created surface object is returned.
include::{generated}/validity/protos/vkCreateMacOSSurfaceMVK.adoc[]
--
[open,refpage='VkMacOSSurfaceCreateInfoMVK',desc='Structure specifying parameters of a newly created macOS surface object',type='structs']
--
The slink:VkMacOSSurfaceCreateInfoMVK structure is defined as:
include::{generated}/api/structs/VkMacOSSurfaceCreateInfoMVK.adoc[]
* pname:sType is a elink:VkStructureType value identifying this structure.
* pname:pNext is `NULL` or a pointer to a structure extending this
structure.
* pname:flags is reserved for future use.
* pname:pView is a reference to either a basetype:CAMetalLayer object or
an code:NSView object.
.Valid Usage
****
* [[VUID-VkMacOSSurfaceCreateInfoMVK-pView-04144]]
If pname:pView is a basetype:CAMetalLayer object, it must: be a valid
basetype:CAMetalLayer
* [[VUID-VkMacOSSurfaceCreateInfoMVK-pView-01317]]
If pname:pView is an code:NSView object, it must: be a valid
code:NSView, must: be backed by a code:CALayer object of type
basetype:CAMetalLayer, and flink:vkCreateMacOSSurfaceMVK must: be called
on the main thread
****
include::{generated}/validity/structs/VkMacOSSurfaceCreateInfoMVK.adoc[]
--
[open,refpage='VkMacOSSurfaceCreateFlagsMVK',desc='Reserved for future use',type='flags']
--
include::{generated}/api/flags/VkMacOSSurfaceCreateFlagsMVK.adoc[]
tname:VkMacOSSurfaceCreateFlagsMVK is a bitmask type for setting a mask, but
is currently reserved for future use.
--
|
