Vulkan-Docs/chapters/VK_KHR_android_surface/platformCreateSurface_android.txt
Jon Leech f1a7c4b4f3 Change log for January 13, 2019 Vulkan 1.1.98 spec update:
* Update release number to 98.

Public Issues:

  * Fix missing markup in flink:vkDestroyPipelineLayout valid usage
    statement (pull request 882).
  * Add missing contributors for `<<VK_EXT_buffer_device_address>>` (public
    pull request 891).

Internal Issues:

  * Detect nested bullet points in valid usage blocks and warn about them
    during VUID assignment (internal issue 1382).
  * Update the style guide to document the process for reserving new bits in
    bitmask types (internal issue 1411).
  * Clarify for slink:VkApplicationInfo::pname:apiVersion and in the
    <<fundamentals-validusage-versions, Valid Usage for Newer Core
    Versions>> section when it is valid for an application to use a certain
    version of Vulkan API functionality (for an instance and for a
    device/physical device); and when the validation layers must generate an
    error (internal issue 1412).
  * Add optional <<memory-model-availability-visibility, transitive
    availability/visibility operations to the memory model, including a new
    pname:vulkanMemoryModelAvailabilityVisibilityChains feature for
    slink:VkPhysicalDeviceVulkanMemoryModelFeaturesKHR (internal issue
    1460).
  * Add the code:StorageBuffer storage class to those in the
    <<interfaces-resources-descset, Descriptor Set Interface>> (internal
    issue 1480).
  * Add missing `returnedonly` tags for a number of returned extension
    structures that can be passed in pname:pNext chains (internal issue
    1515).
  * Clean up and rearrange some spec language for
    slink:VkRenderPassCreateInfo and slink:VkAttachmentReference.txt
    (internal issue 1522).
  * Correctly round the code:OpVectorTimesScalar and
    code:OpMatrixTimesScalar SPIR-V operations in the <<Precision of core
    SPIR-V Instructions>> table (internal merge request 2996).
  * Work around cases in flink:vkCmdBeginTransformFeedbackEXT,
    flink:vkCmdEndTransformFeedbackEXT, and
    slink:VkPipelineCoverageModulationStateCreateInfoNV where an array
    parameter is `optional` but the length is not in `vk.xml`. This is an
    interim fix using `noautovalidity` + handcoded VU replacing those that
    should be autogenerated (internal issue 2944 and
    https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/480).
  * Remove redundant capability validation of the code:float16 and code:int8
    SPIR-V capabilities from the <<spirvenv-capabilities, Capabilities>>
    section, since they are already covered in the preceding table.
  * Update check_spec_links script, including validation for reference page
    open blocks. Fix errors identified by the script.
2019-01-13 05:53:27 -08:00

86 lines
3.2 KiB
Plaintext

// Copyright (c) 2014-2019 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
[[platformCreateSurface_android,platformCreateSurface_android]]
=== Android Platform
[open,refpage='vkCreateAndroidSurfaceKHR',desc='Create a slink:VkSurfaceKHR object for an Android native window',type='protos']
--
To create a sname:VkSurfaceKHR object for an Android native window, call:
include::../../api/protos/vkCreateAndroidSurfaceKHR.txt[]
* pname:instance is the instance to associate the surface with.
* pname:pCreateInfo is a pointer to an instance of the
sname:VkAndroidSurfaceCreateInfoKHR 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.
During the lifetime of a surface created using a particular
dlink:ANativeWindow handle any attempts to create another surface for the
same dlink:ANativeWindow and any attempts to connect to the same
dlink:ANativeWindow through other platform mechanisms will fail.
[NOTE]
.Note
====
In particular, only one sname:VkSurfaceKHR can: exist at a time for a given
window.
Similarly, a native window cannot: be used by both a sname:VkSurfaceKHR and
code:EGLSurface simultaneously.
====
If successful, fname:vkCreateAndroidSurfaceKHR increments the
dlink:ANativeWindow's reference count, and fname:vkDestroySurfaceKHR will
decrement it.
On Android, when a swapchain's pname:imageExtent does not match the
surface's pname:currentExtent, the presentable images will be scaled to the
surface's dimensions during presentation.
pname:minImageExtent is [eq]#(1,1)#, and pname:maxImageExtent is the maximum
image size supported by the consumer.
For the system compositor, pname:currentExtent is the window size (i.e. the
consumer's preferred size).
include::../../validity/protos/vkCreateAndroidSurfaceKHR.txt[]
--
[open,refpage='VkAndroidSurfaceCreateInfoKHR',desc='Structure specifying parameters of a newly created Android surface object',type='structs']
--
The sname:VkAndroidSurfaceCreateInfoKHR structure is defined as:
include::../../api/structs/VkAndroidSurfaceCreateInfoKHR.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:window is a pointer to the dlink:ANativeWindow to associate the
surface with.
.Valid Usage
****
* [[VUID-VkAndroidSurfaceCreateInfoKHR-window-01248]]
pname:window must: point to a valid Android dlink:ANativeWindow.
****
include::../../validity/structs/VkAndroidSurfaceCreateInfoKHR.txt[]
--
[open,refpage='ANativeWindow',desc='Android native window type',type='defines']
--
To remove an unnecessary compile-time dependency, an incomplete type
definition of dlink:ANativeWindow is provided in the Vulkan headers:
include::../../api/defines/ANativeWindow.txt[]
The actual dlink:ANativeWindow type is defined in Android NDK headers.
--