Vulkan.Extensions.VK_KHR_display

Name

VK_KHR_display - instance extension

VK_KHR_display

Name String

VK_KHR_display

Extension Type

Instance extension

Registered Extension Number

3

Revision

23

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_surface to be enabled

Contact

• James Jones @cubanismo%0A*Here describe the issue or question you have about the VK_KHR_display extension*
• Norbert Nopper @FslNopper%0A*Here describe the issue or question you have about the VK_KHR_display extension*

Other Extension Metadata

Last Modified Date

2017-03-13

IP Status

No known IP claims.

Contributors

• James Jones, NVIDIA
• Norbert Nopper, Freescale
• Jeff Vigil, Qualcomm
• Daniel Rakos, AMD

Description

This extension provides the API to enumerate displays and available modes on a given device.

New Object Types

• DisplayKHR

• DisplayModeKHR

New Commands

• createDisplayModeKHR

• createDisplayPlaneSurfaceKHR
• getDisplayModePropertiesKHR
• getDisplayPlaneCapabilitiesKHR
• getDisplayPlaneSupportedDisplaysKHR
• getPhysicalDeviceDisplayPlanePropertiesKHR
• getPhysicalDeviceDisplayPropertiesKHR

New Structures

• DisplayModeCreateInfoKHR

• DisplayModeParametersKHR
• DisplayModePropertiesKHR
• DisplayPlaneCapabilitiesKHR
• DisplayPlanePropertiesKHR
• DisplayPropertiesKHR
• DisplaySurfaceCreateInfoKHR

New Enums

• DisplayPlaneAlphaFlagBitsKHR

New Bitmasks

• DisplayModeCreateFlagsKHR

• DisplayPlaneAlphaFlagsKHR
• DisplaySurfaceCreateFlagsKHR
• SurfaceTransformFlagsKHR

New Enum Constants

• KHR_DISPLAY_EXTENSION_NAME

• KHR_DISPLAY_SPEC_VERSION

• Extending ObjectType:

  • OBJECT_TYPE_DISPLAY_KHR
  • OBJECT_TYPE_DISPLAY_MODE_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
  • STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

Issues

1) Which properties of a mode should be fixed in the mode information vs. settable in some other function when setting the mode? E.g., do we need to double the size of the mode pool to include both stereo and non-stereo modes? YUV and RGB scanout even if they both take RGB input images? BGR vs. RGB input? etc.

PROPOSED RESOLUTION: Many modern displays support at most a handful of resolutions and timings natively. Other “modes” are expected to be supported using scaling hardware on the display engine or GPU. Other properties, such as rotation and mirroring should not require duplicating hardware modes just to express all combinations. Further, these properties may be implemented on a per-display or per-overlay granularity.

To avoid the exponential growth of modes as mutable properties are added, as was the case with EGLConfig/WGL pixel formats/GLXFBConfig, this specification should separate out hardware properties and configurable state into separate objects. Modes and overlay planes will express capabilities of the hardware, while a separate structure will allow applications to configure scaling, rotation, mirroring, color keys, LUT values, alpha masks, etc. for a given swapchain independent of the mode in use. Constraints on these settings will be established by properties of the immutable objects.

Note the resolution of this issue may affect issue 5 as well.

2) What properties of a display itself are useful?

PROPOSED RESOLUTION: This issue is too broad. It was meant to prompt general discussion, but resolving this issue amounts to completing this specification. All interesting properties should be included. The issue will remain as a placeholder since removing it would make it hard to parse existing discussion notes that refer to issues by number.

3) How are multiple overlay planes within a display or mode enumerated?

PROPOSED RESOLUTION: They are referred to by an index. Each display will report the number of overlay planes it contains.

4) Should swapchains be created relative to a mode or a display?

PROPOSED RESOLUTION: When using this extension, swapchains are created relative to a mode and a plane. The mode implies the display object the swapchain will present to. If the specified mode is not the display’s current mode, the new mode will be applied when the first image is presented to the swapchain, and the default operating system mode, if any, will be restored when the swapchain is destroyed.

5) Should users query generic ranges from displays and construct their own modes explicitly using those constraints rather than querying a fixed set of modes (Most monitors only have one real “mode” these days, even though many support relatively arbitrary scaling, either on the monitor side or in the GPU display engine, making “modes” something of a relic/compatibility construct).

PROPOSED RESOLUTION: Expose both. Display information structures will expose a set of predefined modes, as well as any attributes necessary to construct a customized mode.

6) Is it fine if we return the display and display mode handles in the structure used to query their properties?

PROPOSED RESOLUTION: Yes.

7) Is there a possibility that not all displays of a device work with all of the present queues of a device? If yes, how do we determine which displays work with which present queues?

PROPOSED RESOLUTION: No known hardware has such limitations, but determining such limitations is supported automatically using the existing VK_KHR_surface and VK_KHR_swapchain query mechanisms.

8) Should all presentation need to be done relative to an overlay plane, or can a display mode + display be used alone to target an output?

PROPOSED RESOLUTION: Require specifying a plane explicitly.

9) Should displays have an associated window system display, such as an HDC or Display*?

PROPOSED RESOLUTION: No. Displays are independent of any windowing system in use on the system. Further, neither HDC nor Display* refer to a physical display object.

10) Are displays queried from a physical GPU or from a device instance?

PROPOSED RESOLUTION: Developers prefer to query modes directly from the physical GPU so they can use display information as an input to their device selection algorithms prior to device creation. This avoids the need to create placeholder device instances to enumerate displays.

This preference must be weighed against the extra initialization that must be done by driver vendors prior to device instance creation to support this usage.

11) Should displays and/or modes be dispatchable objects? If functions are to take displays, overlays, or modes as their first parameter, they must be dispatchable objects as defined in Khronos bug 13529. If they are not added to the list of dispatchable objects, functions operating on them must take some higher-level object as their first parameter. There is no performance case against making them dispatchable objects, but they would be the first extension objects to be dispatchable.

PROPOSED RESOLUTION: Do not make displays or modes dispatchable. They will dispatch based on their associated physical device.

12) Should hardware cursor capabilities be exposed?

PROPOSED RESOLUTION: Defer. This could be a separate extension on top of the base WSI specs.

if they are one physical display device to an end user, but may internally be implemented as two side-by-side displays using the same display engine (and sometimes cabling) resources as two physically separate display devices.

RESOLVED: Tiled displays will appear as a single display object in this API.

14) Should the raw EDID data be included in the display information?

RESOLVED: No. A future extension could be added which reports the EDID if necessary. This may be complicated by the outcome of issue 13.

15) Should min and max scaling factor capabilities of overlays be exposed?

