vulkan-3.6: Bindings to the Vulkan graphics API.
Safe HaskellNone
LanguageHaskell2010

Vulkan.Extensions.VK_KHR_get_display_properties2

Synopsis

Documentation

getPhysicalDeviceDisplayProperties2KHR Source #

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)

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

See Also

DisplayProperties2KHR, PhysicalDevice

getPhysicalDeviceDisplayPlaneProperties2KHR Source #

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)

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

See Also

DisplayPlaneProperties2KHR, PhysicalDevice

getDisplayModeProperties2KHR Source #

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)

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

See Also

DisplayKHR, DisplayModeProperties2KHR, PhysicalDevice

getDisplayPlaneCapabilities2KHR Source #

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
Failure

See Also

DisplayPlaneCapabilities2KHR, DisplayPlaneInfo2KHR, PhysicalDevice

data DisplayProperties2KHR Source #

VkDisplayProperties2KHR - Structure describing an available display device

Valid Usage (Implicit)

See Also

DisplayPropertiesKHR, StructureType, getPhysicalDeviceDisplayProperties2KHR

Constructors

DisplayProperties2KHR 

Fields

Instances

Instances details
Show DisplayProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Generic DisplayProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Associated Types

type Rep DisplayProperties2KHR :: Type -> Type #

FromCStruct DisplayProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

