Vulkan.Extensions.VK_KHR_display

Documentation

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

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)

• physicalDevice must be a valid PhysicalDevice handle

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

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayPropertiesKHR, PhysicalDevice

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

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)

• physicalDevice must be a valid PhysicalDevice handle

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

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayPlanePropertiesKHR, PhysicalDevice

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

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

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

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

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

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayKHR, PhysicalDevice

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

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)

• physicalDevice must be a valid PhysicalDevice handle

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

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayKHR, DisplayModePropertiesKHR, PhysicalDevice

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

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)

• physicalDevice must be a valid PhysicalDevice handle

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

Host Synchronization

• Host access to display must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

See Also

AllocationCallbacks, DisplayKHR, DisplayModeCreateInfoKHR, DisplayModeKHR, PhysicalDevice

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

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)

• physicalDevice must be a valid PhysicalDevice handle

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

Host Synchronization

• Host access to mode must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayModeKHR, DisplayPlaneCapabilitiesKHR, PhysicalDevice

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

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

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, DisplaySurfaceCreateInfoKHR, Instance, SurfaceKHR

data DisplayPropertiesKHR

VkDisplayPropertiesKHR - Structure describing an available display device

Description

Note

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

Note

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

See Also

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

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

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

Show DisplayPlanePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayPlanePropertiesKHR -> ShowS

show :: DisplayPlanePropertiesKHR -> String

showList :: [DisplayPlanePropertiesKHR] -> ShowS

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

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

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

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

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

Show DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModePropertiesKHR -> ShowS

show :: DisplayModePropertiesKHR -> String

showList :: [DisplayModePropertiesKHR] -> ShowS

FromCStruct DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayModePropertiesKHR -> IO DisplayModePropertiesKHR

ToCStruct DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayModePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModePropertiesKHR

data DisplayModeCreateInfoKHR

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

Valid Usage (Implicit)

See Also

DisplayModeCreateFlagsKHR, DisplayModeParametersKHR, StructureType, createDisplayModeKHR

Constructors

DisplayModeCreateInfoKHR

Fields

• flags :: DisplayModeCreateFlagsKHR

  flags must be 0

• parameters :: DisplayModeParametersKHR

  parameters must be a valid DisplayModeParametersKHR structure

Instances

Show DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModeCreateInfoKHR -> ShowS

show :: DisplayModeCreateInfoKHR -> String

showList :: [DisplayModeCreateInfoKHR] -> ShowS

FromCStruct DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayModeCreateInfoKHR -> IO DisplayModeCreateInfoKHR

ToCStruct DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayModeCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModeCreateInfoKHR

data DisplayPlaneCapabilitiesKHR

VkDisplayPlaneCapabilitiesKHR - Structure describing capabilities of a mode and plane combination

Description

The minimum and maximum position and extent fields describe the implementation limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain’s presentable images on the specified display plane. This is expressed by returning minSrcPosition, maxSrcPosition, minSrcExtent, and maxSrcExtent values that indicate a range of possible positions and sizes 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

Show DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayPlaneCapabilitiesKHR -> ShowS

show :: DisplayPlaneCapabilitiesKHR -> String

showList :: [DisplayPlaneCapabilitiesKHR] -> ShowS

FromCStruct DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplayPlaneCapabilitiesKHR -> IO DisplayPlaneCapabilitiesKHR

ToCStruct DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPlaneCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayPlaneCapabilitiesKHR

data DisplaySurfaceCreateInfoKHR

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

Description

Note

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

Valid Usage

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

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

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

See Also

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

Constructors

DisplaySurfaceCreateInfoKHR

Fields

• flags :: DisplaySurfaceCreateFlagsKHR

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

• displayMode :: DisplayModeKHR

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

• planeIndex :: Word32

  planeIndex is the plane on which this surface appears.

• planeStackIndex :: Word32

  planeStackIndex is the z-order of the plane.

• transform :: SurfaceTransformFlagBitsKHR

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

• globalAlpha :: Float

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

• alphaMode :: DisplayPlaneAlphaFlagBitsKHR

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

• imageExtent :: Extent2D

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

Instances

Show DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplaySurfaceCreateInfoKHR -> ShowS

show :: DisplaySurfaceCreateInfoKHR -> String

showList :: [DisplaySurfaceCreateInfoKHR] -> ShowS

FromCStruct DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

peekCStruct :: Ptr DisplaySurfaceCreateInfoKHR -> IO DisplaySurfaceCreateInfoKHR

ToCStruct DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero DisplaySurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplaySurfaceCreateInfoKHR

newtype DisplayModeCreateFlagsKHR

VkDisplayModeCreateFlagsKHR - Reserved for future use

Description

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

See Also

DisplayModeCreateInfoKHR

Constructors

DisplayModeCreateFlagsKHR Flags

Instances

Eq DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

Ord DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

compare :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> Ordering

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

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

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

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

max :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

min :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

Read DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

readsPrec :: Int -> ReadS DisplayModeCreateFlagsKHR

readList :: ReadS [DisplayModeCreateFlagsKHR]

readPrec :: ReadPrec DisplayModeCreateFlagsKHR

readListPrec :: ReadPrec [DisplayModeCreateFlagsKHR]

Show DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplayModeCreateFlagsKHR -> ShowS

show :: DisplayModeCreateFlagsKHR -> String

showList :: [DisplayModeCreateFlagsKHR] -> ShowS

Storable DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplayModeCreateFlagsKHR -> Int

alignment :: DisplayModeCreateFlagsKHR -> Int

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

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

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

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

peek :: Ptr DisplayModeCreateFlagsKHR -> IO DisplayModeCreateFlagsKHR

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

Bits DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

xor :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