RESOLVED: Yes. This is exposed indirectly by allowing applications to query the min/max position and extent of the source and destination regions from which image contents are fetched by the display engine when using a particular mode and overlay pair.

16) Should devices be able to expose planes that can be moved between displays? If so, how?

RESOLVED: Yes. Applications can determine which displays a given plane supports using getDisplayPlaneSupportedDisplaysKHR.

17) Should there be a way to destroy display modes? If so, does it support destroying “built in” modes?

RESOLVED: Not in this extension. A future extension could add this functionality.

18) What should the lifetime of display and built-in display mode objects be?

RESOLVED: The lifetime of the instance. These objects cannot be destroyed. A future extension may be added to expose a way to destroy these objects and/or support display hotplug.

19) Should persistent mode for smart panels be enabled/disabled at swapchain creation time, or on a per-present basis.

RESOLVED: On a per-present basis.

Examples

Note

The example code for the VK_KHR_display and VK_KHR_display_swapchain extensions was removed from the appendix after revision 1.0.43. The display enumeration example code was ported to the cube demo that is shipped with the official Khronos SDK, and is being kept up-to-date in that location (see: https://github.com/KhronosGroup/Vulkan-Tools/blob/master/cube/cube.c).

Version History

• Revision 1, 2015-02-24 (James Jones)

  • Initial draft

• Revision 2, 2015-03-12 (Norbert Nopper)

  • Added overlay enumeration for a display.

• Revision 3, 2015-03-17 (Norbert Nopper)

  • Fixed typos and namings as discussed in Bugzilla.
  • Reordered and grouped functions.
  • Added functions to query count of display, mode and overlay.
  • Added native display handle, which may be needed on some platforms to create a native Window.

• Revision 4, 2015-03-18 (Norbert Nopper)

  • Removed primary and virtualPostion members (see comment of James Jones in Bugzilla).
  • Added native overlay handle to information structure.
  • Replaced , with ; in struct.

• Revision 6, 2015-03-18 (Daniel Rakos)

  • Added WSI extension suffix to all items.
  • Made the whole API more “Vulkanish”.
  • Replaced all functions with a single vkGetDisplayInfoKHR function to better match the rest of the API.
  • Made the display, display mode, and overlay objects be first class objects, not subclasses of VkBaseObject as they do not support the common functions anyways.
  • Renamed *Info structures to *Properties.
  • Removed overlayIndex field from VkOverlayProperties as there is an implicit index already as a result of moving to a “Vulkanish” API.
  • Displays are not get through device, but through physical GPU to match the rest of the Vulkan API. Also this is something ISVs explicitly requested.
  • Added issue (6) and (7).

• Revision 7, 2015-03-25 (James Jones)

  • Added an issues section
  • Added rotation and mirroring flags

• Revision 8, 2015-03-25 (James Jones)

  • Combined the duplicate issues sections introduced in last change.
  • Added proposed resolutions to several issues.

• Revision 9, 2015-04-01 (Daniel Rakos)

  • Rebased extension against Vulkan 0.82.0

• Revision 10, 2015-04-01 (James Jones)

  • Added issues (10) and (11).
  • Added more straw-man issue resolutions, and cleaned up the proposed resolution for issue (4).
  • Updated the rotation and mirroring enums to have proper bitmask semantics.

• Revision 11, 2015-04-15 (James Jones)

  • Added proposed resolution for issues (1) and (2).
  • Added issues (12), (13), (14), and (15)
  • Removed pNativeHandle field from overlay structure.
  • Fixed small compilation errors in example code.

• Revision 12, 2015-07-29 (James Jones)

  • Rewrote the guts of the extension against the latest WSI swapchain specifications and the latest Vulkan API.
  • Address overlay planes by their index rather than an object handle and refer to them as “planes” rather than “overlays” to make it slightly clearer that even a display with no “overlays” still has at least one base “plane” that images can be displayed on.
  • Updated most of the issues.
  • Added an “extension type” section to the specification header.
  • Re-used the VK_EXT_KHR_surface surface transform enumerations rather than redefining them here.
  • Updated the example code to use the new semantics.

• Revision 13, 2015-08-21 (Ian Elliott)

  • Renamed this extension and all of its enumerations, types, functions, etc. This makes it compliant with the proposed standard for Vulkan extensions.
  • Switched from “revision” to “version”, including use of the VK_MAKE_VERSION macro in the header file.

• Revision 14, 2015-09-01 (James Jones)

  • Restore single-field revision number.

• Revision 15, 2015-09-08 (James Jones)

  • Added alpha flags enum.
  • Added premultiplied alpha support.

• Revision 16, 2015-09-08 (James Jones)

  • Added description section to the spec.
  • Added issues 16 - 18.

• Revision 17, 2015-10-02 (James Jones)

  • Planes are now a property of the entire device rather than individual displays. This allows planes to be moved between multiple displays on devices that support it.
  • Added a function to create a VkSurfaceKHR object describing a display plane and mode to align with the new per-platform surface creation conventions.
  • Removed detailed mode timing data. It was agreed that the mode extents and refresh rate are sufficient for current use cases. Other information could be added back in as an extension if it is needed in the future.
  • Added support for smart/persistent/buffered display devices.

• Revision 18, 2015-10-26 (Ian Elliott)

  • Renamed from VK_EXT_KHR_display to VK_KHR_display.

• Revision 19, 2015-11-02 (James Jones)

  • Updated example code to match revision 17 changes.

• Revision 20, 2015-11-03 (Daniel Rakos)

  • Added allocation callbacks to creation functions.

• Revision 21, 2015-11-10 (Jesse Hall)

  • Added VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR, and use VkDisplayPlaneAlphaFlagBitsKHR for VkDisplayPlanePropertiesKHR::alphaMode instead of VkDisplayPlaneAlphaFlagsKHR, since it only represents one mode.
  • Added reserved flags bitmask to VkDisplayPlanePropertiesKHR.
  • Use VkSurfaceTransformFlagBitsKHR instead of obsolete VkSurfaceTransformKHR.
  • Renamed vkGetDisplayPlaneSupportedDisplaysKHR parameters for clarity.

• Revision 22, 2015-12-18 (James Jones)

  • Added missing “planeIndex” parameter to vkGetDisplayPlaneSupportedDisplaysKHR()

• Revision 23, 2017-03-13 (James Jones)

  • Closed all remaining issues. The specification and implementations have been shipping with the proposed resolutions for some time now.
  • Removed the sample code and noted it has been integrated into the official Vulkan SDK cube demo.

See Also

DisplayKHR, DisplayModeCreateFlagsKHR, DisplayModeCreateInfoKHR, DisplayModeKHR, DisplayModeParametersKHR, DisplayModePropertiesKHR, DisplayPlaneAlphaFlagBitsKHR, DisplayPlaneAlphaFlagsKHR, DisplayPlaneCapabilitiesKHR, DisplayPlanePropertiesKHR, DisplayPropertiesKHR, DisplaySurfaceCreateFlagsKHR, DisplaySurfaceCreateInfoKHR, SurfaceTransformFlagsKHR, createDisplayModeKHR, createDisplayPlaneSurfaceKHR, getDisplayModePropertiesKHR, getDisplayPlaneCapabilitiesKHR, getDisplayPlaneSupportedDisplaysKHR, getPhysicalDeviceDisplayPlanePropertiesKHR, getPhysicalDeviceDisplayPropertiesKHR

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

getPhysicalDeviceDisplayPropertiesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is a physical device.

-> io (Result, "properties" ::: Vector DisplayPropertiesKHR)

vkGetPhysicalDeviceDisplayPropertiesKHR - Query information about the available displays

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 PhysicalDevice 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 DisplayPropertiesKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_display, DisplayPropertiesKHR, PhysicalDevice

getPhysicalDeviceDisplayPlanePropertiesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is a physical device.

-> io (Result, "properties" ::: Vector DisplayPlanePropertiesKHR)

vkGetPhysicalDeviceDisplayPlanePropertiesKHR - Query the plane properties

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 PhysicalDevice 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 DisplayPlanePropertiesKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_display, DisplayPlanePropertiesKHR, PhysicalDevice

getDisplayPlaneSupportedDisplaysKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is a physical device.

-> ("planeIndex" ::: Word32)

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

-> io (Result, "displays" ::: Vector DisplayKHR)

vkGetDisplayPlaneSupportedDisplaysKHR - Query the list of displays a plane supports

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 getPhysicalDeviceDisplayPlanePropertiesKHR

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice 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 DisplayKHR handles

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_display, DisplayKHR, PhysicalDevice

getDisplayModePropertiesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the physical device associated with display.

-> DisplayKHR

display is the display to query.

-> io (Result, "properties" ::: Vector DisplayModePropertiesKHR)

vkGetDisplayModePropertiesKHR - Query the set of mode properties supported by the display

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 PhysicalDevice handle

• display must be a valid DisplayKHR 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 DisplayModePropertiesKHR structures
• display must have been created, allocated, or retrieved from physicalDevice

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_display, DisplayKHR, DisplayModePropertiesKHR, PhysicalDevice

createDisplayModeKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the physical device associated with display.

-> DisplayKHR

display is the display to create an additional mode for.

-> DisplayModeCreateInfoKHR

pCreateInfo is a pointer to a DisplayModeCreateInfoKHR structure describing the new mode to create.

-> ("allocator" ::: Maybe AllocationCallbacks)

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).

