vulkan-3.2.0.0: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_KHR_display

Synopsis

Documentation

getPhysicalDeviceDisplayPropertiesKHR :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector DisplayPropertiesKHR) Source #

vkGetPhysicalDeviceDisplayPropertiesKHR - Query information about the available displays

Parameters

  • physicalDevice is a physical device.
  • pPropertyCount is a pointer to an integer related to the number of display devices available or queried, as described below.
  • pProperties is either NULL or a pointer to an array of DisplayPropertiesKHR structures.

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. If pPropertyCount is smaller than the number of display devices available for physicalDevice, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

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

Return Codes

Success
Failure

See Also

DisplayPropertiesKHR, PhysicalDevice

getPhysicalDeviceDisplayPlanePropertiesKHR :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector DisplayPlanePropertiesKHR) Source #

vkGetPhysicalDeviceDisplayPlanePropertiesKHR - Query the plane properties

Parameters

  • physicalDevice is a physical device.
  • pPropertyCount is a pointer to an integer related to the number of display planes available or queried, as described below.
  • pProperties is either NULL or a pointer to an array of DisplayPlanePropertiesKHR structures.

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)

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

See Also

DisplayPlanePropertiesKHR, PhysicalDevice

getDisplayPlaneSupportedDisplaysKHR :: forall io. MonadIO io => PhysicalDevice -> ("planeIndex" ::: Word32) -> io (Result, "displays" ::: Vector DisplayKHR) Source #

vkGetDisplayPlaneSupportedDisplaysKHR - Query the list of displays a plane supports

Parameters

  • physicalDevice is a physical device.
  • planeIndex is the plane which the application wishes to use, and must be in the range [0, physical device plane count - 1].
  • pDisplayCount is a pointer to an integer related to the number of displays available or queried, as described below.
  • pDisplays is either NULL or a pointer to an array of DisplayKHR handles.

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 display planes for physicalDevice, at most pDisplayCount handles will be written. If pDisplayCount is smaller than the number of displays usable with the specified planeIndex for physicalDevice, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

Valid Usage

Valid Usage (Implicit)

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

See Also

DisplayKHR, PhysicalDevice

getDisplayModePropertiesKHR :: forall io. MonadIO io => PhysicalDevice -> DisplayKHR -> io (Result, "properties" ::: Vector DisplayModePropertiesKHR) Source #

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

Parameters

  • physicalDevice is the physical device associated with display.
  • display is the display to query.
  • pPropertyCount is a pointer to an integer related to the number of display modes available or queried, as described below.
  • pProperties is either NULL or a pointer to an array of DisplayModePropertiesKHR structures.

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. If pPropertyCount is smaller than the number of display modes available on the specified display for physicalDevice, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

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

Return Codes

Success
Failure

See Also

DisplayKHR, DisplayModePropertiesKHR, PhysicalDevice

createDisplayModeKHR :: forall io. MonadIO io => PhysicalDevice -> DisplayKHR -> DisplayModeCreateInfoKHR -> ("allocator" ::: Maybe AllocationCallbacks) -> io DisplayModeKHR Source #

vkCreateDisplayModeKHR - Create a display mode

Parameters

  • physicalDevice is the physical device associated with display.
  • display is the display to create an additional mode for.
  • pCreateInfo is a DisplayModeCreateInfoKHR structure describing the new mode to create.
  • 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).
  • pMode returns the handle of the mode created.

Valid Usage (Implicit)

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

See Also

AllocationCallbacks, DisplayKHR, DisplayModeCreateInfoKHR, DisplayModeKHR, PhysicalDevice

getDisplayPlaneCapabilitiesKHR :: forall io. MonadIO io => PhysicalDevice -> DisplayModeKHR -> ("planeIndex" ::: Word32) -> io DisplayPlaneCapabilitiesKHR Source #

vkGetDisplayPlaneCapabilitiesKHR - Query capabilities of a mode and plane combination

Parameters

  • physicalDevice is the physical device associated with display
  • mode is the display mode the application intends to program when using the specified plane. Note this parameter also implicitly specifies a display.
  • 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.
  • pCapabilities is a pointer to a DisplayPlaneCapabilitiesKHR structure in which the capabilities are returned.

