Vulkan.Extensions.VK_KHR_get_display_properties2

Name

VK_KHR_get_display_properties2 - instance extension

VK_KHR_get_display_properties2

Name String

VK_KHR_get_display_properties2

Extension Type

Instance extension

Registered Extension Number

122

Revision

1

Extension and Version Dependencies

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

Contact

• James Jones @cubanismo%0A*Here describe the issue or question you have about the VK_KHR_get_display_properties2 extension*

Other Extension Metadata

Last Modified Date

2017-02-21

IP Status

No known IP claims.

Contributors

• Ian Elliott, Google
• James Jones, NVIDIA

Description

This extension provides new entry points to query device display properties and capabilities in a way that can be easily extended by other extensions, without introducing any further entry points. This extension can be considered the VK_KHR_display equivalent of the VK_KHR_get_physical_device_properties2 extension.

New Commands

• getDisplayModeProperties2KHR

• getDisplayPlaneCapabilities2KHR
• getPhysicalDeviceDisplayPlaneProperties2KHR
• getPhysicalDeviceDisplayProperties2KHR

New Structures

• DisplayModeProperties2KHR

• DisplayPlaneCapabilities2KHR
• DisplayPlaneInfo2KHR
• DisplayPlaneProperties2KHR
• DisplayProperties2KHR

New Enum Constants

• KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME

• KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
  • STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR
  • STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
  • STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
  • STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR

Issues

1) What should this extension be named?

RESOLVED: VK_KHR_get_display_properties2. Other alternatives:

• VK_KHR_display2

• One extension, combined with VK_KHR_surface_capabilites2.

2) Should extensible input structs be added for these new functions:

RESOLVED:

• getPhysicalDeviceDisplayProperties2KHR: No. The only current input is a PhysicalDevice. Other inputs would not make sense.
• getPhysicalDeviceDisplayPlaneProperties2KHR: No. The only current input is a PhysicalDevice. Other inputs would not make sense.
• getDisplayModeProperties2KHR: No. The only current inputs are a PhysicalDevice and a DisplayModeKHR. Other inputs would not make sense.

3) Should additional display query functions be extended?

RESOLVED:

• getDisplayPlaneSupportedDisplaysKHR: No. Extensions should instead extend getDisplayPlaneCapabilitiesKHR().

Version History

• Revision 1, 2017-02-21 (James Jones)

  • Initial draft.

See Also

DisplayModeProperties2KHR, DisplayPlaneCapabilities2KHR, DisplayPlaneInfo2KHR, DisplayPlaneProperties2KHR, DisplayProperties2KHR, getDisplayModeProperties2KHR, getDisplayPlaneCapabilities2KHR, getPhysicalDeviceDisplayPlaneProperties2KHR, getPhysicalDeviceDisplayProperties2KHR

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

getPhysicalDeviceDisplayProperties2KHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is a physical device.

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

vkGetPhysicalDeviceDisplayProperties2KHR - Query information about the available displays

Description

getPhysicalDeviceDisplayProperties2KHR behaves similarly to getPhysicalDeviceDisplayPropertiesKHR, with the ability to return extended information via chained output structures.

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 DisplayProperties2KHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_get_display_properties2, DisplayProperties2KHR, PhysicalDevice

getPhysicalDeviceDisplayPlaneProperties2KHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is a physical device.

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

vkGetPhysicalDeviceDisplayPlaneProperties2KHR - Query information about the available display planes.

Description

getPhysicalDeviceDisplayPlaneProperties2KHR behaves similarly to getPhysicalDeviceDisplayPlanePropertiesKHR, with the ability to return extended information via chained output structures.

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 DisplayPlaneProperties2KHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_get_display_properties2, DisplayPlaneProperties2KHR, PhysicalDevice

getDisplayModeProperties2KHR

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

vkGetDisplayModeProperties2KHR - Query information about the available display modes.

Description

getDisplayModeProperties2KHR behaves similarly to getDisplayModePropertiesKHR, with the ability to return extended information via chained output structures.

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 DisplayModeProperties2KHR 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_get_display_properties2, DisplayKHR, DisplayModeProperties2KHR, PhysicalDevice

getDisplayPlaneCapabilities2KHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the physical device associated with pDisplayPlaneInfo.

physicalDevice must be a valid PhysicalDevice handle

