Vulkan-Docs/chapters/VK_MVK_ios_surface/platformCreateSurface_ios.txt
Jon Leech 35e7bee5f0 Change log for March 3, 2019 Vulkan 1.1.102 spec update:
* Update release number to 102.

Public Issues:

  * Simplify flink:vkGetImageMemoryRequirements constraint for
    ename:VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT (public pull request 817).
  * Fix typo in markup of the <<textures-texel-coordinate-systems-diagrams,
    Texel Coordinate Systems, Corner Sampling>> image that was generating
    complaints from chunked HTML output generation (public pull request
    928).

Internal Issues:

  * Split the old <<features, Features>> chapter into four chapters:
    <<features, Features>>, <<limits, Limits>>, <<formats, Formats>>, and
    <<capabilities, Capabilities>>, with minor edits to the introductory
    paragraph of each chapter. Anchor names in these chapters were changed,
    with corresponding effects to xrefs to these anchors elsewhere in spec
    markup . The purpose is to make the chunked HTML spec output load faster
    on what was previously a single, gigantic chapter (internal issue 1554).
  * Add ename:VK_PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_NV, to the supported
    pipeline stages for ename:VK_ACCESS_UNIFORM_READ,
    ename:VK_ACCESS_SHADER_READ, and ename:VK_ACCESS_SHADER_WRITE in the
    <<synchronization-access-types-supported>> table.
  * Correct legal name of Google, LLC in vk.xml \<tags> section and a
    copyright statement.
  * Clarify that Vulkan treats the Android
    code:AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM format as RGBA, and the
    application is responsible for forcing the X/A component to be read as
    1.0, in the <<memory-external-android-hardware-buffer-formats>> table.
  * Clarify the vertex order of various primitive topologies, and define the
    order of transform feedback vertex capture based on that. This involves
    a lot of refactoring and cleanup in the <<drawing-primitive-topologies,
    Primitive Topologies>>, <<geometry-input, Geometry Shader Input
    Primitives>> sections, and <<vertexpostproc-transform-feedback Transform
    Feedback>> sections, and numerous places in the <<tessellation>>
    chapter,

New Extensions:

  * `VK_EXT_metal_surface`
  * `VK_EXT_ycbcr_image_arrays` (internal issue 1361).
  * `VK_NVX_image_view_handle`
2019-03-03 21:05:48 -08:00

50 lines
1.8 KiB
Plaintext

[[platformCreateSurface_ios,platformCreateSurface_ios]]
=== iOS Platform
[open,refpage='vkCreateIOSSurfaceMVK',desc='Create a VkSurfaceKHR object for an iOS UIView',type='protos']
--
To create a sname:VkSurfaceKHR object for an iOS code:UIView, call:
include::../../api/protos/vkCreateIOSSurfaceMVK.txt[]
* pname:instance is the instance with which to associate the surface.
* pname:pCreateInfo is a pointer to an instance of the
slink:VkIOSSurfaceCreateInfoMVK 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 points to a slink:VkSurfaceKHR handle in which the
created surface object is returned.
include::../../validity/protos/vkCreateIOSSurfaceMVK.txt[]
--
[open,refpage='VkIOSSurfaceCreateInfoMVK',desc='Structure specifying parameters of a newly created iOS surface object',type='structs']
--
The slink:VkIOSSurfaceCreateInfoMVK structure is defined as:
include::../../api/structs/VkIOSSurfaceCreateInfoMVK.txt[]
* pname:sType is the type of this structure.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:flags is reserved for future use.
* pname:pView is a reference to a code:UIView object which will display
this surface.
This code:UIView must: be backed by a code:CALayer instance of type
dlink:CAMetalLayer.
.Valid Usage
****
* [[VUID-VkIOSSurfaceCreateInfoMVK-pView-01316]]
pname:pView must: be a valid code:UIView and must: be backed by a
code:CALayer instance of type dlink:CAMetalLayer.
****
include::../../validity/structs/VkIOSSurfaceCreateInfoMVK.txt[]
--