Valid Usage (Implicit)

Host Synchronization

  • Host access to mode must be externally synchronized

Return Codes

Success
Failure

See Also

DisplayModeKHR, DisplayPlaneCapabilitiesKHR, PhysicalDevice

createDisplayPlaneSurfaceKHR :: forall io. MonadIO io => Instance -> DisplaySurfaceCreateInfoKHR -> ("allocator" ::: Maybe AllocationCallbacks) -> io SurfaceKHR Source #

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

Parameters

  • instance is the instance corresponding to the physical device the targeted display is on.
  • pCreateInfo is a pointer to a DisplaySurfaceCreateInfoKHR structure specifying which mode, plane, and other parameters to use, as described below.
  • pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
  • pSurface is a pointer to a SurfaceKHR handle in which the created surface is returned.

Valid Usage (Implicit)

  • instance must be a valid Instance handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, DisplaySurfaceCreateInfoKHR, Instance, SurfaceKHR

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.

data DisplayPlanePropertiesKHR Source #

VkDisplayPlanePropertiesKHR - Structure describing display plane properties

See Also

DisplayKHR, DisplayPlaneProperties2KHR, getPhysicalDeviceDisplayPlanePropertiesKHR

Constructors

DisplayPlanePropertiesKHR 

Fields

Instances
Show DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Storable DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

FromCStruct DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

ToCStruct DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Zero DisplayPlanePropertiesKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

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.

data DisplayModePropertiesKHR Source #

VkDisplayModePropertiesKHR - Structure describing display mode properties

See Also

DisplayModeKHR, DisplayModeParametersKHR, DisplayModeProperties2KHR, getDisplayModePropertiesKHR

Constructors

DisplayModePropertiesKHR 

Fields

data DisplayModeCreateInfoKHR Source #

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

Valid Usage (Implicit)

See Also

DisplayModeCreateFlagsKHR, DisplayModeParametersKHR, StructureType, createDisplayModeKHR

Constructors

DisplayModeCreateInfoKHR 

Fields

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
     

data DisplaySurfaceCreateInfoKHR Source #

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

Valid Usage (Implicit)

See Also

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

Constructors

DisplaySurfaceCreateInfoKHR 

Fields

newtype DisplayModeCreateFlagsKHR Source #

VkDisplayModeCreateFlagsKHR - Reserved for future use

Description

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

See Also

DisplayModeCreateInfoKHR

Instances
Eq DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Ord DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Read DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Show DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Storable DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Bits DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.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 #

Zero DisplayModeCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

newtype DisplaySurfaceCreateFlagsKHR Source #

VkDisplaySurfaceCreateFlagsKHR - Reserved for future use

Description

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

See Also

DisplaySurfaceCreateInfoKHR

Instances
Eq DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Ord DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Read DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Show DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Storable DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Bits DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.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 #

Zero DisplaySurfaceCreateFlagsKHR Source # 
Instance details

Defined in Graphics.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
Eq DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Ord DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Read DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Show DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Storable DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Bits DisplayPlaneAlphaFlagBitsKHR Source # 
Instance details

Defined in Graphics.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 Graphics.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
Eq SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Ord SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Read SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Show SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Storable SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

Bits SurfaceTransformFlagBitsKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.VK_KHR_display

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 Graphics.Vulkan.Extensions.VK_KHR_display

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

type KHR_DISPLAY_EXTENSION_NAME = "VK_KHR_display" Source #

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

newtype DisplayKHR Source #

Constructors

DisplayKHR Word64 

newtype DisplayModeKHR Source #

Constructors

DisplayModeKHR Word64 
Instances
Eq DisplayModeKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.Handles

Ord DisplayModeKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.Handles

Show DisplayModeKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.Handles

Storable DisplayModeKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.Handles

Zero DisplayModeKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.Handles

IsHandle DisplayModeKHR Source # 
Instance details

Defined in Graphics.Vulkan.Extensions.Handles

newtype SurfaceKHR Source #

Constructors

SurfaceKHR Word64