-> DisplayPlaneInfo2KHR

pDisplayPlaneInfo is a pointer to a DisplayPlaneInfo2KHR structure describing the plane and mode.

pDisplayPlaneInfo must be a valid pointer to a valid DisplayPlaneInfo2KHR structure

-> io DisplayPlaneCapabilities2KHR

vkGetDisplayPlaneCapabilities2KHR - Query capabilities of a mode and plane combination

Description

getDisplayPlaneCapabilities2KHR behaves similarly to getDisplayPlaneCapabilitiesKHR, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_get_display_properties2, DisplayPlaneCapabilities2KHR, DisplayPlaneInfo2KHR, PhysicalDevice

data DisplayProperties2KHR

VkDisplayProperties2KHR - Structure describing an available display device

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayPropertiesKHR, StructureType, getPhysicalDeviceDisplayProperties2KHR

Constructors

DisplayProperties2KHR

Fields

• displayProperties :: DisplayPropertiesKHR

  displayProperties is a DisplayPropertiesKHR structure.

Instances

Show DisplayProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

showsPrec :: Int -> DisplayProperties2KHR -> ShowS

show :: DisplayProperties2KHR -> String

showList :: [DisplayProperties2KHR] -> ShowS

FromCStruct DisplayProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

peekCStruct :: Ptr DisplayProperties2KHR -> IO DisplayProperties2KHR

ToCStruct DisplayProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

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

pokeCStruct :: Ptr DisplayProperties2KHR -> DisplayProperties2KHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DisplayProperties2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

zero :: DisplayProperties2KHR

data DisplayPlaneProperties2KHR

VkDisplayPlaneProperties2KHR - Structure describing an available display plane

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayPlanePropertiesKHR, StructureType, getPhysicalDeviceDisplayPlaneProperties2KHR

Constructors

DisplayPlaneProperties2KHR

Fields

• displayPlaneProperties :: DisplayPlanePropertiesKHR

  displayPlaneProperties is a DisplayPlanePropertiesKHR structure.

Instances

Storable DisplayPlaneProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

sizeOf :: DisplayPlaneProperties2KHR -> Int

alignment :: DisplayPlaneProperties2KHR -> Int

peekElemOff :: Ptr DisplayPlaneProperties2KHR -> Int -> IO DisplayPlaneProperties2KHR

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

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

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

peek :: Ptr DisplayPlaneProperties2KHR -> IO DisplayPlaneProperties2KHR

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

Show DisplayPlaneProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

showsPrec :: Int -> DisplayPlaneProperties2KHR -> ShowS

show :: DisplayPlaneProperties2KHR -> String

showList :: [DisplayPlaneProperties2KHR] -> ShowS

FromCStruct DisplayPlaneProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

peekCStruct :: Ptr DisplayPlaneProperties2KHR -> IO DisplayPlaneProperties2KHR

ToCStruct DisplayPlaneProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

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

pokeCStruct :: Ptr DisplayPlaneProperties2KHR -> DisplayPlaneProperties2KHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DisplayPlaneProperties2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPlaneProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

zero :: DisplayPlaneProperties2KHR

data DisplayModeProperties2KHR

VkDisplayModeProperties2KHR - Structure describing an available display mode

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayModePropertiesKHR, StructureType, getDisplayModeProperties2KHR

Constructors

DisplayModeProperties2KHR

Fields

• displayModeProperties :: DisplayModePropertiesKHR

  displayModeProperties is a DisplayModePropertiesKHR structure.

Instances

Storable DisplayModeProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

sizeOf :: DisplayModeProperties2KHR -> Int

alignment :: DisplayModeProperties2KHR -> Int

peekElemOff :: Ptr DisplayModeProperties2KHR -> Int -> IO DisplayModeProperties2KHR

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

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

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

peek :: Ptr DisplayModeProperties2KHR -> IO DisplayModeProperties2KHR

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

Show DisplayModeProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

showsPrec :: Int -> DisplayModeProperties2KHR -> ShowS

show :: DisplayModeProperties2KHR -> String

showList :: [DisplayModeProperties2KHR] -> ShowS

FromCStruct DisplayModeProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

peekCStruct :: Ptr DisplayModeProperties2KHR -> IO DisplayModeProperties2KHR

