C Specification

To create a VkSurfaceKHR object for a UBM surface, call:

// Provided by VK_SEC_ubm_surface
VkResult vkCreateUbmSurfaceSEC(
    VkInstance                                  instance,
    const VkUbmSurfaceCreateInfoSEC*            pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkSurfaceKHR*                               pSurface);

Parameters

  • instance is the instance to associate the surface with.

  • pCreateInfo is a pointer to a VkUbmSurfaceCreateInfoSEC 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-vkCreateUbmSurfaceSEC-instance-parameter
    instance must be a valid VkInstance handle

  • VUID-vkCreateUbmSurfaceSEC-pCreateInfo-parameter
    pCreateInfo must be a valid pointer to a valid VkUbmSurfaceCreateInfoSEC structure

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

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

Return Codes
On success, this command returns
On failure, this command returns

See Also

VK_SEC_ubm_surface, VkAllocationCallbacks, VkInstance, VkSurfaceKHR, VkUbmSurfaceCreateInfoSEC

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.

Copyright

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0