public Class KHRDisplay

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha component of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color components.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color components.

See Also

VkDisplaySurfaceCreateInfoKHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha component of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color components.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color components.

See Also

VkDisplaySurfaceCreateInfoKHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha component of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color components.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color components.

See Also

VkDisplaySurfaceCreateInfoKHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha component of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color components.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color components.

See Also

VkDisplaySurfaceCreateInfoKHR

The extension name.

The extension specification version.

Extends VkObjectType.

Enum values:

• OBJECT_TYPE_DISPLAY_KHR
• OBJECT_TYPE_DISPLAY_MODE_KHR

Extends VkObjectType.

Enum values:

• OBJECT_TYPE_DISPLAY_KHR
• OBJECT_TYPE_DISPLAY_MODE_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

Unsafe version of: CreateDisplayModeKHR

Unsafe version of: CreateDisplayPlaneSurfaceKHR

Unsafe version of: GetDisplayModePropertiesKHR

Parameters

pPropertyCount:long

a pointer to an integer related to the number of display modes available or queried, as described below.

Unsafe version of: GetDisplayPlaneCapabilitiesKHR

Unsafe version of: GetDisplayPlaneSupportedDisplaysKHR

Parameters

pDisplayCount:long

a pointer to an integer related to the number of displays available or queried, as described below.

Unsafe version of: GetPhysicalDeviceDisplayPlanePropertiesKHR

Parameters

pPropertyCount:long

a pointer to an integer related to the number of display planes available or queried, as described below.

Unsafe version of: GetPhysicalDeviceDisplayPropertiesKHR

Parameters

pPropertyCount:long

a pointer to an integer related to the number of display devices available or queried, as described below.

Create a display mode.

C Specification

Additional modes may also be created by calling:

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

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• display must be a valid VkDisplayKHR handle
• pCreateInfo must be a valid pointer to a valid VkDisplayModeCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pMode must be a valid pointer to a VkDisplayModeKHR handle
• display must have been created, allocated, or retrieved from physicalDevice

Host Synchronization

• Host access to display must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

See Also

VkAllocationCallbacks, VkDisplayModeCreateInfoKHR

Parameters

physicalDevice:VkPhysicalDevice

the physical device associated with display.

display:long

the display to create an additional mode for.

pCreateInfo:VkDisplayModeCreateInfoKHR

a pointer to a VkDisplayModeCreateInfoKHR structure describing the new mode to create.

pAllocator:VkAllocationCallbacks

the allocator used for host memory allocated for the display mode object when there is no more specific allocator available (see Memory Allocation).

pMode:LongBuffer

a pointer to a VkDisplayModeKHR handle in which the mode created is returned.

Annotations

@NativeType:VkResult

Array version of: CreateDisplayModeKHR

Annotations

@NativeType:VkResult

Create a VkSurfaceKHR structure representing a display plane and mode.

C Specification

A complete display configuration includes a mode, one or more display planes and any parameters describing their behavior, and parameters describing some aspects of the images associated with those planes. Display surfaces describe the configuration of a single plane within a complete display configuration. To create a VkSurfaceKHR object for a display plane, call:

VkResult vkCreateDisplayPlaneSurfaceKHR(
    VkInstance                                  instance,
    const VkDisplaySurfaceCreateInfoKHR*        pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkSurfaceKHR*                               pSurface);

Valid Usage (Implicit)

• instance must be a valid VkInstance handle
• pCreateInfo must be a valid pointer to a valid VkDisplaySurfaceCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pSurface must be a valid pointer to a VkSurfaceKHR handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkAllocationCallbacks, VkDisplaySurfaceCreateInfoKHR

Parameters

instance:VkInstance

the instance corresponding to the physical device the targeted display is on.

pCreateInfo:VkDisplaySurfaceCreateInfoKHR

a pointer to a VkDisplaySurfaceCreateInfoKHR structure specifying which mode, plane, and other parameters to use, as described below.

pAllocator:VkAllocationCallbacks

the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

pSurface:LongBuffer

a pointer to a VkSurfaceKHR handle in which the created surface is returned.

Annotations

@NativeType:VkResult

Array version of: CreateDisplayPlaneSurfaceKHR

Annotations

@NativeType:VkResult

Query the set of mode properties supported by the display.

C Specification

Each display has one or more supported modes associated with it by default. These built-in modes are queried by calling:

VkResult vkGetDisplayModePropertiesKHR(
    VkPhysicalDevice                            physicalDevice,
    VkDisplayKHR                                display,
    uint32_t*                                   pPropertyCount,
    VkDisplayModePropertiesKHR*                 pProperties);

Description

If pProperties is NULL, then the number of display modes available on the specified display for physicalDevice is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If the value of pPropertyCount is less than the number of display modes for physicalDevice, at most pPropertyCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available display modes were returned.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• display must be a valid VkDisplayKHR handle
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkDisplayModePropertiesKHR structures
• display must have been created, allocated, or retrieved from physicalDevice

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDisplayModePropertiesKHR

Parameters

physicalDevice:VkPhysicalDevice

the physical device associated with display.

display:long

the display to query.

pPropertyCount:IntBuffer

a pointer to an integer related to the number of display modes available or queried, as described below.

pProperties:VkDisplayModePropertiesKHR.Buffer

either NULL or a pointer to an array of VkDisplayModePropertiesKHR structures.

Annotations

@NativeType:VkResult

Array version of: GetDisplayModePropertiesKHR

