VKCREATEDISPLAYMODEK(3)

NAME
vkCreateDisplayModeKHR - Create a display mode

C SPECIFICATION

Additional modes may also be created by calling:

    VkResult vkCreateDisplayModeKHR(
        VkPhysicalDevice                            physicalDevice,
        VkDisplayKHR                                display,
        const VkDisplayModeCreateInfoKHR*           pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkDisplayModeKHR*                           pMode);

PARAMETERS

    • physicalDevice is the physical device associated with display.

    • display is the display to create an additional mode for.

    • pCreateInfo is a VkDisplayModeCreateInfoKHR structure describing the new mode to create.

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

    • pMode returns the handle of the mode created.

DESCRIPTION

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • display must be a valid VkDisplayKHR handle

    • pCreateInfo must be a pointer to a valid VkDisplayModeCreateInfoKHR structure

    • If pAllocator is not NULL, pAllocator must be a pointer to a valid VkAllocationCallbacks structure

    • pMode must be a pointer to a VkDisplayModeKHR handle

HOST SYNCHRONIZATION

    • Host access to display must be externally synchronized

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

        • VK_ERROR_INITIALIZATION_FAILED

SEE ALSO

VkAllocationCallbacks, VkDisplayKHR, VkDisplayModeCreateInfoKHR, VkDisplayModeKHR, VkPhysicalDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCreateDisplayModeKHR

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

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.