Vulkan-Docs/chapters/VK_MVK_ios_surface/platformCreateSurface_ios.txt
Jon Leech 194a7f4d0d Change log for September 8, 2019 Vulkan 1.1.122 spec update:
* Update release number to 122.

Internal Issues:

  * Add style guide language on not using standalone `+` signs (internal
    issue 736); not using leading whitespace for markup (internal issue
    747); and on keeping descriptions of a single API in a contiguous block
    of markup (internal issue 949), and apply them to the specification.
  * Add a glossary definition of "`constant integral expression`", pointing
    to the SPIR-V "`constant instruction`" definition (internal issue 1225).
  * Many minor edits to improve writing style consistency and capture
    additional style guidelines (internal issue 1553).
  * Clarify that <<fragops-depth-write, depth writes are not performed>> if
    there is no depth framebuffer attachment (internal issue 1771).
  * Allow implementations to use rectangular line style of interpolation for
    <<primsrast-lines-bresenham, wide Bresenham lines>>, though replicating
    attributes is still preferred. Clarify that code:FragCoord is not
    replicated (internal issue 1772).
  * Resolve a contradiction in valid usage statements for
    slink:VkImageCreateInfo and slink:VkImageStencilUsageCreateInfoEXT
    (internal issue 1773).
  * Add style guide discussion of markup for indented equations, and use
    markup workaround for asciidoctor 2 compatibility (internal issue 1793).
  * Deprecate the `<<VK_EXT_validation_flags>>` extension in `vk.xml` and
    the extension appendix (internal issue 1801).
  * Add a new checker script `scripts/xml_consistency.py`. This is not
    currently run as part of internal CI (internal merge request 3285).
  * Correct "`an`" -> "`a`" prepositions where needed (internal merge
    request 3334).
  * Clarify that the <<features-uniformBufferStandardLayout,
    pname:uniformBufferStandardLayout>> feature is only required when the
    extension defining it is supported (internal merge request 3341).
  * Bring scripts into closer sync with OpenXR, mainly through conversion of
    comments to docstrings where appropriate, and add gen-scripts-docs.sh
    (internal merge request 3324).
  * Correct pname:maxDrawMeshTasksCount to 2^16^-1 in the <<limits-required,
    Required Limits>> table (internal merge requests 3361).

New Extensions

  * `<<VK_IMG_format_pvrtc>>` (public issue 512).
2019-09-08 20:41:02 -07: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::{generated}/api/protos/vkCreateIOSSurfaceMVK.txt[]
* pname:instance is the instance with which to associate the surface.
* pname:pCreateInfo is a pointer to a 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 is a pointer to a slink:VkSurfaceKHR handle in which the
created surface object is returned.
include::{generated}/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::{generated}/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::{generated}/validity/structs/VkIOSSurfaceCreateInfoMVK.txt[]
--