ToCStruct DisplayProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Zero DisplayProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayProperties2KHR = D1 ('MetaData "DisplayProperties2KHR" "Vulkan.Extensions.VK_KHR_get_display_properties2" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayProperties2KHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayPropertiesKHR)))

data DisplayPlaneProperties2KHR Source #

VkDisplayPlaneProperties2KHR - Structure describing an available display plane

Valid Usage (Implicit)

See Also

DisplayPlanePropertiesKHR, StructureType, getPhysicalDeviceDisplayPlaneProperties2KHR

Instances

Instances details
Show DisplayPlaneProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Generic DisplayPlaneProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Associated Types

type Rep DisplayPlaneProperties2KHR :: Type -> Type #

FromCStruct DisplayPlaneProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

ToCStruct DisplayPlaneProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Zero DisplayPlaneProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayPlaneProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayPlaneProperties2KHR = D1 ('MetaData "DisplayPlaneProperties2KHR" "Vulkan.Extensions.VK_KHR_get_display_properties2" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayPlaneProperties2KHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayPlaneProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayPlanePropertiesKHR)))

data DisplayModeProperties2KHR Source #

VkDisplayModeProperties2KHR - Structure describing an available display mode

Valid Usage (Implicit)

See Also

DisplayModePropertiesKHR, StructureType, getDisplayModeProperties2KHR

Instances

Instances details
Show DisplayModeProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Generic DisplayModeProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Associated Types

type Rep DisplayModeProperties2KHR :: Type -> Type #

FromCStruct DisplayModeProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

ToCStruct DisplayModeProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Zero DisplayModeProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayModeProperties2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayModeProperties2KHR = D1 ('MetaData "DisplayModeProperties2KHR" "Vulkan.Extensions.VK_KHR_get_display_properties2" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayModeProperties2KHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayModeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayModePropertiesKHR)))

data DisplayPlaneInfo2KHR Source #

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)

Host Synchronization

  • Host access to mode must be externally synchronized

See Also

DisplayModeKHR, StructureType, getDisplayPlaneCapabilities2KHR

Constructors

DisplayPlaneInfo2KHR 

Fields

Instances

Instances details
Eq DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Show DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Generic DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Associated Types

type Rep DisplayPlaneInfo2KHR :: Type -> Type #

Storable DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

FromCStruct DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

ToCStruct DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Zero DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayPlaneInfo2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayPlaneInfo2KHR = D1 ('MetaData "DisplayPlaneInfo2KHR" "Vulkan.Extensions.VK_KHR_get_display_properties2" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayPlaneInfo2KHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayModeKHR) :*: S1 ('MetaSel ('Just "planeIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))

data DisplayPlaneCapabilities2KHR Source #

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

Valid Usage (Implicit)

See Also

DisplayPlaneCapabilitiesKHR, StructureType, getDisplayPlaneCapabilities2KHR

Instances

Instances details
Show DisplayPlaneCapabilities2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Generic DisplayPlaneCapabilities2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Associated Types

type Rep DisplayPlaneCapabilities2KHR :: Type -> Type #

FromCStruct DisplayPlaneCapabilities2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

ToCStruct DisplayPlaneCapabilities2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

Zero DisplayPlaneCapabilities2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayPlaneCapabilities2KHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_get_display_properties2

type Rep DisplayPlaneCapabilities2KHR = D1 ('MetaData "DisplayPlaneCapabilities2KHR" "Vulkan.Extensions.VK_KHR_get_display_properties2" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayPlaneCapabilities2KHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayPlaneCapabilitiesKHR)))

type KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME = "VK_KHR_get_display_properties2" Source #

newtype DisplayKHR Source #

Constructors

DisplayKHR Word64 

Instances

Instances details
Eq DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Ord DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Show DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Storable DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Zero DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

HasObjectType DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

IsHandle DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

newtype DisplayModeKHR Source #

Constructors

DisplayModeKHR Word64 

Instances

Instances details
Eq DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Ord DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Show DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Storable DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Zero DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

HasObjectType DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

IsHandle DisplayModeKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

data DisplayPropertiesKHR Source #

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

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 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. It can be NULL if no suitable name is available. If not NULL, the memory it points to must remain accessible 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

Instances details
Show DisplayPropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Generic DisplayPropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Associated Types

type Rep DisplayPropertiesKHR :: Type -> Type #

FromCStruct DisplayPropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

ToCStruct DisplayPropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Zero DisplayPropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayPropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

data DisplayPlanePropertiesKHR Source #

VkDisplayPlanePropertiesKHR - Structure describing display plane properties

See Also

DisplayKHR, DisplayPlaneProperties2KHR, getPhysicalDeviceDisplayPlanePropertiesKHR

Constructors

DisplayPlanePropertiesKHR 

Fields

Instances

Instances details
Eq DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Show DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Generic DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Associated Types

type Rep DisplayPlanePropertiesKHR :: Type -> Type #

Storable DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

FromCStruct DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

ToCStruct DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Zero DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayPlanePropertiesKHR = D1 ('MetaData "DisplayPlanePropertiesKHR" "Vulkan.Extensions.VK_KHR_display" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayPlanePropertiesKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "currentDisplay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayKHR) :*: S1 ('MetaSel ('Just "currentStackIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))

data DisplayModeParametersKHR Source #

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

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

Instances details
Show DisplayModeParametersKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Generic DisplayModeParametersKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Associated Types

type Rep DisplayModeParametersKHR :: Type -> Type #

FromCStruct DisplayModeParametersKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

ToCStruct DisplayModeParametersKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Zero DisplayModeParametersKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayModeParametersKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayModeParametersKHR = D1 ('MetaData "DisplayModeParametersKHR" "Vulkan.Extensions.VK_KHR_display" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayModeParametersKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "visibleRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Extent2D) :*: S1 ('MetaSel ('Just "refreshRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))

data DisplayModePropertiesKHR Source #

VkDisplayModePropertiesKHR - Structure describing display mode properties

See Also

DisplayModeKHR, DisplayModeParametersKHR, DisplayModeProperties2KHR, getDisplayModePropertiesKHR

Constructors

DisplayModePropertiesKHR 

Fields

Instances

Instances details
Show DisplayModePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Generic DisplayModePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Associated Types

type Rep DisplayModePropertiesKHR :: Type -> Type #

FromCStruct DisplayModePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

ToCStruct DisplayModePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Zero DisplayModePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayModePropertiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayModePropertiesKHR = D1 ('MetaData "DisplayModePropertiesKHR" "Vulkan.Extensions.VK_KHR_display" "vulkan-3.6-inplace" 'False) (C1 ('MetaCons "DisplayModePropertiesKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayModeKHR) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayModeParametersKHR)))

data DisplayPlaneCapabilitiesKHR Source #

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 may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.

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

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

These values indicate the limits of the 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

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

Instances details
Show DisplayPlaneCapabilitiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Generic DisplayPlaneCapabilitiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Associated Types

type Rep DisplayPlaneCapabilitiesKHR :: Type -> Type #

FromCStruct DisplayPlaneCapabilitiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

ToCStruct DisplayPlaneCapabilitiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Zero DisplayPlaneCapabilitiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

type Rep DisplayPlaneCapabilitiesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

newtype DisplayPlaneAlphaFlagBitsKHR Source #

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

See Also

DisplayPlaneAlphaFlagsKHR, DisplaySurfaceCreateInfoKHR

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 channel 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 channels.

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

Instances

Instances details
Eq DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Ord DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Read DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Show DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Storable DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

Bits DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

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 #

Zero DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_display

newtype SurfaceTransformFlagBitsKHR Source #

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

Instances details
Eq SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_surface

Ord SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_surface

Read SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_surface

Show SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_surface

Storable SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_surface

Bits SurfaceTransformFlagBitsKHR Source # 
Instance details

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 #

Zero SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_surface