Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class MVKMacosSurface

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
The VK_MVK_macos_surface extension is an instance extension. It provides a mechanism to create a VkSurfaceKHR object (defined by the VK_KHR_surface extension) based on an NSView, the native surface type of macOS, which is underpinned by a CAMetalLayer, to support rendering to the surface using Apple’s Metal framework.
Deprecation by VK_EXT_metal_surface

The VK_MVK_macos_surface extension is considered deprecated and has been superseded by the VK_EXT_metal_surface extension.

VK_MVK_macos_surface
Name String
VK_MVK_macos_surface
Extension Type
Instance extension
Registered Extension Number
124
Revision
3
Extension and Version Dependencies
VK_KHR_surface
Deprecation state
Contact
Other Extension Metadata
Last Modified Date
2020-07-31
IP Status
No known IP claims.
Contributors
  • Bill Hollings, The Brenwill Workshop Ltd.

Field Summary

Modifier and TypeField and Description
public static final String
VK_MVK_MACOS_SURFACE_EXTENSION_NAME

The extension name.

public static final int
VK_MVK_MACOS_SURFACE_SPEC_VERSION

The extension specification version.

public static final int
VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK

Extends VkStructureType.

Constructor Summary

AccessConstructor and Description
protected
MVKMacosSurface()

Method Summary

Modifier and TypeMethod and Description
public static int
nvkCreateMacOSSurfaceMVK(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)

Unsafe version of: CreateMacOSSurfaceMVK

public static int
vkCreateMacOSSurfaceMVK(VkInstance
the instance with which to associate the surface.
instance, VkMacOSSurfaceCreateInfoMVK
a pointer to a VkMacOSSurfaceCreateInfoMVK structure containing parameters affecting the creation of the surface object.
pCreateInfo, VkAllocationCallbacks
the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
pAllocator, LongBuffer
a pointer to a VkSurfaceKHR handle in which the created surface object is returned.
pSurface)

Create a VkSurfaceKHR object for a macOS NSView.

public static int
vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)

Array version of: CreateMacOSSurfaceMVK

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_MVK_MACOS_SURFACE_EXTENSION_NAMEback to summary
public static final String VK_MVK_MACOS_SURFACE_EXTENSION_NAME

The extension name.

VK_MVK_MACOS_SURFACE_SPEC_VERSIONback to summary
public static final int VK_MVK_MACOS_SURFACE_SPEC_VERSION

The extension specification version.

VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVKback to summary
public static final int VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK

Extends VkStructureType.

Constructor Detail

MVKMacosSurfaceback to summary
protected MVKMacosSurface()

Method Detail

nvkCreateMacOSSurfaceMVKback to summary
public static int nvkCreateMacOSSurfaceMVK(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)

Unsafe version of: CreateMacOSSurfaceMVK

vkCreateMacOSSurfaceMVKback to summary
public static int vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, VkAllocationCallbacks pAllocator, LongBuffer pSurface)

Create a VkSurfaceKHR object for a macOS NSView.

C Specification

To create a VkSurfaceKHR object for a macOS NSView or CAMetalLayer, call:


VkResult vkCreateMacOSSurfaceMVK(
    VkInstance                                  instance,
    const VkMacOSSurfaceCreateInfoMVK*          pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkSurfaceKHR*                               pSurface);
Valid Usage (Implicit)
  • instance must be a valid VkInstance handle
  • pCreateInfo must be a valid pointer to a valid VkMacOSSurfaceCreateInfoMVK structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pSurface must be a valid pointer to a VkSurfaceKHR handle
Return Codes
On success, this command returns
On failure, this command returns
See Also

VkAllocationCallbacks, VkMacOSSurfaceCreateInfoMVK

Parameters
instance:VkInstance

the instance with which to associate the surface.

pCreateInfo:VkMacOSSurfaceCreateInfoMVK

a pointer to a VkMacOSSurfaceCreateInfoMVK structure containing parameters affecting the creation of the surface object.

pAllocator:VkAllocationCallbacks

the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

pSurface:LongBuffer

a pointer to a VkSurfaceKHR handle in which the created surface object is returned.

Annotations
@NativeType:VkResult
vkCreateMacOSSurfaceMVKback to summary
public static int vkCreateMacOSSurfaceMVK(VkInstance instance, VkMacOSSurfaceCreateInfoMVK pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)

Array version of: CreateMacOSSurfaceMVK

Annotations
@NativeType:VkResult