-> io DisplayModeKHR

vkCreateDisplayModeKHR - Create a display mode

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• display must be a valid DisplayKHR handle
• pCreateInfo must be a valid pointer to a valid DisplayModeCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pMode must be a valid pointer to a DisplayModeKHR handle
• display must have been created, allocated, or retrieved from physicalDevice

Host Synchronization

• Host access to display must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

See Also

VK_KHR_display, AllocationCallbacks, DisplayKHR, DisplayModeCreateInfoKHR, DisplayModeKHR, PhysicalDevice

getDisplayPlaneCapabilitiesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the physical device associated with the display specified by mode

-> DisplayModeKHR

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

-> ("planeIndex" ::: Word32)

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

-> io DisplayPlaneCapabilitiesKHR

vkGetDisplayPlaneCapabilitiesKHR - Query capabilities of a mode and plane combination

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• mode must be a valid DisplayModeKHR handle
• pCapabilities must be a valid pointer to a DisplayPlaneCapabilitiesKHR structure

Host Synchronization

• Host access to mode must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_display, DisplayModeKHR, DisplayPlaneCapabilitiesKHR, PhysicalDevice

createDisplayPlaneSurfaceKHR

Arguments

:: forall io. MonadIO io

=> Instance

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

-> DisplaySurfaceCreateInfoKHR

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

-> ("allocator" ::: Maybe AllocationCallbacks)

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

-> io SurfaceKHR

vkCreateDisplayPlaneSurfaceKHR - Create a SurfaceKHR structure representing a display plane and mode

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid DisplaySurfaceCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSurface must be a valid pointer to a SurfaceKHR handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_display, AllocationCallbacks, DisplaySurfaceCreateInfoKHR, Instance, SurfaceKHR

data DisplayPropertiesKHR

VkDisplayPropertiesKHR - Structure describing an available display device

Description

Note

For devices which have no natural value to return here, implementations should return the maximum resolution supported.

Note

Persistent presents may have higher latency, and may use less power when the screen content is updated infrequently, or when only a portion of the screen needs to be updated in most frames.

See Also

VK_KHR_display, Bool32, DisplayKHR, DisplayProperties2KHR, Extent2D, SurfaceTransformFlagsKHR, getPhysicalDeviceDisplayPropertiesKHR

Constructors

DisplayPropertiesKHR

Fields

• display :: DisplayKHR

  display is a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.

• displayName :: ByteString

  displayName is NULL or a pointer to a null-terminated UTF-8 string containing the name of the display. Generally, this will be the name provided by the display’s EDID. If NULL, no suitable name is available. If not NULL, the string pointed to must remain accessible and unmodified as long as display is valid.

• physicalDimensions :: Extent2D

  physicalDimensions describes the physical width and height of the visible portion of the display, in millimeters.

• physicalResolution :: Extent2D

  physicalResolution describes the physical, native, or preferred resolution of the display.

• supportedTransforms :: SurfaceTransformFlagsKHR

  supportedTransforms is a bitmask of SurfaceTransformFlagBitsKHR describing which transforms are supported by this display.

• planeReorderPossible :: Bool

  planeReorderPossible tells whether the planes on this display can have their z order changed. If this is TRUE, the application can re-arrange the planes on this display in any order relative to each other.

• persistentContent :: Bool

  persistentContent tells whether the display supports self-refresh/internal buffering. If this is true, the application can submit persistent present operations on swapchains created against this display.

Instances

Show DisplayPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayPropertiesKHR -> ShowS

show :: DisplayPropertiesKHR -> String

showList :: [DisplayPropertiesKHR] -> ShowS

FromCStruct DisplayPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayPropertiesKHR -> IO DisplayPropertiesKHR