Annotations

@NativeType:VkResult

Query capabilities of a mode and plane combination.

C Specification

Applications that wish to present directly to a display must select which layer, or “plane” of the display they wish to target, and a mode to use with the display. Each display supports at least one plane. The capabilities of a given mode and plane combination are determined by calling:

VkResult vkGetDisplayPlaneCapabilitiesKHR(
    VkPhysicalDevice                            physicalDevice,
    VkDisplayModeKHR                            mode,
    uint32_t                                    planeIndex,
    VkDisplayPlaneCapabilitiesKHR*              pCapabilities);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• mode must be a valid VkDisplayModeKHR handle
• pCapabilities must be a valid pointer to a VkDisplayPlaneCapabilitiesKHR structure
• mode must have been created, allocated, or retrieved from physicalDevice

Host Synchronization

• Host access to mode must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDisplayPlaneCapabilitiesKHR

Parameters

physicalDevice:VkPhysicalDevice

the physical device associated with the display specified by mode

mode:long

the display mode the application intends to program when using the specified plane. Note this parameter also implicitly specifies a display.

planeIndex:int

the plane which the application intends to use with the display, and is less than the number of display planes supported by the device.

pCapabilities:VkDisplayPlaneCapabilitiesKHR

a pointer to a VkDisplayPlaneCapabilitiesKHR structure in which the capabilities are returned.

Annotations

@NativeType:VkResult

Query the list of displays a plane supports.

C Specification

To determine which displays a plane is usable with, call

VkResult vkGetDisplayPlaneSupportedDisplaysKHR(
    VkPhysicalDevice                            physicalDevice,
    uint32_t                                    planeIndex,
    uint32_t*                                   pDisplayCount,
    VkDisplayKHR*                               pDisplays);

Description

If pDisplays is NULL, then the number of displays usable with the specified planeIndex for physicalDevice is returned in pDisplayCount. Otherwise, pDisplayCount must point to a variable set by the user to the number of elements in the pDisplays array, and on return the variable is overwritten with the number of handles actually written to pDisplays. If the value of pDisplayCount is less than the number of usable display-plane pairs for physicalDevice, at most pDisplayCount handles will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available pairs were returned.

Valid Usage

• planeIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHR

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pDisplayCount must be a valid pointer to a uint32_t value
• If the value referenced by pDisplayCount is not 0, and pDisplays is not NULL, pDisplays must be a valid pointer to an array of pDisplayCount VkDisplayKHR handles

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

Parameters

physicalDevice:VkPhysicalDevice

a physical device.

planeIndex:int

the plane which the application wishes to use, and must be in the range [0, physical device plane count - 1].

pDisplayCount:IntBuffer

a pointer to an integer related to the number of displays available or queried, as described below.

pDisplays:LongBuffer

either NULL or a pointer to an array of VkDisplayKHR handles.

Annotations

@NativeType:VkResult

Array version of: GetDisplayPlaneSupportedDisplaysKHR

Annotations

@NativeType:VkResult

Query the plane properties.

C Specification

Images are presented to individual planes on a display. Devices must support at least one plane on each display. Planes can be stacked and blended to composite multiple images on one display. Devices may support only a fixed stacking order and fixed mapping between planes and displays, or they may allow arbitrary application specified stacking orders and mappings between planes and displays. To query the properties of device display planes, call:

VkResult vkGetPhysicalDeviceDisplayPlanePropertiesKHR(
    VkPhysicalDevice                            physicalDevice,
    uint32_t*                                   pPropertyCount,
    VkDisplayPlanePropertiesKHR*                pProperties);

Description

If pProperties is NULL, then the number of display planes available for physicalDevice is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If the value of pPropertyCount is less than the number of display planes for physicalDevice, at most pPropertyCount structures will be written.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkDisplayPlanePropertiesKHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDisplayPlanePropertiesKHR

Parameters

physicalDevice:VkPhysicalDevice

a physical device.

pPropertyCount:IntBuffer

a pointer to an integer related to the number of display planes available or queried, as described below.

pProperties:VkDisplayPlanePropertiesKHR.Buffer

either NULL or a pointer to an array of VkDisplayPlanePropertiesKHR structures.

Annotations

@NativeType:VkResult

Array version of: GetPhysicalDeviceDisplayPlanePropertiesKHR

Annotations

@NativeType:VkResult

Query information about the available displays.

C Specification

Various functions are provided for enumerating the available display devices present on a Vulkan physical device. To query information about the available displays, call:

VkResult vkGetPhysicalDeviceDisplayPropertiesKHR(
    VkPhysicalDevice                            physicalDevice,
    uint32_t*                                   pPropertyCount,
    VkDisplayPropertiesKHR*                     pProperties);

Description

If pProperties is NULL, then the number of display devices available for physicalDevice is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If the value of pPropertyCount is less than the number of display devices for physicalDevice, at most pPropertyCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available properties were returned.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkDisplayPropertiesKHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDisplayPropertiesKHR

Parameters

physicalDevice:VkPhysicalDevice

a physical device.

pPropertyCount:IntBuffer

a pointer to an integer related to the number of display devices available or queried, as described below.

pProperties:VkDisplayPropertiesKHR.Buffer

either NULL or a pointer to an array of VkDisplayPropertiesKHR structures.

Annotations

@NativeType:VkResult

Array version of: GetPhysicalDeviceDisplayPropertiesKHR

Annotations

@NativeType:VkResult