vulkan-2.0.0.1: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_EXT_display_control

Synopsis

Documentation

newtype VkDisplayPowerStateEXT Source #

VkDisplayPowerStateEXT - Possible power states for a display

See Also

VkDisplayPowerInfoEXT

Instances
Eq VkDisplayPowerStateEXT Source # 
Instance details
Ord VkDisplayPowerStateEXT Source # 
Instance details
Read VkDisplayPowerStateEXT Source # 
Instance details
Show VkDisplayPowerStateEXT Source # 
Instance details
Storable VkDisplayPowerStateEXT Source # 
Instance details

pattern VK_DISPLAY_POWER_STATE_OFF_EXT :: VkDisplayPowerStateEXT Source #

VK_DISPLAY_POWER_STATE_OFF_EXT specifies that the display is powered down.

pattern VK_DISPLAY_POWER_STATE_SUSPEND_EXT :: VkDisplayPowerStateEXT Source #

VK_DISPLAY_POWER_STATE_SUSPEND_EXT specifies that the display is put into a low power mode, from which it may be able to transition back to VK_DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in VK_DISPLAY_POWER_STATE_OFF_EXT. This state may be the same as VK_DISPLAY_POWER_STATE_OFF_EXT.

pattern VK_DISPLAY_POWER_STATE_ON_EXT :: VkDisplayPowerStateEXT Source #

VK_DISPLAY_POWER_STATE_ON_EXT specifies that the display is powered on.

newtype VkDeviceEventTypeEXT Source #

VkDeviceEventTypeEXT - Events that can occur on a device object

See Also

VkDeviceEventInfoEXT

Instances
Eq VkDeviceEventTypeEXT Source # 
Instance details
Ord VkDeviceEventTypeEXT Source # 
Instance details
Read VkDeviceEventTypeEXT Source # 
Instance details
Show VkDeviceEventTypeEXT Source # 
Instance details
Storable VkDeviceEventTypeEXT Source # 
Instance details

pattern VK_DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT :: VkDeviceEventTypeEXT Source #

VK_DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT specifies that the fence is signaled when a display is plugged into or unplugged from the specified device. Applications can use this notification to determine when they need to re-enumerate the available displays on a device.

newtype VkDisplayEventTypeEXT Source #

VkDisplayEventTypeEXT - Events that can occur on a display object

See Also

VkDisplayEventInfoEXT

Instances
Eq VkDisplayEventTypeEXT Source # 
Instance details
Ord VkDisplayEventTypeEXT Source # 
Instance details
Read VkDisplayEventTypeEXT Source # 
Instance details
Show VkDisplayEventTypeEXT Source # 
Instance details
Storable VkDisplayEventTypeEXT Source # 
Instance details

pattern VK_DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT :: VkDisplayEventTypeEXT Source #

VK_DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT specifies that the fence is signaled when the first pixel of the next display refresh cycle leaves the display engine for the display.

vkDisplayPowerControlEXT :: ("device" ::: VkDevice) -> ("display" ::: VkDisplayKHR) -> ("pDisplayPowerInfo" ::: Ptr VkDisplayPowerInfoEXT) -> IO VkResult Source #

vkDisplayPowerControlEXT - Set the power state of a display

Parameters

  • device is a logical device associated with display.
  • display is the display whose power state is modified.
  • pDisplayPowerInfo is an instance of VkDisplayPowerInfoEXT specifying the new power state of display.

Valid Usage (Implicit)

  • device must be a valid VkDevice handle
  • display must be a valid VkDisplayKHR handle
  • pDisplayPowerInfo must be a valid pointer to a valid VkDisplayPowerInfoEXT structure

Return Codes

[Success] - VK_SUCCESS

See Also

VkDevice, VkDisplayKHR, VkDisplayPowerInfoEXT

vkRegisterDeviceEventEXT :: ("device" ::: VkDevice) -> ("pDeviceEventInfo" ::: Ptr VkDeviceEventInfoEXT) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pFence" ::: Ptr VkFence) -> IO VkResult Source #

vkRegisterDeviceEventEXT - Signal a fence when a device event occurs