ToCStruct DisplayPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplayPropertiesKHR -> (Ptr DisplayPropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplayPropertiesKHR -> DisplayPropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayPropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayPropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayPropertiesKHR

data DisplayPlanePropertiesKHR

VkDisplayPlanePropertiesKHR - Structure describing display plane properties

See Also

VK_KHR_display, DisplayKHR, DisplayPlaneProperties2KHR, getPhysicalDeviceDisplayPlanePropertiesKHR

Constructors

DisplayPlanePropertiesKHR

Fields

• currentDisplay :: DisplayKHR

  currentDisplay is the handle of the display the plane is currently associated with. If the plane is not currently attached to any displays, this will be NULL_HANDLE.

• currentStackIndex :: Word32

  currentStackIndex is the current z-order of the plane. This will be between 0 and the value returned by getPhysicalDeviceDisplayPlanePropertiesKHR in pPropertyCount.

Instances

Storable DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayPlanePropertiesKHR -> Int

alignment :: DisplayPlanePropertiesKHR -> Int

peekElemOff :: Ptr DisplayPlanePropertiesKHR -> Int -> IO DisplayPlanePropertiesKHR

pokeElemOff :: Ptr DisplayPlanePropertiesKHR -> Int -> DisplayPlanePropertiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayPlanePropertiesKHR

pokeByteOff :: Ptr b -> Int -> DisplayPlanePropertiesKHR -> IO ()

peek :: Ptr DisplayPlanePropertiesKHR -> IO DisplayPlanePropertiesKHR

poke :: Ptr DisplayPlanePropertiesKHR -> DisplayPlanePropertiesKHR -> IO ()

Show DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayPlanePropertiesKHR -> ShowS

show :: DisplayPlanePropertiesKHR -> String

showList :: [DisplayPlanePropertiesKHR] -> ShowS

Eq DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(==) :: DisplayPlanePropertiesKHR -> DisplayPlanePropertiesKHR -> Bool

(/=) :: DisplayPlanePropertiesKHR -> DisplayPlanePropertiesKHR -> Bool

FromCStruct DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayPlanePropertiesKHR -> IO DisplayPlanePropertiesKHR

ToCStruct DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplayPlanePropertiesKHR -> (Ptr DisplayPlanePropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplayPlanePropertiesKHR -> DisplayPlanePropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayPlanePropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayPlanePropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayPlanePropertiesKHR

data DisplayModeParametersKHR

VkDisplayModeParametersKHR - Structure describing display parameters associated with a display mode

Description

Note

For example, a 60Hz display mode would report a refreshRate of 60,000.

Valid Usage

• The width member of visibleRegion must be greater than 0

• The height member of visibleRegion must be greater than 0
• refreshRate must be greater than 0

See Also

VK_KHR_display, DisplayModeCreateInfoKHR, DisplayModePropertiesKHR, Extent2D

Constructors

DisplayModeParametersKHR

Fields

• visibleRegion :: Extent2D

  visibleRegion is the 2D extents of the visible region.

• refreshRate :: Word32

  refreshRate is a uint32_t that is the number of times the display is refreshed each second multiplied by 1000.

Instances

Storable DisplayModeParametersKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayModeParametersKHR -> Int

alignment :: DisplayModeParametersKHR -> Int

peekElemOff :: Ptr DisplayModeParametersKHR -> Int -> IO DisplayModeParametersKHR

pokeElemOff :: Ptr DisplayModeParametersKHR -> Int -> DisplayModeParametersKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayModeParametersKHR

pokeByteOff :: Ptr b -> Int -> DisplayModeParametersKHR -> IO ()

peek :: Ptr DisplayModeParametersKHR -> IO DisplayModeParametersKHR

poke :: Ptr DisplayModeParametersKHR -> DisplayModeParametersKHR -> IO ()

Show DisplayModeParametersKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModeParametersKHR -> ShowS

show :: DisplayModeParametersKHR -> String

showList :: [DisplayModeParametersKHR] -> ShowS

FromCStruct DisplayModeParametersKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayModeParametersKHR -> IO DisplayModeParametersKHR

ToCStruct DisplayModeParametersKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplayModeParametersKHR -> (Ptr DisplayModeParametersKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplayModeParametersKHR -> DisplayModeParametersKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayModeParametersKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayModeParametersKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayModeParametersKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModeParametersKHR

data DisplayModePropertiesKHR

VkDisplayModePropertiesKHR - Structure describing display mode properties

See Also

VK_KHR_display, DisplayModeKHR, DisplayModeParametersKHR, DisplayModeProperties2KHR, getDisplayModePropertiesKHR

Constructors

DisplayModePropertiesKHR

Fields

• displayMode :: DisplayModeKHR

  displayMode is a handle to the display mode described in this structure. This handle will be valid for the lifetime of the Vulkan instance.

• parameters :: DisplayModeParametersKHR

  parameters is a DisplayModeParametersKHR structure describing the display parameters associated with displayMode.

Instances

Storable DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayModePropertiesKHR -> Int

alignment :: DisplayModePropertiesKHR -> Int

peekElemOff :: Ptr DisplayModePropertiesKHR -> Int -> IO DisplayModePropertiesKHR

pokeElemOff :: Ptr DisplayModePropertiesKHR -> Int -> DisplayModePropertiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayModePropertiesKHR

pokeByteOff :: Ptr b -> Int -> DisplayModePropertiesKHR -> IO ()

peek :: Ptr DisplayModePropertiesKHR -> IO DisplayModePropertiesKHR

poke :: Ptr DisplayModePropertiesKHR -> DisplayModePropertiesKHR -> IO ()

Show DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModePropertiesKHR -> ShowS

show :: DisplayModePropertiesKHR -> String

showList :: [DisplayModePropertiesKHR] -> ShowS

FromCStruct DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayModePropertiesKHR -> IO DisplayModePropertiesKHR

ToCStruct DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplayModePropertiesKHR -> (Ptr DisplayModePropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplayModePropertiesKHR -> DisplayModePropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayModePropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayModePropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModePropertiesKHR

data DisplayModeCreateInfoKHR

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

Valid Usage (Implicit)

See Also

VK_KHR_display, DisplayModeCreateFlagsKHR, DisplayModeParametersKHR, StructureType, createDisplayModeKHR

Constructors

DisplayModeCreateInfoKHR

Fields

• flags :: DisplayModeCreateFlagsKHR

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

  flags must be 0

• parameters :: DisplayModeParametersKHR

  parameters is a DisplayModeParametersKHR 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 ERROR_INITIALIZATION_FAILED.

  parameters must be a valid DisplayModeParametersKHR structure

Instances

Storable DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayModeCreateInfoKHR -> Int

alignment :: DisplayModeCreateInfoKHR -> Int

peekElemOff :: Ptr DisplayModeCreateInfoKHR -> Int -> IO DisplayModeCreateInfoKHR

pokeElemOff :: Ptr DisplayModeCreateInfoKHR -> Int -> DisplayModeCreateInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayModeCreateInfoKHR

pokeByteOff :: Ptr b -> Int -> DisplayModeCreateInfoKHR -> IO ()

peek :: Ptr DisplayModeCreateInfoKHR -> IO DisplayModeCreateInfoKHR

poke :: Ptr DisplayModeCreateInfoKHR -> DisplayModeCreateInfoKHR -> IO ()

Show DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModeCreateInfoKHR -> ShowS

show :: DisplayModeCreateInfoKHR -> String

showList :: [DisplayModeCreateInfoKHR] -> ShowS

FromCStruct DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayModeCreateInfoKHR -> IO DisplayModeCreateInfoKHR

ToCStruct DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplayModeCreateInfoKHR -> (Ptr DisplayModeCreateInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplayModeCreateInfoKHR -> DisplayModeCreateInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayModeCreateInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayModeCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModeCreateInfoKHR

data DisplayPlaneCapabilitiesKHR

VkDisplayPlaneCapabilitiesKHR - Structure describing capabilities of a mode and plane combination

Description

The minimum and maximum position and extent fields describe the implementation 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 which 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 which 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.

The value supportedAlpha must contain at least one valid DisplayPlaneAlphaFlagBitsKHR bit.

These values indicate the limits of the implementation’s individual fields. Not all combinations of values within the offset and extent ranges returned in DisplayPlaneCapabilitiesKHR are guaranteed to be supported. Presentation requests specifying unsupported combinations may fail.

See Also

VK_KHR_display, DisplayPlaneAlphaFlagsKHR, DisplayPlaneCapabilities2KHR, Extent2D, Offset2D, getDisplayPlaneCapabilitiesKHR

Constructors

DisplayPlaneCapabilitiesKHR

Fields

• supportedAlpha :: DisplayPlaneAlphaFlagsKHR

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

• minSrcPosition :: Offset2D

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

• maxSrcPosition :: Offset2D

  maxSrcPosition is the maximum source rectangle offset supported by this plane using the specified mode. The x and y components of maxSrcPosition must each be greater than or equal to the x and y components of minSrcPosition, respectively.

• minSrcExtent :: Extent2D

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

• maxSrcExtent :: Extent2D

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

• minDstPosition :: Offset2D

  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.

• maxDstPosition :: Offset2D
• minDstExtent :: Extent2D
• maxDstExtent :: Extent2D

Instances

Storable DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayPlaneCapabilitiesKHR -> Int

alignment :: DisplayPlaneCapabilitiesKHR -> Int

peekElemOff :: Ptr DisplayPlaneCapabilitiesKHR -> Int -> IO DisplayPlaneCapabilitiesKHR

pokeElemOff :: Ptr DisplayPlaneCapabilitiesKHR -> Int -> DisplayPlaneCapabilitiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayPlaneCapabilitiesKHR

pokeByteOff :: Ptr b -> Int -> DisplayPlaneCapabilitiesKHR -> IO ()

peek :: Ptr DisplayPlaneCapabilitiesKHR -> IO DisplayPlaneCapabilitiesKHR

poke :: Ptr DisplayPlaneCapabilitiesKHR -> DisplayPlaneCapabilitiesKHR -> IO ()

Show DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayPlaneCapabilitiesKHR -> ShowS

show :: DisplayPlaneCapabilitiesKHR -> String

showList :: [DisplayPlaneCapabilitiesKHR] -> ShowS

FromCStruct DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayPlaneCapabilitiesKHR -> IO DisplayPlaneCapabilitiesKHR

ToCStruct DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplayPlaneCapabilitiesKHR -> (Ptr DisplayPlaneCapabilitiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplayPlaneCapabilitiesKHR -> DisplayPlaneCapabilitiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayPlaneCapabilitiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayPlaneCapabilitiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayPlaneCapabilitiesKHR

data DisplaySurfaceCreateInfoKHR

VkDisplaySurfaceCreateInfoKHR - Structure specifying parameters of a newly created display plane surface object

Description

Note

Creating a display surface must not modify the state of the displays, planes, or other resources it names. For example, it must not apply the specified mode to be set on the associated display. Application of display configuration occurs as a side effect of presenting to a display surface.

Valid Usage

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

• If the planeReorderPossible member of the DisplayPropertiesKHR structure returned by getPhysicalDeviceDisplayPropertiesKHR for the display corresponding to displayMode is TRUE then planeStackIndex must be less than the number of display planes supported by the device as determined by calling getPhysicalDeviceDisplayPlanePropertiesKHR; otherwise planeStackIndex must equal the currentStackIndex member of DisplayPlanePropertiesKHR returned by getPhysicalDeviceDisplayPlanePropertiesKHR for the display plane corresponding to displayMode
• If alphaMode is DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR then globalAlpha must be between 0 and 1, inclusive
• alphaMode must be one of the bits present in the supportedAlpha member of DisplayPlaneCapabilitiesKHR for the display plane corresponding to displayMode
• transform must be one of the bits present in the supportedTransforms member of DisplayPropertiesKHR for the display corresponding to displayMode
• The width and height members of imageExtent must be less than or equal to PhysicalDeviceLimits::maxImageDimension2D

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

• pNext must be NULL
• flags must be 0
• displayMode must be a valid DisplayModeKHR handle
• transform must be a valid SurfaceTransformFlagBitsKHR value
• alphaMode must be a valid DisplayPlaneAlphaFlagBitsKHR value

See Also

VK_KHR_display, DisplayModeKHR, DisplayPlaneAlphaFlagBitsKHR, DisplaySurfaceCreateFlagsKHR, Extent2D, StructureType, SurfaceTransformFlagBitsKHR, createDisplayPlaneSurfaceKHR

Constructors

DisplaySurfaceCreateInfoKHR

Fields

• flags :: DisplaySurfaceCreateFlagsKHR

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

• displayMode :: DisplayModeKHR

  displayMode is a DisplayModeKHR handle specifying the mode to use when displaying this surface.

• planeIndex :: Word32

  planeIndex is the plane on which this surface appears.

• planeStackIndex :: Word32

  planeStackIndex is the z-order of the plane.

• transform :: SurfaceTransformFlagBitsKHR

  transform is a SurfaceTransformFlagBitsKHR value specifying the transformation to apply to images as part of the scanout operation.

• globalAlpha :: Float

  globalAlpha is the global alpha value. This value is ignored if alphaMode is not DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR.

• alphaMode :: DisplayPlaneAlphaFlagBitsKHR

  alphaMode is a DisplayPlaneAlphaFlagBitsKHR value specifying the type of alpha blending to use.

• imageExtent :: Extent2D

  imageExtent is the size of the presentable images to use with the surface.

Instances

Storable DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplaySurfaceCreateInfoKHR -> Int

alignment :: DisplaySurfaceCreateInfoKHR -> Int

peekElemOff :: Ptr DisplaySurfaceCreateInfoKHR -> Int -> IO DisplaySurfaceCreateInfoKHR

pokeElemOff :: Ptr DisplaySurfaceCreateInfoKHR -> Int -> DisplaySurfaceCreateInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplaySurfaceCreateInfoKHR

pokeByteOff :: Ptr b -> Int -> DisplaySurfaceCreateInfoKHR -> IO ()

peek :: Ptr DisplaySurfaceCreateInfoKHR -> IO DisplaySurfaceCreateInfoKHR

poke :: Ptr DisplaySurfaceCreateInfoKHR -> DisplaySurfaceCreateInfoKHR -> IO ()

Show DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplaySurfaceCreateInfoKHR -> ShowS

show :: DisplaySurfaceCreateInfoKHR -> String

showList :: [DisplaySurfaceCreateInfoKHR] -> ShowS

FromCStruct DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplaySurfaceCreateInfoKHR -> IO DisplaySurfaceCreateInfoKHR

ToCStruct DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

withCStruct :: DisplaySurfaceCreateInfoKHR -> (Ptr DisplaySurfaceCreateInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr DisplaySurfaceCreateInfoKHR -> DisplaySurfaceCreateInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DisplaySurfaceCreateInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplaySurfaceCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplaySurfaceCreateInfoKHR

newtype DisplayModeCreateFlagsKHR

VkDisplayModeCreateFlagsKHR - Reserved for future use

Description

DisplayModeCreateFlagsKHR is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_KHR_display, DisplayModeCreateInfoKHR

Constructors

DisplayModeCreateFlagsKHR Flags

Instances

Bits DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(.&.) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

(.|.) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

xor :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

complement :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

shift :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

rotate :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

zeroBits :: DisplayModeCreateFlagsKHR

bit :: Int -> DisplayModeCreateFlagsKHR

setBit :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

clearBit :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

complementBit :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

testBit :: DisplayModeCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: DisplayModeCreateFlagsKHR -> Maybe Int

bitSize :: DisplayModeCreateFlagsKHR -> Int

isSigned :: DisplayModeCreateFlagsKHR -> Bool

shiftL :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

unsafeShiftL :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

shiftR :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

unsafeShiftR :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

rotateL :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

rotateR :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

popCount :: DisplayModeCreateFlagsKHR -> Int

FiniteBits DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

finiteBitSize :: DisplayModeCreateFlagsKHR -> Int

countLeadingZeros :: DisplayModeCreateFlagsKHR -> Int

countTrailingZeros :: DisplayModeCreateFlagsKHR -> Int

Storable DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayModeCreateFlagsKHR -> Int

alignment :: DisplayModeCreateFlagsKHR -> Int

peekElemOff :: Ptr DisplayModeCreateFlagsKHR -> Int -> IO DisplayModeCreateFlagsKHR

pokeElemOff :: Ptr DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayModeCreateFlagsKHR

pokeByteOff :: Ptr b -> Int -> DisplayModeCreateFlagsKHR -> IO ()

peek :: Ptr DisplayModeCreateFlagsKHR -> IO DisplayModeCreateFlagsKHR

poke :: Ptr DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> IO ()

Read DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

readsPrec :: Int -> ReadS DisplayModeCreateFlagsKHR

readList :: ReadS [DisplayModeCreateFlagsKHR]

readPrec :: ReadPrec DisplayModeCreateFlagsKHR

readListPrec :: ReadPrec [DisplayModeCreateFlagsKHR]

Show DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModeCreateFlagsKHR -> ShowS

show :: DisplayModeCreateFlagsKHR -> String

showList :: [DisplayModeCreateFlagsKHR] -> ShowS

Eq DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(==) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Bool

(/=) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Bool

Ord DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

compare :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Ordering

(<) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Bool

(<=) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Bool

(>) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Bool

(>=) :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Bool

max :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

min :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

Zero DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModeCreateFlagsKHR

newtype DisplaySurfaceCreateFlagsKHR

VkDisplaySurfaceCreateFlagsKHR - Reserved for future use

Description

DisplaySurfaceCreateFlagsKHR is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_KHR_display, DisplaySurfaceCreateInfoKHR

Constructors

DisplaySurfaceCreateFlagsKHR Flags

Instances

Bits DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(.&.) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

(.|.) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

xor :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

complement :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

shift :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

rotate :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

zeroBits :: DisplaySurfaceCreateFlagsKHR

bit :: Int -> DisplaySurfaceCreateFlagsKHR

setBit :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

clearBit :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

complementBit :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

testBit :: DisplaySurfaceCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: DisplaySurfaceCreateFlagsKHR -> Maybe Int

bitSize :: DisplaySurfaceCreateFlagsKHR -> Int

isSigned :: DisplaySurfaceCreateFlagsKHR -> Bool

shiftL :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

unsafeShiftL :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

shiftR :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

unsafeShiftR :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

rotateL :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

rotateR :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

popCount :: DisplaySurfaceCreateFlagsKHR -> Int

FiniteBits DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

finiteBitSize :: DisplaySurfaceCreateFlagsKHR -> Int

countLeadingZeros :: DisplaySurfaceCreateFlagsKHR -> Int

countTrailingZeros :: DisplaySurfaceCreateFlagsKHR -> Int

Storable DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplaySurfaceCreateFlagsKHR -> Int

alignment :: DisplaySurfaceCreateFlagsKHR -> Int

peekElemOff :: Ptr DisplaySurfaceCreateFlagsKHR -> Int -> IO DisplaySurfaceCreateFlagsKHR

pokeElemOff :: Ptr DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplaySurfaceCreateFlagsKHR

pokeByteOff :: Ptr b -> Int -> DisplaySurfaceCreateFlagsKHR -> IO ()

peek :: Ptr DisplaySurfaceCreateFlagsKHR -> IO DisplaySurfaceCreateFlagsKHR

poke :: Ptr DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> IO ()

Read DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

readsPrec :: Int -> ReadS DisplaySurfaceCreateFlagsKHR

readList :: ReadS [DisplaySurfaceCreateFlagsKHR]

readPrec :: ReadPrec DisplaySurfaceCreateFlagsKHR

readListPrec :: ReadPrec [DisplaySurfaceCreateFlagsKHR]

Show DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplaySurfaceCreateFlagsKHR -> ShowS

show :: DisplaySurfaceCreateFlagsKHR -> String

showList :: [DisplaySurfaceCreateFlagsKHR] -> ShowS

Eq DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(==) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Bool

(/=) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Bool

Ord DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

compare :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Ordering

(<) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Bool

(<=) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Bool

(>) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Bool

(>=) :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Bool

max :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

min :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

Zero DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplaySurfaceCreateFlagsKHR

type DisplayPlaneAlphaFlagsKHR = DisplayPlaneAlphaFlagBitsKHR

newtype DisplayPlaneAlphaFlagBitsKHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

See Also

VK_KHR_display, DisplayPlaneAlphaFlagsKHR, DisplaySurfaceCreateInfoKHR

Constructors

DisplayPlaneAlphaFlagBitsKHR Flags

Bundled Patterns

pattern DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR

DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.

pattern DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR

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.

pattern DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR

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.

pattern DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR

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.

Instances

Bits DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(.&.) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR

(.|.) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR

xor :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR

complement :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR

shift :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

rotate :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

zeroBits :: DisplayPlaneAlphaFlagBitsKHR

bit :: Int -> DisplayPlaneAlphaFlagBitsKHR

setBit :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

clearBit :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

complementBit :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

testBit :: DisplayPlaneAlphaFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: DisplayPlaneAlphaFlagBitsKHR -> Maybe Int

bitSize :: DisplayPlaneAlphaFlagBitsKHR -> Int

isSigned :: DisplayPlaneAlphaFlagBitsKHR -> Bool

shiftL :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

unsafeShiftL :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

shiftR :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

unsafeShiftR :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

rotateL :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

rotateR :: DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR

popCount :: DisplayPlaneAlphaFlagBitsKHR -> Int

FiniteBits DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

finiteBitSize :: DisplayPlaneAlphaFlagBitsKHR -> Int

countLeadingZeros :: DisplayPlaneAlphaFlagBitsKHR -> Int

countTrailingZeros :: DisplayPlaneAlphaFlagBitsKHR -> Int

Storable DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayPlaneAlphaFlagBitsKHR -> Int

alignment :: DisplayPlaneAlphaFlagBitsKHR -> Int

peekElemOff :: Ptr DisplayPlaneAlphaFlagBitsKHR -> Int -> IO DisplayPlaneAlphaFlagBitsKHR

pokeElemOff :: Ptr DisplayPlaneAlphaFlagBitsKHR -> Int -> DisplayPlaneAlphaFlagBitsKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayPlaneAlphaFlagBitsKHR

pokeByteOff :: Ptr b -> Int -> DisplayPlaneAlphaFlagBitsKHR -> IO ()

peek :: Ptr DisplayPlaneAlphaFlagBitsKHR -> IO DisplayPlaneAlphaFlagBitsKHR

poke :: Ptr DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> IO ()

Read DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

readsPrec :: Int -> ReadS DisplayPlaneAlphaFlagBitsKHR

readList :: ReadS [DisplayPlaneAlphaFlagBitsKHR]

readPrec :: ReadPrec DisplayPlaneAlphaFlagBitsKHR

readListPrec :: ReadPrec [DisplayPlaneAlphaFlagBitsKHR]

Show DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayPlaneAlphaFlagBitsKHR -> ShowS

show :: DisplayPlaneAlphaFlagBitsKHR -> String

showList :: [DisplayPlaneAlphaFlagBitsKHR] -> ShowS

Eq DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

(==) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Bool

(/=) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Bool

Ord DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

compare :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Ordering

(<) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Bool

(<=) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Bool

(>) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Bool

(>=) :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> Bool

max :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR

min :: DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR -> DisplayPlaneAlphaFlagBitsKHR

Zero DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayPlaneAlphaFlagBitsKHR

type KHR_DISPLAY_SPEC_VERSION = 23

pattern KHR_DISPLAY_SPEC_VERSION :: forall a. Integral a => a

type KHR_DISPLAY_EXTENSION_NAME = "VK_KHR_display"

pattern KHR_DISPLAY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype DisplayKHR

VkDisplayKHR - Opaque handle to a display object

See Also

VK_KHR_display, DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireDrmDisplayEXT, acquireWinrtDisplayNV, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getDrmDisplayEXT, getRandROutputDisplayEXT, getWinrtDisplayNV, registerDisplayEventEXT, releaseDisplayEXT

Constructors

DisplayKHR Word64

Instances

Storable DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: DisplayKHR -> Int

alignment :: DisplayKHR -> Int

peekElemOff :: Ptr DisplayKHR -> Int -> IO DisplayKHR

pokeElemOff :: Ptr DisplayKHR -> Int -> DisplayKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayKHR

pokeByteOff :: Ptr b -> Int -> DisplayKHR -> IO ()

peek :: Ptr DisplayKHR -> IO DisplayKHR

poke :: Ptr DisplayKHR -> DisplayKHR -> IO ()

Show DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayKHR -> ShowS

show :: DisplayKHR -> String

showList :: [DisplayKHR] -> ShowS

Eq DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: DisplayKHR -> DisplayKHR -> Bool

(/=) :: DisplayKHR -> DisplayKHR -> Bool

Ord DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: DisplayKHR -> DisplayKHR -> Ordering

(<) :: DisplayKHR -> DisplayKHR -> Bool

(<=) :: DisplayKHR -> DisplayKHR -> Bool

(>) :: DisplayKHR -> DisplayKHR -> Bool

(>=) :: DisplayKHR -> DisplayKHR -> Bool

max :: DisplayKHR -> DisplayKHR -> DisplayKHR

min :: DisplayKHR -> DisplayKHR -> DisplayKHR

HasObjectType DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayKHR -> (ObjectType, Word64)

IsHandle DisplayKHR

Defined in Vulkan.Extensions.Handles

Zero DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayKHR

newtype DisplayModeKHR

VkDisplayModeKHR - Opaque handle to a display mode object

See Also

VK_KHR_display, DisplayModePropertiesKHR, DisplayPlaneInfo2KHR, DisplaySurfaceCreateInfoKHR, createDisplayModeKHR, getDisplayPlaneCapabilitiesKHR

Constructors

DisplayModeKHR Word64

Instances

Storable DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: DisplayModeKHR -> Int

alignment :: DisplayModeKHR -> Int

peekElemOff :: Ptr DisplayModeKHR -> Int -> IO DisplayModeKHR

pokeElemOff :: Ptr DisplayModeKHR -> Int -> DisplayModeKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayModeKHR

pokeByteOff :: Ptr b -> Int -> DisplayModeKHR -> IO ()

peek :: Ptr DisplayModeKHR -> IO DisplayModeKHR

poke :: Ptr DisplayModeKHR -> DisplayModeKHR -> IO ()

Show DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayModeKHR -> ShowS

show :: DisplayModeKHR -> String

showList :: [DisplayModeKHR] -> ShowS

Eq DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: DisplayModeKHR -> DisplayModeKHR -> Bool

(/=) :: DisplayModeKHR -> DisplayModeKHR -> Bool

Ord DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: DisplayModeKHR -> DisplayModeKHR -> Ordering

(<) :: DisplayModeKHR -> DisplayModeKHR -> Bool

(<=) :: DisplayModeKHR -> DisplayModeKHR -> Bool

(>) :: DisplayModeKHR -> DisplayModeKHR -> Bool

(>=) :: DisplayModeKHR -> DisplayModeKHR -> Bool

max :: DisplayModeKHR -> DisplayModeKHR -> DisplayModeKHR

min :: DisplayModeKHR -> DisplayModeKHR -> DisplayModeKHR

HasObjectType DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayModeKHR -> (ObjectType, Word64)

IsHandle DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Zero DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayModeKHR

newtype SurfaceKHR

VkSurfaceKHR - Opaque handle to a surface object

Description

The VK_KHR_surface extension declares the SurfaceKHR object, and provides a function for destroying SurfaceKHR objects. Separate platform-specific extensions each provide a function for creating a SurfaceKHR object for the respective platform. From the application’s perspective this is an opaque handle, just like the handles of other Vulkan objects.

See Also

VK_KHR_surface, PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createScreenSurfaceQNX, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64

Instances

Storable SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SurfaceKHR -> Int

alignment :: SurfaceKHR -> Int

peekElemOff :: Ptr SurfaceKHR -> Int -> IO SurfaceKHR

pokeElemOff :: Ptr SurfaceKHR -> Int -> SurfaceKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO SurfaceKHR

pokeByteOff :: Ptr b -> Int -> SurfaceKHR -> IO ()

peek :: Ptr SurfaceKHR -> IO SurfaceKHR

poke :: Ptr SurfaceKHR -> SurfaceKHR -> IO ()

Show SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

Eq SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: SurfaceKHR -> SurfaceKHR -> Bool

(/=) :: SurfaceKHR -> SurfaceKHR -> Bool

Ord SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SurfaceKHR -> SurfaceKHR -> Ordering

(<) :: SurfaceKHR -> SurfaceKHR -> Bool

(<=) :: SurfaceKHR -> SurfaceKHR -> Bool

(>) :: SurfaceKHR -> SurfaceKHR -> Bool

(>=) :: SurfaceKHR -> SurfaceKHR -> Bool

max :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

min :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles

Zero SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR

newtype SurfaceTransformFlagBitsKHR

VkSurfaceTransformFlagBitsKHR - Presentation transforms supported on a device

See Also

VK_KHR_surface, CommandBufferInheritanceRenderPassTransformInfoQCOM, CopyCommandTransformInfoQCOM, DisplaySurfaceCreateInfoKHR, RenderPassTransformBeginInfoQCOM, SurfaceCapabilities2EXT, SurfaceCapabilitiesKHR, SurfaceTransformFlagsKHR, SwapchainCreateInfoKHR

Constructors

SurfaceTransformFlagBitsKHR Flags

Bundled Patterns

pattern SURFACE_TRANSFORM_IDENTITY_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_IDENTITY_BIT_KHR specifies that image content is presented without being transformed.

pattern SURFACE_TRANSFORM_ROTATE_90_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_ROTATE_90_BIT_KHR specifies that image content is rotated 90 degrees clockwise.

pattern SURFACE_TRANSFORM_ROTATE_180_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_ROTATE_180_BIT_KHR specifies that image content is rotated 180 degrees clockwise.

pattern SURFACE_TRANSFORM_ROTATE_270_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_ROTATE_270_BIT_KHR specifies that image content is rotated 270 degrees clockwise.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR specifies that image content is mirrored horizontally.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR specifies that image content is mirrored horizontally, then rotated 90 degrees clockwise.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR specifies that image content is mirrored horizontally, then rotated 180 degrees clockwise.

pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR specifies that image content is mirrored horizontally, then rotated 270 degrees clockwise.

pattern SURFACE_TRANSFORM_INHERIT_BIT_KHR :: SurfaceTransformFlagBitsKHR

SURFACE_TRANSFORM_INHERIT_BIT_KHR specifies that the presentation transform is not specified, and is instead determined by platform-specific considerations and mechanisms outside Vulkan.

Instances

Bits SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

(.&.) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

(.|.) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

xor :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

complement :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

shift :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

rotate :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

zeroBits :: SurfaceTransformFlagBitsKHR

bit :: Int -> SurfaceTransformFlagBitsKHR

setBit :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

clearBit :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

complementBit :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

testBit :: SurfaceTransformFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: SurfaceTransformFlagBitsKHR -> Maybe Int

bitSize :: SurfaceTransformFlagBitsKHR -> Int

isSigned :: SurfaceTransformFlagBitsKHR -> Bool

shiftL :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

unsafeShiftL :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

shiftR :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

unsafeShiftR :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

rotateL :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

rotateR :: SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR

popCount :: SurfaceTransformFlagBitsKHR -> Int

FiniteBits SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

finiteBitSize :: SurfaceTransformFlagBitsKHR -> Int

countLeadingZeros :: SurfaceTransformFlagBitsKHR -> Int

countTrailingZeros :: SurfaceTransformFlagBitsKHR -> Int

Storable SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

sizeOf :: SurfaceTransformFlagBitsKHR -> Int

alignment :: SurfaceTransformFlagBitsKHR -> Int

peekElemOff :: Ptr SurfaceTransformFlagBitsKHR -> Int -> IO SurfaceTransformFlagBitsKHR

pokeElemOff :: Ptr SurfaceTransformFlagBitsKHR -> Int -> SurfaceTransformFlagBitsKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO SurfaceTransformFlagBitsKHR

pokeByteOff :: Ptr b -> Int -> SurfaceTransformFlagBitsKHR -> IO ()

peek :: Ptr SurfaceTransformFlagBitsKHR -> IO SurfaceTransformFlagBitsKHR

poke :: Ptr SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> IO ()

Read SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

readsPrec :: Int -> ReadS SurfaceTransformFlagBitsKHR

readList :: ReadS [SurfaceTransformFlagBitsKHR]

readPrec :: ReadPrec SurfaceTransformFlagBitsKHR

readListPrec :: ReadPrec [SurfaceTransformFlagBitsKHR]

Show SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

showsPrec :: Int -> SurfaceTransformFlagBitsKHR -> ShowS

show :: SurfaceTransformFlagBitsKHR -> String

showList :: [SurfaceTransformFlagBitsKHR] -> ShowS

Eq SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

(==) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

(/=) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

Ord SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

compare :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Ordering

(<) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

(<=) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

(>) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

(>=) :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> Bool

max :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

min :: SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR -> SurfaceTransformFlagBitsKHR

Zero SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

zero :: SurfaceTransformFlagBitsKHR

type SurfaceTransformFlagsKHR = SurfaceTransformFlagBitsKHR