| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Vulkan.Extensions.VK_EXT_display_control
Synopsis
- displayPowerControlEXT :: forall io. MonadIO io => Device -> DisplayKHR -> DisplayPowerInfoEXT -> io ()
- registerDeviceEventEXT :: forall io. MonadIO io => Device -> DeviceEventInfoEXT -> ("allocator" ::: Maybe AllocationCallbacks) -> io Fence
- registerDisplayEventEXT :: forall io. MonadIO io => Device -> DisplayKHR -> DisplayEventInfoEXT -> ("allocator" ::: Maybe AllocationCallbacks) -> io Fence
- getSwapchainCounterEXT :: forall io. MonadIO io => Device -> SwapchainKHR -> SurfaceCounterFlagBitsEXT -> io ("counterValue" ::: Word64)
- data DisplayPowerInfoEXT = DisplayPowerInfoEXT {}
- data DeviceEventInfoEXT = DeviceEventInfoEXT {}
- data DisplayEventInfoEXT = DisplayEventInfoEXT {}
- data SwapchainCounterCreateInfoEXT = SwapchainCounterCreateInfoEXT {}
- newtype DisplayPowerStateEXT where
- newtype DeviceEventTypeEXT where
- newtype DisplayEventTypeEXT where
- type EXT_DISPLAY_CONTROL_SPEC_VERSION = 1
- pattern EXT_DISPLAY_CONTROL_SPEC_VERSION :: forall a. Integral a => a
- type EXT_DISPLAY_CONTROL_EXTENSION_NAME = "VK_EXT_display_control"
- pattern EXT_DISPLAY_CONTROL_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
- newtype DisplayKHR = DisplayKHR Word64
- newtype SwapchainKHR = SwapchainKHR Word64
- newtype SurfaceCounterFlagBitsEXT where
- type SurfaceCounterFlagsEXT = SurfaceCounterFlagBitsEXT
Documentation
displayPowerControlEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => Device |
|
| -> DisplayKHR |
|
| -> DisplayPowerInfoEXT |
|
| -> io () |
vkDisplayPowerControlEXT - Set the power state of a display
Valid Usage (Implicit)
devicemust be a validDevicehandle
displaymust be a validDisplayKHRhandlepDisplayPowerInfomust be a valid pointer to a validDisplayPowerInfoEXTstructure- Both of
device, anddisplaymust have been created, allocated, or retrieved from the samePhysicalDevice
Return Codes
See Also
registerDeviceEventEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => Device |
|
| -> DeviceEventInfoEXT |
|
| -> ("allocator" ::: Maybe AllocationCallbacks) |
|
| -> io Fence |
vkRegisterDeviceEventEXT - Signal a fence when a device event occurs
Valid Usage (Implicit)
devicemust be a validDevicehandle
pDeviceEventInfomust be a valid pointer to a validDeviceEventInfoEXTstructure- If
pAllocatoris notNULL,pAllocatormust be a valid pointer to a validAllocationCallbacksstructure pFencemust be a valid pointer to aFencehandle
Return Codes
See Also
registerDisplayEventEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => Device |
|
| -> DisplayKHR |
|
| -> DisplayEventInfoEXT |
|
| -> ("allocator" ::: Maybe AllocationCallbacks) |
|
| -> io Fence |
vkRegisterDisplayEventEXT - Signal a fence when a display event occurs
Valid Usage (Implicit)
devicemust be a validDevicehandle
displaymust be a validDisplayKHRhandlepDisplayEventInfomust be a valid pointer to a validDisplayEventInfoEXTstructure- If
pAllocatoris notNULL,pAllocatormust be a valid pointer to a validAllocationCallbacksstructure pFencemust be a valid pointer to aFencehandle- Both of
device, anddisplaymust have been created, allocated, or retrieved from the samePhysicalDevice
Return Codes
See Also
AllocationCallbacks,
Device, DisplayEventInfoEXT,
DisplayKHR, Fence
getSwapchainCounterEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => Device |
|
| -> SwapchainKHR |
|
| -> SurfaceCounterFlagBitsEXT |
|
| -> io ("counterValue" ::: Word64) |
vkGetSwapchainCounterEXT - Query the current value of a surface counter
Description
If a counter is not available because the swapchain is out of date, the
implementation may return
ERROR_OUT_OF_DATE_KHR.
Valid Usage
- One or more present commands on
swapchainmust have been processed by the presentation engine
Valid Usage (Implicit)
devicemust be a validDevicehandle
swapchainmust be a validSwapchainKHRhandlecountermust be a validSurfaceCounterFlagBitsEXTvaluepCounterValuemust be a valid pointer to auint64_tvalue- Both of
device, andswapchainmust have been created, allocated, or retrieved from the sameInstance
Return Codes
See Also
data DisplayPowerInfoEXT Source #
VkDisplayPowerInfoEXT - Describe the power state of a display
Valid Usage (Implicit)
See Also
Constructors
| DisplayPowerInfoEXT | |
Fields
| |
Instances
data DeviceEventInfoEXT Source #
VkDeviceEventInfoEXT - Describe a device event to create
Valid Usage (Implicit)
See Also
Constructors
| DeviceEventInfoEXT | |
Fields
| |
Instances
data DisplayEventInfoEXT Source #
VkDisplayEventInfoEXT - Describe a display event to create
Valid Usage (Implicit)
See Also
Constructors
| DisplayEventInfoEXT | |
Fields
| |
Instances
data SwapchainCounterCreateInfoEXT Source #
VkSwapchainCounterCreateInfoEXT - Specify the surface counters desired
Valid Usage
- The bits in
surfaceCountersmust be supported bySwapchainCreateInfoKHR::surface, as reported bygetPhysicalDeviceSurfaceCapabilities2EXT
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT
surfaceCountersmust be a valid combination ofSurfaceCounterFlagBitsEXTvalues
See Also
Constructors
| SwapchainCounterCreateInfoEXT | |
Fields
| |
Instances
newtype DisplayPowerStateEXT Source #
Constructors
| DisplayPowerStateEXT Int32 |
Bundled Patterns
| pattern DISPLAY_POWER_STATE_OFF_EXT :: DisplayPowerStateEXT |
|
| pattern DISPLAY_POWER_STATE_SUSPEND_EXT :: DisplayPowerStateEXT |
|
| pattern DISPLAY_POWER_STATE_ON_EXT :: DisplayPowerStateEXT |
|
Instances
newtype DeviceEventTypeEXT Source #
Constructors
| DeviceEventTypeEXT Int32 |
Bundled Patterns
| pattern DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT :: DeviceEventTypeEXT |
|
Instances
newtype DisplayEventTypeEXT Source #
Constructors
| DisplayEventTypeEXT Int32 |
Bundled Patterns
| pattern DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT :: DisplayEventTypeEXT |
|
Instances
type EXT_DISPLAY_CONTROL_SPEC_VERSION = 1 Source #
pattern EXT_DISPLAY_CONTROL_SPEC_VERSION :: forall a. Integral a => a Source #
type EXT_DISPLAY_CONTROL_EXTENSION_NAME = "VK_EXT_display_control" Source #
pattern EXT_DISPLAY_CONTROL_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
Constructors
| DisplayKHR Word64 |
Instances
newtype SwapchainKHR Source #
VkSwapchainKHR - Opaque handle to a swapchain object
Description
A swapchain is an abstraction for an array of presentable images that
are associated with a surface. The presentable images are represented by
Image objects created by the platform. One image
(which can be an array image for multiview/stereoscopic-3D surfaces)
is displayed at a time, but multiple images can be queued for
presentation. An application renders to the image, and then queues the
image for presentation to the surface.
A native window cannot be associated with more than one non-retired swapchain at a time. Further, swapchains cannot be created for native windows that have a non-Vulkan graphics API surface associated with them.
Note
The presentation engine is an abstraction for the platform’s compositor or display engine.
The presentation engine may be synchronous or asynchronous with respect to the application and/or logical device.
Some implementations may use the device’s graphics queue or dedicated presentation hardware to perform presentation.
The presentable images of a swapchain are owned by the presentation
engine. An application can acquire use of a presentable image from the
presentation engine. Use of a presentable image must occur only after
the image is returned by
acquireNextImageKHR, and before it
is presented by queuePresentKHR.
This includes transitioning the image layout and rendering commands.
An application can acquire use of a presentable image with
acquireNextImageKHR. After
acquiring a presentable image and before modifying it, the application
must use a synchronization primitive to ensure that the presentation
engine has finished reading from the image. The application can then
transition the image’s layout, queue rendering commands to it, etc.
Finally, the application presents the image with
queuePresentKHR, which releases the
acquisition of the image.
The presentation engine controls the order in which presentable images are acquired for use by the application.
Note
This allows the platform to handle situations which require out-of-order return of images after presentation. At the same time, it allows the application to generate command buffers referencing all of the images in the swapchain at initialization time, rather than in its main loop.
See Also
AcquireNextImageInfoKHR,
BindImageMemorySwapchainInfoKHR,
ImageSwapchainCreateInfoKHR,
PresentInfoKHR,
SwapchainCreateInfoKHR,
acquireFullScreenExclusiveModeEXT,
acquireNextImageKHR,
createSharedSwapchainsKHR,
createSwapchainKHR,
destroySwapchainKHR,
getPastPresentationTimingGOOGLE,
getRefreshCycleDurationGOOGLE,
getSwapchainCounterEXT,
getSwapchainImagesKHR,
getSwapchainStatusKHR,
releaseFullScreenExclusiveModeEXT,
setHdrMetadataEXT,
setLocalDimmingAMD
Constructors
| SwapchainKHR Word64 |
Instances
newtype SurfaceCounterFlagBitsEXT Source #
VkSurfaceCounterFlagBitsEXT - Surface-relative counter types
See Also
Constructors
| SurfaceCounterFlagBitsEXT Flags |
Bundled Patterns
| pattern SURFACE_COUNTER_VBLANK_EXT :: SurfaceCounterFlagBitsEXT |
|