Safe Haskell | None |
---|---|
Language | Haskell2010 |
Name
VK_KHR_get_display_properties2 - instance extension
VK_KHR_get_display_properties2
- Name String
VK_KHR_get_display_properties2
- Extension Type
- Instance extension
- Registered Extension Number
- 122
- Revision
- 1
- Extension and Version Dependencies
- Requires Vulkan 1.0
- Requires
VK_KHR_display
- Contact
Other Extension Metadata
- Last Modified Date
- 2017-02-21
- IP Status
- No known IP claims.
- Contributors
- Ian Elliott, Google
- James Jones, NVIDIA
Description
This extension provides new entry points to query device display
properties and capabilities in a way that can be easily extended by
other extensions, without introducing any further entry points. This
extension can be considered the VK_KHR_display
equivalent of the
VK_KHR_get_physical_device_properties2
extension.
New Commands
getDisplayPlaneCapabilities2KHR
getPhysicalDeviceDisplayPlaneProperties2KHR
getPhysicalDeviceDisplayProperties2KHR
New Structures
New Enum Constants
Issues
1) What should this extension be named?
RESOLVED: VK_KHR_get_display_properties2
. Other alternatives:
VK_KHR_display2
- One extension, combined with
VK_KHR_surface_capabilites2
.
2) Should extensible input structs be added for these new functions:
RESOLVED:
getPhysicalDeviceDisplayProperties2KHR
: No. The only current input is aPhysicalDevice
. Other inputs wouldn’t make sense.getPhysicalDeviceDisplayPlaneProperties2KHR
: No. The only current input is aPhysicalDevice
. Other inputs wouldn’t make sense.getDisplayModeProperties2KHR
: No. The only current inputs are aPhysicalDevice
and aDisplayModeKHR
. Other inputs wouldn’t make sense.
3) Should additional display query functions be extended?
RESOLVED:
getDisplayPlaneSupportedDisplaysKHR
: No. Extensions should instead extendgetDisplayPlaneCapabilitiesKHR
().
Version History
Revision 1, 2017-02-21 (James Jones)
- Initial draft.
See Also
DisplayModeProperties2KHR
, DisplayPlaneCapabilities2KHR
,
DisplayPlaneInfo2KHR
, DisplayPlaneProperties2KHR
,
DisplayProperties2KHR
, getDisplayModeProperties2KHR
,
getDisplayPlaneCapabilities2KHR
,
getPhysicalDeviceDisplayPlaneProperties2KHR
,
getPhysicalDeviceDisplayProperties2KHR
Document Notes
For more information, see the Vulkan Specification
This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.
Synopsis
- getPhysicalDeviceDisplayProperties2KHR :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector DisplayProperties2KHR)
- getPhysicalDeviceDisplayPlaneProperties2KHR :: forall io. MonadIO io => PhysicalDevice -> io (Result, "properties" ::: Vector DisplayPlaneProperties2KHR)
- getDisplayModeProperties2KHR :: forall io. MonadIO io => PhysicalDevice -> DisplayKHR -> io (Result, "properties" ::: Vector DisplayModeProperties2KHR)
- getDisplayPlaneCapabilities2KHR :: forall io. MonadIO io => PhysicalDevice -> DisplayPlaneInfo2KHR -> io DisplayPlaneCapabilities2KHR
- data DisplayProperties2KHR = DisplayProperties2KHR {}
- data DisplayPlaneProperties2KHR = DisplayPlaneProperties2KHR {}
- data DisplayModeProperties2KHR = DisplayModeProperties2KHR {}
- data DisplayPlaneInfo2KHR = DisplayPlaneInfo2KHR {}
- data DisplayPlaneCapabilities2KHR = DisplayPlaneCapabilities2KHR {}
- type KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION = 1
- pattern KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION :: forall a. Integral a => a
- type KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME = "VK_KHR_get_display_properties2"
- pattern KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
- newtype DisplayKHR = DisplayKHR Word64
- newtype DisplayModeKHR = DisplayModeKHR Word64
- data DisplayPropertiesKHR = DisplayPropertiesKHR {}
- data DisplayPlanePropertiesKHR = DisplayPlanePropertiesKHR {}
- data DisplayModeParametersKHR = DisplayModeParametersKHR {}
- data DisplayModePropertiesKHR = DisplayModePropertiesKHR {}
- data DisplayPlaneCapabilitiesKHR = DisplayPlaneCapabilitiesKHR {}
- 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
- 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
getPhysicalDeviceDisplayProperties2KHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> io (Result, "properties" ::: Vector DisplayProperties2KHR) |
vkGetPhysicalDeviceDisplayProperties2KHR - Query information about the available displays
Description
getPhysicalDeviceDisplayProperties2KHR
behaves similarly to
getPhysicalDeviceDisplayPropertiesKHR
,
with the ability to return extended information via chained output
structures.
Valid Usage (Implicit)
-
physicalDevice
must be a 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
DisplayProperties2KHR
structures
Return Codes
See Also
getPhysicalDeviceDisplayPlaneProperties2KHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> io (Result, "properties" ::: Vector DisplayPlaneProperties2KHR) |
vkGetPhysicalDeviceDisplayPlaneProperties2KHR - Query information about the available display planes.
Description
getPhysicalDeviceDisplayPlaneProperties2KHR
behaves similarly to
getPhysicalDeviceDisplayPlanePropertiesKHR
,
with the ability to return extended information via chained output
structures.
Valid Usage (Implicit)
-
physicalDevice
must be a 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
DisplayPlaneProperties2KHR
structures
Return Codes
See Also
getDisplayModeProperties2KHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> DisplayKHR |
|
-> io (Result, "properties" ::: Vector DisplayModeProperties2KHR) |
vkGetDisplayModeProperties2KHR - Query information about the available display modes.
Description
getDisplayModeProperties2KHR
behaves similarly to
getDisplayModePropertiesKHR
, with the
ability to return extended information via chained output structures.
Valid Usage (Implicit)
-
physicalDevice
must be a validPhysicalDevice
handle
-
display
must be a validDisplayKHR
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
DisplayModeProperties2KHR
structures -
display
must have been created, allocated, or retrieved fromphysicalDevice
Return Codes
See Also
getDisplayPlaneCapabilities2KHR Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> DisplayPlaneInfo2KHR |
|
-> io DisplayPlaneCapabilities2KHR |
vkGetDisplayPlaneCapabilities2KHR - Query capabilities of a mode and plane combination
Description
getDisplayPlaneCapabilities2KHR
behaves similarly to
getDisplayPlaneCapabilitiesKHR
, with
the ability to specify extended inputs via chained input structures, and
to return extended information via chained output structures.
Return Codes
See Also
DisplayPlaneCapabilities2KHR
, DisplayPlaneInfo2KHR
,
PhysicalDevice
data DisplayProperties2KHR Source #
VkDisplayProperties2KHR - Structure describing an available display device
Valid Usage (Implicit)
See Also
DisplayPropertiesKHR
,
StructureType
,
getPhysicalDeviceDisplayProperties2KHR
DisplayProperties2KHR | |
|
Instances
Show DisplayProperties2KHR Source # | |
Defined in Vulkan.Extensions.VK_KHR_get_display_properties2 showsPrec :: Int -> DisplayProperties2KHR -> ShowS # show :: DisplayProperties2KHR -> String # showList :: [DisplayProperties2KHR] -> ShowS # | |
FromCStruct DisplayProperties2KHR Source # | |
ToCStruct DisplayProperties2KHR Source # | |
Defined in Vulkan.Extensions.VK_KHR_get_display_properties2 withCStruct :: DisplayProperties2KHR -> (Ptr DisplayProperties2KHR -> IO b) -> IO b Source # pokeCStruct :: Ptr DisplayProperties2KHR -> DisplayProperties2KHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr DisplayProperties2KHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DisplayProperties2KHR -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero DisplayProperties2KHR Source # | |
data DisplayPlaneProperties2KHR Source #
VkDisplayPlaneProperties2KHR - Structure describing an available display plane
Valid Usage (Implicit)
See Also
DisplayPlanePropertiesKHR
,
StructureType
,
getPhysicalDeviceDisplayPlaneProperties2KHR
DisplayPlaneProperties2KHR | |
|
Instances
data DisplayModeProperties2KHR Source #
VkDisplayModeProperties2KHR - Structure describing an available display mode
Valid Usage (Implicit)
See Also
DisplayModePropertiesKHR
,
StructureType
,
getDisplayModeProperties2KHR
DisplayModeProperties2KHR | |
|
Instances
data DisplayPlaneInfo2KHR Source #
VkDisplayPlaneInfo2KHR - Structure defining the intended configuration of a display plane
Description
Note
This parameter also implicitly specifies a display.
planeIndex
is the plane which the application intends to use with the display.
The members of DisplayPlaneInfo2KHR
correspond to the arguments to
getDisplayPlaneCapabilitiesKHR
, with
sType
and pNext
added for extensibility.
Valid Usage (Implicit)
-
sType
must beSTRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
-
pNext
must beNULL
-
mode
must be a validDisplayModeKHR
handle
Host Synchronization
- Host access to
mode
must be externally synchronized
See Also
DisplayModeKHR
,
StructureType
,
getDisplayPlaneCapabilities2KHR
DisplayPlaneInfo2KHR | |
|
Instances
data DisplayPlaneCapabilities2KHR Source #
VkDisplayPlaneCapabilities2KHR - Structure describing the capabilities of a mode and plane combination
Valid Usage (Implicit)
See Also
DisplayPlaneCapabilitiesKHR
,
StructureType
,
getDisplayPlaneCapabilities2KHR
DisplayPlaneCapabilities2KHR | |
|
Instances
pattern KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION :: forall a. Integral a => a Source #
type KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME = "VK_KHR_get_display_properties2" Source #
pattern KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #
newtype DisplayKHR Source #
VkDisplayKHR - Opaque handle to a display object
See Also
DisplayPlanePropertiesKHR
,
DisplayPropertiesKHR
,
acquireWinrtDisplayNV
,
acquireXlibDisplayEXT
,
createDisplayModeKHR
,
displayPowerControlEXT
,
getDisplayModeProperties2KHR
,
getDisplayModePropertiesKHR
,
getDisplayPlaneSupportedDisplaysKHR
,
getRandROutputDisplayEXT
,
getWinrtDisplayNV
,
registerDisplayEventEXT
,
releaseDisplayEXT
Instances
newtype DisplayModeKHR Source #
VkDisplayModeKHR - Opaque handle to a display mode object
See Also
DisplayModePropertiesKHR
,
DisplayPlaneInfo2KHR
,
DisplaySurfaceCreateInfoKHR
,
createDisplayModeKHR
,
getDisplayPlaneCapabilitiesKHR
Instances
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
Show DisplayPropertiesKHR Source # | |
Defined in Vulkan.Extensions.VK_KHR_display showsPrec :: Int -> DisplayPropertiesKHR -> ShowS # show :: DisplayPropertiesKHR -> String # showList :: [DisplayPropertiesKHR] -> ShowS # | |
FromCStruct DisplayPropertiesKHR Source # | |
Defined in Vulkan.Extensions.VK_KHR_display | |
ToCStruct DisplayPropertiesKHR Source # | |
Defined in Vulkan.Extensions.VK_KHR_display withCStruct :: DisplayPropertiesKHR -> (Ptr DisplayPropertiesKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr DisplayPropertiesKHR -> DisplayPropertiesKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr DisplayPropertiesKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DisplayPropertiesKHR -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero DisplayPropertiesKHR Source # | |
Defined in Vulkan.Extensions.VK_KHR_display |
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
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 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
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
newtype SurfaceTransformFlagBitsKHR Source #
VkSurfaceTransformFlagBitsKHR - presentation transforms supported on a device
See Also
CommandBufferInheritanceRenderPassTransformInfoQCOM
,
CopyCommandTransformInfoQCOM
,
DisplaySurfaceCreateInfoKHR
,
RenderPassTransformBeginInfoQCOM
,
SurfaceCapabilities2EXT
,
SurfaceCapabilitiesKHR
, SurfaceTransformFlagsKHR
,
SwapchainCreateInfoKHR