mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 20:45:12 +00:00
194a7f4d0d
* 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).
55 lines
1.9 KiB
Plaintext
55 lines
1.9 KiB
Plaintext
[[platformCreateSurface_metal,platformCreateSurface_metal]]
|
|
|
|
=== Metal Platform
|
|
|
|
[open,refpage='vkCreateMetalSurfaceEXT',desc='Create a VkSurfaceKHR object for CAMetalLayer',type='protos']
|
|
--
|
|
|
|
To create a sname:VkSurfaceKHR object for a dlink:CAMetalLayer, call:
|
|
|
|
include::{generated}/api/protos/vkCreateMetalSurfaceEXT.txt[]
|
|
|
|
* pname:instance is the instance with which to associate the surface.
|
|
* pname:pCreateInfo is a pointer to a slink:VkMetalSurfaceCreateInfoEXT
|
|
structure specifying 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 sname:VkSurfaceKHR handle in which the
|
|
created surface object is returned.
|
|
|
|
include::{generated}/validity/protos/vkCreateMetalSurfaceEXT.txt[]
|
|
|
|
--
|
|
|
|
[open,refpage='VkMetalSurfaceCreateInfoEXT',desc='Structure specifying parameters of a newly created Metal surface object',type='structs']
|
|
--
|
|
|
|
The slink:VkMetalSurfaceCreateInfoEXT structure is defined as:
|
|
|
|
include::{generated}/api/structs/VkMetalSurfaceCreateInfoEXT.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:pLayer is a reference to a dlink:CAMetalLayer object representing
|
|
a renderable surface.
|
|
|
|
.Valid Usage
|
|
****
|
|
****
|
|
|
|
include::{generated}/validity/structs/VkMetalSurfaceCreateInfoEXT.txt[]
|
|
--
|
|
|
|
[open,refpage='CAMetalLayer',desc='CoreAnimation native layer type for Metal',type='defines']
|
|
--
|
|
To remove an unnecessary compile-time dependency, an incomplete type
|
|
definition of dlink:CAMetalLayer is provided in the Vulkan headers:
|
|
|
|
include::{generated}/api/defines/CAMetalLayer.txt[]
|
|
|
|
The actual dlink:CAMetalLayer type is defined in the QuartzCore framework.
|
|
--
|