VK_MVK_macos_surface(3)

# VK_MVK_macos_surface(3) Manual Page

## Name

VK_MVK_macos_surface - instance extension

Loading… please wait.

## Registered Extension Number

124

## Revision

3

## Extension and Version Dependencies

- Requires support for Vulkan 1.0

- Requires `VK_KHR_surface` to be enabled

## Deprecation state

- Deprecated by `VK_EXT_metal_surface` extension

## Contact

- Bill Hollings billhollings

## Other Extension Metadata

Last Modified Date

  2020-07-31

IP Status

  No known IP claims.

Contributors

  - Bill Hollings, The Brenwill Workshop Ltd.

## Description

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.

## New Commands

- vkCreateMacOSSurfaceMVK

## New Structures

- VkMacOSSurfaceCreateInfoMVK

## New Bitmasks

- VkMacOSSurfaceCreateFlagsMVK

## New Enum Constants

- `VK_MVK_MACOS_SURFACE_EXTENSION_NAME`

- `VK_MVK_MACOS_SURFACE_SPEC_VERSION`

- Extending VkStructureType:

  - `VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK`

## Version History

- Revision 1, 2017-02-15 (Bill Hollings)

  - Initial draft.

- Revision 2, 2017-02-24 (Bill Hollings)

  - Minor syntax fix to emphasize firm requirement for `NSView` to be backed by a `CAMetalLayer`.

- Revision 3, 2020-07-31 (Bill Hollings)

  - Update documentation on requirements for `NSView`.

  - Mark as deprecated by `VK_EXT_metal_surface`.

## See Also

VkMacOSSurfaceCreateFlagsMVK, VkMacOSSurfaceCreateInfoMVK, vkCreateMacOSSurfaceMVK

## Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

## Copyright

Copyright 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0