complement :: DisplayModeCreateFlagsKHR -> DisplayModeCreateFlagsKHR

shift :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

rotate :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

zeroBits :: DisplayModeCreateFlagsKHR

bit :: Int -> DisplayModeCreateFlagsKHR

setBit :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

clearBit :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

complementBit :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

testBit :: DisplayModeCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: DisplayModeCreateFlagsKHR -> Maybe Int

bitSize :: DisplayModeCreateFlagsKHR -> Int

isSigned :: DisplayModeCreateFlagsKHR -> Bool

shiftL :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

unsafeShiftL :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

shiftR :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

unsafeShiftR :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

rotateL :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

rotateR :: DisplayModeCreateFlagsKHR -> Int -> DisplayModeCreateFlagsKHR

popCount :: DisplayModeCreateFlagsKHR -> Int

Zero DisplayModeCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayModeCreateFlagsKHR

newtype DisplaySurfaceCreateFlagsKHR

VkDisplaySurfaceCreateFlagsKHR - Reserved for future use

Description

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

See Also

DisplaySurfaceCreateInfoKHR

Constructors

DisplaySurfaceCreateFlagsKHR Flags

Instances

Eq DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

Ord DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

compare :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> Ordering

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

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

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

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

max :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

min :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

Read DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

readsPrec :: Int -> ReadS DisplaySurfaceCreateFlagsKHR

readList :: ReadS [DisplaySurfaceCreateFlagsKHR]

readPrec :: ReadPrec DisplaySurfaceCreateFlagsKHR

readListPrec :: ReadPrec [DisplaySurfaceCreateFlagsKHR]

Show DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

showsPrec :: Int -> DisplaySurfaceCreateFlagsKHR -> ShowS

show :: DisplaySurfaceCreateFlagsKHR -> String

showList :: [DisplaySurfaceCreateFlagsKHR] -> ShowS

Storable DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

sizeOf :: DisplaySurfaceCreateFlagsKHR -> Int

alignment :: DisplaySurfaceCreateFlagsKHR -> Int

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

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

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

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

peek :: Ptr DisplaySurfaceCreateFlagsKHR -> IO DisplaySurfaceCreateFlagsKHR

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

Bits DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

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

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

xor :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

complement :: DisplaySurfaceCreateFlagsKHR -> DisplaySurfaceCreateFlagsKHR

shift :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

rotate :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

zeroBits :: DisplaySurfaceCreateFlagsKHR

bit :: Int -> DisplaySurfaceCreateFlagsKHR

setBit :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

clearBit :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

complementBit :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

testBit :: DisplaySurfaceCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: DisplaySurfaceCreateFlagsKHR -> Maybe Int

bitSize :: DisplaySurfaceCreateFlagsKHR -> Int

isSigned :: DisplaySurfaceCreateFlagsKHR -> Bool

shiftL :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

unsafeShiftL :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

shiftR :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

unsafeShiftR :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

rotateL :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

rotateR :: DisplaySurfaceCreateFlagsKHR -> Int -> DisplaySurfaceCreateFlagsKHR

popCount :: DisplaySurfaceCreateFlagsKHR -> Int

Zero DisplaySurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplaySurfaceCreateFlagsKHR

newtype DisplayPlaneAlphaFlagBitsKHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

See Also

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

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

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

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

Zero DisplayPlaneAlphaFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_display

Methods

zero :: DisplayPlaneAlphaFlagBitsKHR

type DisplayPlaneAlphaFlagsKHR = DisplayPlaneAlphaFlagBitsKHR

type KHR_DISPLAY_SPEC_VERSION = 23

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

type KHR_DISPLAY_EXTENSION_NAME = "VK_KHR_display"

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

newtype DisplayKHR

VkDisplayKHR - Opaque handle to a display object

See Also

DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getRandROutputDisplayEXT, registerDisplayEventEXT, releaseDisplayEXT

Constructors

DisplayKHR Word64

Instances

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

Show DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayKHR -> ShowS

show :: DisplayKHR -> String

showList :: [DisplayKHR] -> ShowS

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

Zero DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayKHR

HasObjectType DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayKHR -> (ObjectType, Word64)

IsHandle DisplayKHR

Defined in Vulkan.Extensions.Handles

newtype DisplayModeKHR

VkDisplayModeKHR - Opaque handle to a display mode object

See Also

DisplayModePropertiesKHR, DisplayPlaneInfo2KHR, DisplaySurfaceCreateInfoKHR, createDisplayModeKHR, getDisplayPlaneCapabilitiesKHR

Constructors

DisplayModeKHR Word64

Instances

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

Show DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayModeKHR -> ShowS

show :: DisplayModeKHR -> String

showList :: [DisplayModeKHR] -> ShowS

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

Zero DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayModeKHR

HasObjectType DisplayModeKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayModeKHR -> (ObjectType, Word64)

IsHandle DisplayModeKHR

Defined in Vulkan.Extensions.Handles

newtype SurfaceKHR

VkSurfaceKHR - Opaque handle to a surface object

Description

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

See Also

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

Constructors

SurfaceKHR Word64

Instances

Eq SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SurfaceKHR -> SurfaceKHR -> Ordering

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

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

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

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

max :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

min :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

Show SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

Storable SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SurfaceKHR -> Int

alignment :: SurfaceKHR -> Int

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

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

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

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

peek :: Ptr SurfaceKHR -> IO SurfaceKHR

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

Zero SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles

newtype SurfaceTransformFlagBitsKHR

VkSurfaceTransformFlagBitsKHR - presentation transforms supported on a device

See Also

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

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

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

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

Zero SurfaceTransformFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

zero :: SurfaceTransformFlagBitsKHR

type SurfaceTransformFlagsKHR = SurfaceTransformFlagBitsKHR