VulkanHub
Function Prototype

vkCreateDisplayModeKHR

Create a display mode

Additional modes may also be created by calling:

VkResult vkCreateDisplayModeKHR(
    VkPhysicalDevice physicalDevice,
    VkDisplayKHR display,
    const VkDisplayModeCreateInfoKHR* pCreateInfo,
    const VkAllocationCallbacks* pAllocator,
    VkDisplayModeKHR* pMode);
  • physicalDevice is the physical device associated with display.
  • display is the display to create an additional mode for.
  • pCreateInfo is a pointer to a VkDisplayModeCreateInfoKHR structure describing the new mode to create.
  • pAllocator is the allocator used for host memory allocated for the display mode object when there is no more specific allocator available (see Memory Allocation).
  • pMode is a pointer to a VkDisplayModeKHR handle in which the mode created is returned.

Valid Usage (Implicit)

VUID-vkCreateDisplayModeKHR-physicalDevice-parameter

physicalDevice must be a valid VkPhysicalDevice handle

VUID-vkCreateDisplayModeKHR-display-parameter

display must be a valid VkDisplayKHR handle

VUID-vkCreateDisplayModeKHR-pCreateInfo-parameter

pCreateInfo must be a valid pointer to a valid VkDisplayModeCreateInfoKHR structure

VUID-vkCreateDisplayModeKHR-pAllocator-parameter

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

VUID-vkCreateDisplayModeKHR-pMode-parameter

pMode must be a valid pointer to a VkDisplayModeKHR handle

VUID-vkCreateDisplayModeKHR-display-parent

display must have been created, allocated, or retrieved from physicalDevice

Host Synchronization

  • Host access to display must be externally synchronized ::