Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- getPhysicalDeviceDisplayPropertiesKHR :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector DisplayPropertiesKHR)
- getPhysicalDeviceDisplayPlanePropertiesKHR :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector DisplayPlanePropertiesKHR)
- getDisplayPlaneSupportedDisplaysKHR :: forall io. MonadIO io => PhysicalDevice -> ("planeIndex" ::: Word32) -> io (Result, "displays" ::: Vector DisplayKHR)
- getDisplayModePropertiesKHR :: forall io. MonadIO io => PhysicalDevice -> DisplayKHR -> io (Result, "properties" ::: Vector DisplayModePropertiesKHR)
- createDisplayModeKHR :: forall io. MonadIO io => PhysicalDevice -> DisplayKHR -> DisplayModeCreateInfoKHR -> ("allocator" ::: Maybe AllocationCallbacks) -> io DisplayModeKHR
- getDisplayPlaneCapabilitiesKHR :: forall io. MonadIO io => PhysicalDevice -> DisplayModeKHR -> ("planeIndex" ::: Word32) -> io DisplayPlaneCapabilitiesKHR
- createDisplayPlaneSurfaceKHR :: forall io. MonadIO io => Instance -> DisplaySurfaceCreateInfoKHR -> ("allocator" ::: Maybe AllocationCallbacks) -> io SurfaceKHR
- data DisplayPropertiesKHR = DisplayPropertiesKHR {}
- data DisplayPlanePropertiesKHR = DisplayPlanePropertiesKHR {}
- data DisplayModeParametersKHR = DisplayModeParametersKHR {}
- data DisplayModePropertiesKHR = DisplayModePropertiesKHR {}
- data DisplayModeCreateInfoKHR = DisplayModeCreateInfoKHR {}
- data DisplayPlaneCapabilitiesKHR = DisplayPlaneCapabilitiesKHR {}
- data DisplaySurfaceCreateInfoKHR = DisplaySurfaceCreateInfoKHR {}
- newtype DisplayModeCreateFlagsKHR = DisplayModeCreateFlagsKHR Flags
- newtype DisplaySurfaceCreateFlagsKHR = DisplaySurfaceCreateFlagsKHR Flags
- newtype DisplayPlaneAlphaFlagBitsKHR where
- DisplayPlaneAlphaFlagBitsKHR Flags
- pattern DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR
- pattern DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR
- pattern DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR
- pattern DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR :: 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 = DisplayKHR Word64
- newtype DisplayModeKHR = DisplayModeKHR Word64
- newtype SurfaceKHR = SurfaceKHR Word64
- newtype SurfaceTransformFlagBitsKHR where
- SurfaceTransformFlagBitsKHR Flags
- pattern SURFACE_TRANSFORM_IDENTITY_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_ROTATE_90_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_ROTATE_180_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_ROTATE_270_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR :: SurfaceTransformFlagBitsKHR
- pattern SURFACE_TRANSFORM_INHERIT_BIT_KHR :: SurfaceTransformFlagBitsKHR
- type SurfaceTransformFlagsKHR = SurfaceTransformFlagBitsKHR
Documentation
getPhysicalDeviceDisplayPropertiesKHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> io (Result, "properties" ::: Vector DisplayPropertiesKHR) |
vkGetPhysicalDeviceDisplayPropertiesKHR - Query information about the available displays
Description
If pProperties
is NULL
, then the number of display devices available
for physicalDevice
is returned in pPropertyCount
. Otherwise,
pPropertyCount
must point to a variable set by the user to the
number of elements in the pProperties
array, and on return the
variable is overwritten with the number of structures actually written
to pProperties
. If the value of pPropertyCount
is less than the
number of display devices for physicalDevice
, at most pPropertyCount
structures will be written. 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 validPhysicalDevice
handle
pPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not0
, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
DisplayPropertiesKHR
structures
Return Codes
See Also
getPhysicalDeviceDisplayPlanePropertiesKHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> io (Result, "properties" ::: Vector DisplayPlanePropertiesKHR) |
vkGetPhysicalDeviceDisplayPlanePropertiesKHR - Query the plane properties
Description
If pProperties
is NULL
, then the number of display planes available
for physicalDevice
is returned in pPropertyCount
. Otherwise,
pPropertyCount
must point to a variable set by the user to the
number of elements in the pProperties
array, and on return the
variable is overwritten with the number of structures actually written
to pProperties
. If the value of pPropertyCount
is less than the
number of display planes for physicalDevice
, at most pPropertyCount
structures will be written.
Valid Usage (Implicit)
physicalDevice
must be a validPhysicalDevice
handle
pPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not0
, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
DisplayPlanePropertiesKHR
structures
Return Codes
See Also
getDisplayPlaneSupportedDisplaysKHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> ("planeIndex" ::: Word32) |
|
-> io (Result, "displays" ::: Vector DisplayKHR) |
vkGetDisplayPlaneSupportedDisplaysKHR - Query the list of displays a plane supports
Description
If pDisplays
is NULL
, then the number of displays usable with the
specified planeIndex
for physicalDevice
is returned in
pDisplayCount
. Otherwise, pDisplayCount
must point to a variable
set by the user to the number of elements in the pDisplays
array, and
on return the variable is overwritten with the number of handles
actually written to pDisplays
. If the value of pDisplayCount
is less
than the number of 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 callinggetPhysicalDeviceDisplayPlanePropertiesKHR
Valid Usage (Implicit)
physicalDevice
must be a validPhysicalDevice
handle
pDisplayCount
must be a valid pointer to auint32_t
value- If the value referenced by
pDisplayCount
is not0
, andpDisplays
is notNULL
,pDisplays
must be a valid pointer to an array ofpDisplayCount
DisplayKHR
handles
Return Codes
See Also
getDisplayModePropertiesKHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> DisplayKHR |
|
-> io (Result, "properties" ::: Vector DisplayModePropertiesKHR) |
vkGetDisplayModePropertiesKHR - Query the set of mode properties supported by the display
Description
If pProperties
is NULL
, then the number of display modes available
on the specified display
for physicalDevice
is returned in
pPropertyCount
. Otherwise, pPropertyCount
must point to a variable
set by the user to the number of elements in the pProperties
array,
and on return the variable is overwritten with the number of structures
actually written to pProperties
. If the value of pPropertyCount
is
less than the number of display modes for physicalDevice
, at most
pPropertyCount
structures will be written. 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 validPhysicalDevice
handle
display
must be a validDisplayKHR
handlepPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not0
, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
DisplayModePropertiesKHR
structures display
must have been created, allocated, or retrieved fromphysicalDevice
Return Codes
See Also
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> DisplayKHR |
|
-> DisplayModeCreateInfoKHR |
|
-> ("allocator" ::: Maybe AllocationCallbacks) |
|
-> io DisplayModeKHR |
vkCreateDisplayModeKHR - Create a display mode
Valid Usage (Implicit)
physicalDevice
must be a validPhysicalDevice
handle
display
must be a validDisplayKHR
handlepCreateInfo
must be a valid pointer to a validDisplayModeCreateInfoKHR
structure- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validAllocationCallbacks
structure pMode
must be a valid pointer to aDisplayModeKHR
handledisplay
must have been created, allocated, or retrieved fromphysicalDevice
Host Synchronization
- Host access to
display
must be externally synchronized
Return Codes
See Also
AllocationCallbacks
,
DisplayKHR
, DisplayModeCreateInfoKHR
,
DisplayModeKHR
,
PhysicalDevice
getDisplayPlaneCapabilitiesKHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> DisplayModeKHR |
|
-> ("planeIndex" ::: Word32) |
|
-> io DisplayPlaneCapabilitiesKHR |
vkGetDisplayPlaneCapabilitiesKHR - Query capabilities of a mode and plane combination
Valid Usage (Implicit)
physicalDevice
must be a validPhysicalDevice
handle
mode
must be a validDisplayModeKHR
handlepCapabilities
must be a valid pointer to aDisplayPlaneCapabilitiesKHR
structure
Host Synchronization
- Host access to
mode
must be externally synchronized
Return Codes
See Also
createDisplayPlaneSurfaceKHR Source #
:: forall io. MonadIO io | |
=> Instance |
|
-> DisplaySurfaceCreateInfoKHR |
|
-> ("allocator" ::: Maybe AllocationCallbacks) |
|
-> io SurfaceKHR |
vkCreateDisplayPlaneSurfaceKHR - Create a
SurfaceKHR
structure representing a display
plane and mode
Valid Usage (Implicit)
instance
must be a validInstance
handle
pCreateInfo
must be a valid pointer to a validDisplaySurfaceCreateInfoKHR
structure- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validAllocationCallbacks
structure pSurface
must be a valid pointer to aSurfaceKHR
handle
Return Codes
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
DisplayPropertiesKHR | |
|
Instances
data DisplayPlanePropertiesKHR Source #
VkDisplayPlanePropertiesKHR - Structure describing display plane properties
See Also
DisplayKHR
,
DisplayPlaneProperties2KHR
,
getPhysicalDeviceDisplayPlanePropertiesKHR
DisplayPlanePropertiesKHR | |
|
Instances
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 ofvisibleRegion
must be greater than0
- The
height
member ofvisibleRegion
must be greater than0
refreshRate
must be greater than0
See Also
DisplayModeCreateInfoKHR
, DisplayModePropertiesKHR
,
Extent2D
DisplayModeParametersKHR | |
|
Instances
data DisplayModePropertiesKHR Source #
VkDisplayModePropertiesKHR - Structure describing display mode properties
See Also
DisplayModeKHR
, DisplayModeParametersKHR
,
DisplayModeProperties2KHR
,
getDisplayModePropertiesKHR
DisplayModePropertiesKHR | |
|
Instances
data DisplayModeCreateInfoKHR Source #
VkDisplayModeCreateInfoKHR - Structure specifying parameters of a newly created display mode object
Valid Usage (Implicit)
See Also
DisplayModeCreateFlagsKHR
, DisplayModeParametersKHR
,
StructureType
,
createDisplayModeKHR
DisplayModeCreateInfoKHR | |
|
Instances
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
DisplayPlaneCapabilitiesKHR | |
|
Instances
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
planeIndex
must be less than the number of display planes supported by the device as determined by callinggetPhysicalDeviceDisplayPlanePropertiesKHR
- If the
planeReorderPossible
member of theDisplayPropertiesKHR
structure returned bygetPhysicalDeviceDisplayPropertiesKHR
for the display corresponding todisplayMode
isTRUE
thenplaneStackIndex
must be less than the number of display planes supported by the device as determined by callinggetPhysicalDeviceDisplayPlanePropertiesKHR
; otherwiseplaneStackIndex
must equal thecurrentStackIndex
member ofDisplayPlanePropertiesKHR
returned bygetPhysicalDeviceDisplayPlanePropertiesKHR
for the display plane corresponding todisplayMode
- If
alphaMode
isDISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
thenglobalAlpha
must be between0
and1
, inclusive alphaMode
must be0
or one of the bits present in thesupportedAlpha
member ofDisplayPlaneCapabilitiesKHR
returned bygetDisplayPlaneCapabilitiesKHR
for the display plane corresponding todisplayMode
- The
width
andheight
members ofimageExtent
must be less than themaxImageDimensions2D
member ofPhysicalDeviceLimits
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR
pNext
must beNULL
flags
must be0
displayMode
must be a validDisplayModeKHR
handletransform
must be a validSurfaceTransformFlagBitsKHR
valuealphaMode
must be a validDisplayPlaneAlphaFlagBitsKHR
value
See Also
DisplayModeKHR
,
DisplayPlaneAlphaFlagBitsKHR
, DisplaySurfaceCreateFlagsKHR
,
Extent2D
,
StructureType
,
SurfaceTransformFlagBitsKHR
,
createDisplayPlaneSurfaceKHR
DisplaySurfaceCreateInfoKHR | |
|
Instances
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
Instances
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
Instances
newtype DisplayPlaneAlphaFlagBitsKHR Source #
VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type
See Also
pattern DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR |
|
pattern DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR |
|
pattern DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR |
|
pattern DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR :: DisplayPlaneAlphaFlagBitsKHR |
|
Instances
type KHR_DISPLAY_SPEC_VERSION = 23 Source #
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 #
VkDisplayKHR - Opaque handle to a display object
See Also
DisplayPlanePropertiesKHR
,
DisplayPropertiesKHR
,
acquireXlibDisplayEXT
,
createDisplayModeKHR
,
displayPowerControlEXT
,
getDisplayModeProperties2KHR
,
getDisplayModePropertiesKHR
,
getDisplayPlaneSupportedDisplaysKHR
,
getRandROutputDisplayEXT
,
registerDisplayEventEXT
,
releaseDisplayEXT
Instances
newtype DisplayModeKHR Source #
VkDisplayModeKHR - Opaque handle to a display mode object
See Also
DisplayModePropertiesKHR
,
DisplayPlaneInfo2KHR
,
DisplaySurfaceCreateInfoKHR
,
createDisplayModeKHR
,
getDisplayPlaneCapabilitiesKHR
Instances
newtype SurfaceKHR Source #
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
Instances
newtype SurfaceTransformFlagBitsKHR Source #
VkSurfaceTransformFlagBitsKHR - presentation transforms supported on a device
See Also
CommandBufferInheritanceRenderPassTransformInfoQCOM
,
DisplaySurfaceCreateInfoKHR
,
RenderPassTransformBeginInfoQCOM
,
SurfaceCapabilities2EXT
,
SurfaceCapabilitiesKHR
, SurfaceTransformFlagsKHR
,
SwapchainCreateInfoKHR