ToCStruct DisplayModeProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

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

pokeCStruct :: Ptr DisplayModeProperties2KHR -> DisplayModeProperties2KHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DisplayModeProperties2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayModeProperties2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

zero :: DisplayModeProperties2KHR

data DisplayPlaneInfo2KHR

VkDisplayPlaneInfo2KHR - Structure defining the intended configuration of a display plane

Description

Note

This parameter also implicitly specifies a display.

• planeIndex is the plane which the application intends to use with the display.

The members of DisplayPlaneInfo2KHR correspond to the arguments to getDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

• pNext must be NULL
• mode must be a valid DisplayModeKHR handle

Host Synchronization

• Host access to mode must be externally synchronized

See Also

VK_KHR_get_display_properties2, DisplayModeKHR, StructureType, getDisplayPlaneCapabilities2KHR

Constructors

DisplayPlaneInfo2KHR

Fields

• mode :: DisplayModeKHR

  mode is the display mode the application intends to program when using the specified plane.

• planeIndex :: Word32

Instances

Storable DisplayPlaneInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

sizeOf :: DisplayPlaneInfo2KHR -> Int

alignment :: DisplayPlaneInfo2KHR -> Int

peekElemOff :: Ptr DisplayPlaneInfo2KHR -> Int -> IO DisplayPlaneInfo2KHR

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

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

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

peek :: Ptr DisplayPlaneInfo2KHR -> IO DisplayPlaneInfo2KHR

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

Show DisplayPlaneInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

showsPrec :: Int -> DisplayPlaneInfo2KHR -> ShowS

show :: DisplayPlaneInfo2KHR -> String

showList :: [DisplayPlaneInfo2KHR] -> ShowS

Eq DisplayPlaneInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

(==) :: DisplayPlaneInfo2KHR -> DisplayPlaneInfo2KHR -> Bool

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

FromCStruct DisplayPlaneInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

peekCStruct :: Ptr DisplayPlaneInfo2KHR -> IO DisplayPlaneInfo2KHR

ToCStruct DisplayPlaneInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

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

pokeCStruct :: Ptr DisplayPlaneInfo2KHR -> DisplayPlaneInfo2KHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DisplayPlaneInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPlaneInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

zero :: DisplayPlaneInfo2KHR

data DisplayPlaneCapabilities2KHR

VkDisplayPlaneCapabilities2KHR - Structure describing the capabilities of a mode and plane combination

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayPlaneCapabilitiesKHR, StructureType, getDisplayPlaneCapabilities2KHR

Constructors

DisplayPlaneCapabilities2KHR

Fields

• capabilities :: DisplayPlaneCapabilitiesKHR

  capabilities is a DisplayPlaneCapabilitiesKHR structure.

Instances

Storable DisplayPlaneCapabilities2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

sizeOf :: DisplayPlaneCapabilities2KHR -> Int

alignment :: DisplayPlaneCapabilities2KHR -> Int

peekElemOff :: Ptr DisplayPlaneCapabilities2KHR -> Int -> IO DisplayPlaneCapabilities2KHR

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

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

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

peek :: Ptr DisplayPlaneCapabilities2KHR -> IO DisplayPlaneCapabilities2KHR

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

Show DisplayPlaneCapabilities2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

showsPrec :: Int -> DisplayPlaneCapabilities2KHR -> ShowS

show :: DisplayPlaneCapabilities2KHR -> String

showList :: [DisplayPlaneCapabilities2KHR] -> ShowS

FromCStruct DisplayPlaneCapabilities2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

peekCStruct :: Ptr DisplayPlaneCapabilities2KHR -> IO DisplayPlaneCapabilities2KHR

ToCStruct DisplayPlaneCapabilities2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

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

pokeCStruct :: Ptr DisplayPlaneCapabilities2KHR -> DisplayPlaneCapabilities2KHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DisplayPlaneCapabilities2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPlaneCapabilities2KHR

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Methods

zero :: DisplayPlaneCapabilities2KHR

type KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION = 1

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

type KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME = "VK_KHR_get_display_properties2"

pattern KHR_GET_DISPLAY_PROPERTIES_2_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

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

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

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

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

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 DisplayPlaneAlphaFlagsKHR = DisplayPlaneAlphaFlagBitsKHR

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

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

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

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