vkCreateSurfaceOHOS(3)

Name

vkCreateSurfaceOHOS - Create a VkSurfaceKHR object for an Open Harmony OS native window

C Specification

To create a VkSurfaceKHR object on Open Harmony OS platform, call:

// Provided by VK_OHOS_surface
VkResult vkCreateSurfaceOHOS(
    VkInstance                                  instance,
    const VkSurfaceCreateInfoOHOS*              pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkSurfaceKHR*                               pSurface);

Parameters

  • instance is the instance to associate the surface with.

  • pCreateInfo is a pointer to a VkSurfaceCreateInfoOHOS structure containing parameters affecting the creation of the surface object.

  • pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

  • pSurface is a pointer to a VkSurfaceKHR handle in which the created surface object is returned.

Description

Valid Usage (Implicit)

  • VUID-vkCreateSurfaceOHOS-instance-parameter
    instance must be a valid VkInstance handle

  • VUID-vkCreateSurfaceOHOS-pCreateInfo-parameter
    pCreateInfo must be a valid pointer to a valid VkSurfaceCreateInfoOHOS structure

  • VUID-vkCreateSurfaceOHOS-pAllocator-parameter
    If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

  • VUID-vkCreateSurfaceOHOS-pSurface-parameter
    pSurface must be a valid pointer to a VkSurfaceKHR handle

Return Codes
Success
Failure

See Also

VK_OHOS_surface, VkAllocationCallbacks, VkInstance, VkSurfaceCreateInfoOHOS, VkSurfaceKHR

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.