VKSURFACECAPABILITIE(3)

NAME
VkSurfaceCapabilitiesKHR - Structure describing capabilities of a surface

C SPECIFICATION

The VkSurfaceCapabilitiesKHR structure is defined as:

MEMBERS

    • minImageCount is the minimum number of images the specified device supports for a swapchain created for the surface.

    • maxImageCount is the maximum number of images the specified device supports for a swapchain created for the surface. A value of 0 means that there is no limit on the number of images, though there may be limits related to the total amount of memory used by swapchain images.

    • currentExtent is the current width and height of the surface, or the special value [ $(0xFFFFFFFF, 0xFFFFFFFF)$ ] indicating that the surface size will be determined by the extent of a swapchain targeting the surface.

    • minImageExtent contains the smallest valid swapchain extent for the surface on the specified device.

    • maxImageExtent contains the largest valid swapchain extent for the surface on the specified device.

    • maxImageArrayLayers is the maximum number of layers swapchain images can have for a swapchain created for this device and surface.

    • supportedTransforms is a bitfield of VkSurfaceTransformFlagBitsKHR, describing the presentation transforms supported for the surface on the specified device.

    • currentTransform is a bitfield of VkSurfaceTransformFlagBitsKHR, describing the surface’s current transform relative to the presentation engine’s natural orientation.

    • supportedCompositeAlpha is a bitfield of VkCompositeAlphaFlagBitsKHR, representing the alpha compositing modes supported by the presentation engine for the surface on the specified device. Opaque composition can be achieved in any alpha compositing mode by either using a swapchain image format that has no alpha component, or by ensuring that all pixels in the swapchain images have an alpha value of 1.0.

    • supportedUsageFlags is a bitfield of VkImageUsageFlagBits representing the ways the application can use the presentable images of a swapchain created for the surface on the specified device. VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT must be included in the set but implementations may support additional usages.

DESCRIPTION

SEE ALSO

VkCompositeAlphaFlagsKHR, VkExtent2D, VkImageUsageFlags, VkSurfaceTransformFlagBitsKHR, VkSurfaceTransformFlagsKHR, vkGetPhysicalDeviceSurfaceCapabilitiesKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.