Parameters

  • device is a logical device on which the event may occur.
  • pDeviceEventInfo is a pointer to an instance of the VkDeviceEventInfoEXT structure describing the event of interest to the application.
  • pAllocator controls host memory allocation as described in the Memory Allocation chapter.
  • pFence points to a handle in which the resulting fence object is returned.

Valid Usage (Implicit)

  • device must be a valid VkDevice handle
  • pDeviceEventInfo must be a valid pointer to a valid VkDeviceEventInfoEXT structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pFence must be a valid pointer to a VkFence handle

Return Codes

[Success] - VK_SUCCESS

See Also

VkAllocationCallbacks, VkDevice, VkDeviceEventInfoEXT, VkFence

vkRegisterDisplayEventEXT :: ("device" ::: VkDevice) -> ("display" ::: VkDisplayKHR) -> ("pDisplayEventInfo" ::: Ptr VkDisplayEventInfoEXT) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pFence" ::: Ptr VkFence) -> IO VkResult Source #

vkRegisterDisplayEventEXT - Signal a fence when a display event occurs

Parameters

  • device is a logical device associated with display
  • display is the display on which the event may occur.
  • pDisplayEventInfo is a pointer to an instance of the VkDisplayEventInfoEXT structure describing the event of interest to the application.
  • pAllocator controls host memory allocation as described in the Memory Allocation chapter.
  • pFence points to a handle in which the resulting fence object is returned.

Valid Usage (Implicit)

  • device must be a valid VkDevice handle
  • display must be a valid VkDisplayKHR handle
  • pDisplayEventInfo must be a valid pointer to a valid VkDisplayEventInfoEXT structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pFence must be a valid pointer to a VkFence handle

Return Codes

[Success] - VK_SUCCESS

See Also

VkAllocationCallbacks, VkDevice, VkDisplayEventInfoEXT, VkDisplayKHR, VkFence

vkGetSwapchainCounterEXT :: ("device" ::: VkDevice) -> ("swapchain" ::: VkSwapchainKHR) -> ("counter" ::: VkSurfaceCounterFlagBitsEXT) -> ("pCounterValue" ::: Ptr Word64) -> IO VkResult Source #

vkGetSwapchainCounterEXT - Query the current value of a surface counter

Parameters

  • device is the VkDevice associated with swapchain.
  • swapchain is the swapchain from which to query the counter value.
  • counter is the counter to query.
  • pCounterValue will return the current value of the counter.

Description

If a counter is not available because the swapchain is out of date, the implementation may return VK_ERROR_OUT_OF_DATE_KHR.

Valid Usage

  • One or more present commands on swapchain must have been processed by the presentation engine.

Valid Usage (Implicit)

  • device must be a valid VkDevice handle
  • swapchain must be a valid VkSwapchainKHR handle
  • counter must be a valid VkSurfaceCounterFlagBitsEXT value
  • pCounterValue must be a valid pointer to a uint64_t value
  • Both of device, and swapchain must have been created, allocated, or retrieved from the same VkInstance

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_DEVICE_LOST

  • VK_ERROR_OUT_OF_DATE_KHR

See Also

VkDevice, VkSurfaceCounterFlagBitsEXT, VkSwapchainKHR

data VkDisplayPowerInfoEXT Source #

VkDisplayPowerInfoEXT - Describe the power state of a display

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT

See Also

VkDisplayPowerStateEXT, VkStructureType, vkDisplayPowerControlEXT

Constructors

VkDisplayPowerInfoEXT 

Fields

data VkDeviceEventInfoEXT Source #

VkDeviceEventInfoEXT - Describe a device event to create

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT

See Also

VkDeviceEventTypeEXT, VkStructureType, vkRegisterDeviceEventEXT

Constructors

VkDeviceEventInfoEXT 

Fields

data VkDisplayEventInfoEXT Source #

VkDisplayEventInfoEXT - Describe a display event to create

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT

See Also

VkDisplayEventTypeEXT, VkStructureType, vkRegisterDisplayEventEXT

Constructors

VkDisplayEventInfoEXT 

Fields

data VkSwapchainCounterCreateInfoEXT Source #

VkSwapchainCounterCreateInfoEXT - Specify the surface counters desired

Valid Usage

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

See Also

VkStructureType, VkSurfaceCounterFlagsEXT

Constructors

VkSwapchainCounterCreateInfoEXT 

Fields