VKCREATEDISPLAYMODEK(3)

NAME
vkCreateDisplayModeKHR - create a display mode.

C SPECIFICATION

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

PARAMETERS

physicalDevice
    The physical device associated with display.

display
    The display to create an additional mode.

pCreateInfo
    Is a VkDisplayModeCreateInfoKHR structure describing the new mode to create.

pAllocator
    The allocator used for host memory allocated for the mode object.

pMode
    Returns the handle of the mode created.

DESCRIPTION

vkCreateDisplayModeKHR creates additional display modes.

pCreateInfo is an instance of the VkDisplayModeCreateInfoKHR structure, the definition of which is:

    typedef struct VkDisplayModeCreateInfoKHR {
        VkStructureType                sType;
        const void*                    pNext;
        VkDisplayModeCreateFlagsKHR    flags;
        VkDisplayModeParametersKHR     parameters;
    } VkDisplayModeCreateInfoKHR;

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

SEE ALSO

vkGetDisplayModePropertiesKHR, vkCreateDisplayPlaneSurfaceKHR

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.