Package org.lwjgl.vulkan
Class MVKMacosSurface
- java.lang.Object
-
- org.lwjgl.vulkan.MVKMacosSurface
-
public class MVKMacosSurface extends java.lang.Object
TheVK_MVK_macos_surface
extension is an instance extension. It provides a mechanism to create aVkSurfaceKHR
object (defined by theVK_KHR_surface
extension) that refers to anNSView
, the native surface type of macOS, which is underpinned by a dlink:CAMetalLayer, to support rendering to the surface using Apple's Metal framework.- Name String
VK_MVK_macos_surface
- Extension Type
- Instance extension
- Registered Extension Number
- 124
- Revision
- 2
- Extension and Version Dependencies
- Requires Vulkan 1.0
- Requires
VK_KHR_surface
- Contact
- Bill Hollings billhollings
- Last Modified Date
- 2017-02-24
- IP Status
- No known IP claims.
- Contributors
- Bill Hollings, The Brenwill Workshop Ltd.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
VK_MVK_MACOS_SURFACE_EXTENSION_NAME
The extension name.static int
VK_MVK_MACOS_SURFACE_SPEC_VERSION
The extension specification version.static int
VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK
ExtendsVkStructureType
.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static int
nvkCreateMacOSSurfaceMVK(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)
Unsafe version of:CreateMacOSSurfaceMVK
static int
vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)
Array version of:CreateMacOSSurfaceMVK
static int
vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSurface)
Create a VkSurfaceKHR object for a macOS NSView.
-
-
-
Field Detail
-
VK_MVK_MACOS_SURFACE_SPEC_VERSION
public static final int VK_MVK_MACOS_SURFACE_SPEC_VERSION
The extension specification version.- See Also:
- Constant Field Values
-
VK_MVK_MACOS_SURFACE_EXTENSION_NAME
public static final java.lang.String VK_MVK_MACOS_SURFACE_EXTENSION_NAME
The extension name.- See Also:
- Constant Field Values
-
VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK
public static final int VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK
ExtendsVkStructureType
.- See Also:
- Constant Field Values
-
-
Method Detail
-
nvkCreateMacOSSurfaceMVK
public static int nvkCreateMacOSSurfaceMVK(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)
Unsafe version of:CreateMacOSSurfaceMVK
-
vkCreateMacOSSurfaceMVK
public static int vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, @Nullable VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSurface)
Create a VkSurfaceKHR object for a macOS NSView.C Specification
To create a
VkSurfaceKHR
object for a macOSNSView
, call:VkResult vkCreateMacOSSurfaceMVK( VkInstance instance, const VkMacOSSurfaceCreateInfoMVK* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkSurfaceKHR* pSurface);
Valid Usage (Implicit)
instance
must be a validVkInstance
handlepCreateInfo
must be a valid pointer to a validVkMacOSSurfaceCreateInfoMVK
structure- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validVkAllocationCallbacks
structure pSurface
must be a valid pointer to aVkSurfaceKHR
handle
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
instance
- the instance with which to associate the surface.pCreateInfo
- a pointer to an instance of theVkMacOSSurfaceCreateInfoMVK
structure containing parameters affecting the creation of the surface object.pAllocator
- the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).pSurface
- points to aVkSurfaceKHR
handle in which the created surface object is returned.
-
vkCreateMacOSSurfaceMVK
public static int vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, @Nullable VkAllocationCallbacks pAllocator, long[] pSurface)
Array version of:CreateMacOSSurfaceMVK
-
-