VKDISPLAYMODECREATEI(3)

NAME
VkDisplayModeCreateInfoKHR - Structure specifying parameters of a newly created display mode object

C SPECIFICATION

The VkDisplayModeCreateInfoKHR structure is defined as:

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

MEMBERS

    • sType is the type of this structure and must be VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR.

    • pNext is NULL or a pointer to an extension-specific structure.

    • flags is reserved for future use, and must be zero.

    • parameters is a VkDisplayModeParametersKHR structure describing the display parameters to use in creating the new mode. If the parameters are not compatible with the specified display, the implementation must return VK_ERROR_INITIALIZATION_FAILED.

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR

    • pNext must be NULL

    • flags must be 0

    • The width and height members of the visibleRegion member of parameters must be greater than 0

    • The refreshRate member of parameters must be greater than 0

SEE ALSO

VkDisplayModeCreateFlagsKHR, VkDisplayModeParametersKHR, VkStructureType, vkCreateDisplayModeKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.