VKDISPLAYPLANECAPABI(3)

NAME
VkDisplayPlaneCapabilitiesKHR - Structure describing capabilities of a mode and plane combination

C SPECIFICATION

The VkDisplayPlaneCapabilitiesKHR structure is defined as:

    typedef struct VkDisplayPlaneCapabilitiesKHR {
        VkDisplayPlaneAlphaFlagsKHR    supportedAlpha;
        VkOffset2D                     minSrcPosition;
        VkOffset2D                     maxSrcPosition;
        VkExtent2D                     minSrcExtent;
        VkExtent2D                     maxSrcExtent;
        VkOffset2D                     minDstPosition;
        VkOffset2D                     maxDstPosition;
        VkExtent2D                     minDstExtent;
        VkExtent2D                     maxDstExtent;
    } VkDisplayPlaneCapabilitiesKHR;

MEMBERS

    • supportedAlpha is a bitmask of VkDisplayPlaneAlphaFlagBitsKHR describing the supported alpha blending modes.

    • minSrcPosition is the minimum source rect offset supported by this plane using the specified mode.

    • maxSrcPosition is the maximum source rect offset supported by this plane using the specified mode. The x and y offets must be >= 0.

    • maxSrcPosition is the maximum source rect offset supported by this plane using the specified mode. The x and y offsets must be >= minSrcPosition.

    • minSrcExtent is the minimum source rect size supported by this plane using the specified mode.

    • maxSrcExtent is the maximum source rect size supported by this plane using the specified mode.

    • minDstPosition, maxDstPosition, minDstExtent, maxDstExtent all have similar semantics to their corresponding "Src" equivalents, but apply to the output region within the mode rather than the input region within the source image. Unlike the "Src" offsets, minDstPosition and maxDstPosition may contain negative values.

DESCRIPTION

The minimum and maximum position and extent fields describe the hardware limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain’s presentable images on the specified display plane. This is expressed by returning minSrcPosition, maxSrcPosition, minSrcExtent, and maxSrcExtent values that indicate a range of possible positions and sizes may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.

Vendors may also support mapping the presentable images' content to a subset or superset of the visible region in the specified display mode. This is expressed by returning minDstPosition, maxDstPosition, minDstExtent and maxDstExtent values that indicate a range of possible positions and sizes may be used to describe the region within the display mode that the source pixels will be mapped to.

Other vendors may support only a 1-1 mapping between pixels in the presentable images and the display mode. This may be indicated by returning (0,0) for minSrcPosition, maxSrcPosition, minDstPosition, and maxDstPosition, and (display mode width, display mode height) for minSrcExtent, maxSrcExtent, minDstExtent, and maxDstExtent.

These values indicate the limits of the hardware’s individual fields. Not all combinations of values within the offset and extent ranges returned in VkDisplayPlaneCapabilitiesKHR are guaranteed to be supported. Vendors may still fail presentation requests that specify unsupported combinations.

VALID USAGE

    • supportedAlpha must be a valid combination of VkDisplayPlaneAlphaFlagBitsKHR values

SEE ALSO

VkDisplayPlaneAlphaFlagsKHR, VkExtent2D, VkOffset2D, vkGetDisplayPlaneCapabilitiesKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.