Graphics.Vulkan.Extensions.VK_EXT_display_control

Documentation

newtype VkDisplayPowerStateEXT

VkDisplayPowerStateEXT - Possible power states for a display

See Also

VkDisplayPowerInfoEXT

Constructors

VkDisplayPowerStateEXT Int32

Instances

Eq VkDisplayPowerStateEXT

Methods

(==) :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> Bool

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

Ord VkDisplayPowerStateEXT

Methods

compare :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> Ordering

(<) :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> Bool

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

(>) :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> Bool

(>=) :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> Bool

max :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT

min :: VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT -> VkDisplayPowerStateEXT

Read VkDisplayPowerStateEXT

Methods

readsPrec :: Int -> ReadS VkDisplayPowerStateEXT

readList :: ReadS [VkDisplayPowerStateEXT]

readPrec :: ReadPrec VkDisplayPowerStateEXT

readListPrec :: ReadPrec [VkDisplayPowerStateEXT]

Show VkDisplayPowerStateEXT

Methods

showsPrec :: Int -> VkDisplayPowerStateEXT -> ShowS

show :: VkDisplayPowerStateEXT -> String

showList :: [VkDisplayPowerStateEXT] -> ShowS

Storable VkDisplayPowerStateEXT

Methods

sizeOf :: VkDisplayPowerStateEXT -> Int

alignment :: VkDisplayPowerStateEXT -> Int

peekElemOff :: Ptr VkDisplayPowerStateEXT -> Int -> IO VkDisplayPowerStateEXT

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

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

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

peek :: Ptr VkDisplayPowerStateEXT -> IO VkDisplayPowerStateEXT

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

pattern VK_DISPLAY_POWER_STATE_OFF_EXT :: VkDisplayPowerStateEXT

VK_DISPLAY_POWER_STATE_OFF_EXT specifies that the display is powered down.

pattern VK_DISPLAY_POWER_STATE_SUSPEND_EXT :: VkDisplayPowerStateEXT

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

VK_DISPLAY_POWER_STATE_ON_EXT specifies that the display is powered on.

newtype VkDeviceEventTypeEXT

VkDeviceEventTypeEXT - Events that can occur on a device object

See Also

VkDeviceEventInfoEXT

Constructors

VkDeviceEventTypeEXT Int32

Instances

Eq VkDeviceEventTypeEXT

Methods

(==) :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> Bool

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

Ord VkDeviceEventTypeEXT

Methods

compare :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> Ordering

(<) :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> Bool

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

(>) :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> Bool

(>=) :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> Bool

max :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT

min :: VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT -> VkDeviceEventTypeEXT

Read VkDeviceEventTypeEXT

Methods

readsPrec :: Int -> ReadS VkDeviceEventTypeEXT

readList :: ReadS [VkDeviceEventTypeEXT]

readPrec :: ReadPrec VkDeviceEventTypeEXT

readListPrec :: ReadPrec [VkDeviceEventTypeEXT]

Show VkDeviceEventTypeEXT

Methods

showsPrec :: Int -> VkDeviceEventTypeEXT -> ShowS

show :: VkDeviceEventTypeEXT -> String

showList :: [VkDeviceEventTypeEXT] -> ShowS

Storable VkDeviceEventTypeEXT

Methods

sizeOf :: VkDeviceEventTypeEXT -> Int

alignment :: VkDeviceEventTypeEXT -> Int

peekElemOff :: Ptr VkDeviceEventTypeEXT -> Int -> IO VkDeviceEventTypeEXT

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

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

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

peek :: Ptr VkDeviceEventTypeEXT -> IO VkDeviceEventTypeEXT

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

pattern VK_DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT :: VkDeviceEventTypeEXT

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

VkDisplayEventTypeEXT - Events that can occur on a display object

See Also

VkDisplayEventInfoEXT

Constructors

VkDisplayEventTypeEXT Int32

Instances

Eq VkDisplayEventTypeEXT

Methods

(==) :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> Bool

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

Ord VkDisplayEventTypeEXT

Methods

compare :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> Ordering

(<) :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> Bool

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

(>) :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> Bool

(>=) :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> Bool

max :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT

min :: VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT -> VkDisplayEventTypeEXT

Read VkDisplayEventTypeEXT

Methods

readsPrec :: Int -> ReadS VkDisplayEventTypeEXT

readList :: ReadS [VkDisplayEventTypeEXT]

readPrec :: ReadPrec VkDisplayEventTypeEXT

readListPrec :: ReadPrec [VkDisplayEventTypeEXT]

Show VkDisplayEventTypeEXT

Methods

showsPrec :: Int -> VkDisplayEventTypeEXT -> ShowS

show :: VkDisplayEventTypeEXT -> String

showList :: [VkDisplayEventTypeEXT] -> ShowS

Storable VkDisplayEventTypeEXT

Methods

sizeOf :: VkDisplayEventTypeEXT -> Int

alignment :: VkDisplayEventTypeEXT -> Int

peekElemOff :: Ptr VkDisplayEventTypeEXT -> Int -> IO VkDisplayEventTypeEXT

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

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

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

peek :: Ptr VkDisplayEventTypeEXT -> IO VkDisplayEventTypeEXT

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

pattern VK_DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT :: VkDisplayEventTypeEXT

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.

pattern VK_STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT :: VkStructureType

pattern VK_EXT_DISPLAY_CONTROL_SPEC_VERSION :: Integral a => a

pattern VK_EXT_DISPLAY_CONTROL_EXTENSION_NAME :: (Eq a, IsString a) => a

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

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

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

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

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

VkDisplayPowerInfoEXT - Describe the power state of a display

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT

• pNext must be NULL
• powerState must be a valid VkDisplayPowerStateEXT value

See Also

VkDisplayPowerStateEXT, VkStructureType, vkDisplayPowerControlEXT

Constructors

VkDisplayPowerInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkPowerState :: VkDisplayPowerStateEXT

  powerState is a VkDisplayPowerStateEXT value specifying the new power state of the display.

Instances

Eq VkDisplayPowerInfoEXT

Methods

(==) :: VkDisplayPowerInfoEXT -> VkDisplayPowerInfoEXT -> Bool

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

Show VkDisplayPowerInfoEXT

Methods

showsPrec :: Int -> VkDisplayPowerInfoEXT -> ShowS

show :: VkDisplayPowerInfoEXT -> String

showList :: [VkDisplayPowerInfoEXT] -> ShowS

Storable VkDisplayPowerInfoEXT

Methods

sizeOf :: VkDisplayPowerInfoEXT -> Int

alignment :: VkDisplayPowerInfoEXT -> Int

peekElemOff :: Ptr VkDisplayPowerInfoEXT -> Int -> IO VkDisplayPowerInfoEXT

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

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

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

peek :: Ptr VkDisplayPowerInfoEXT -> IO VkDisplayPowerInfoEXT

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

data VkDeviceEventInfoEXT

VkDeviceEventInfoEXT - Describe a device event to create

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT

• pNext must be NULL
• deviceEvent must be a valid VkDeviceEventTypeEXT value

See Also

VkDeviceEventTypeEXT, VkStructureType, vkRegisterDeviceEventEXT

Constructors

VkDeviceEventInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkDeviceEvent :: VkDeviceEventTypeEXT

Instances

Eq VkDeviceEventInfoEXT

Methods

(==) :: VkDeviceEventInfoEXT -> VkDeviceEventInfoEXT -> Bool

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

Show VkDeviceEventInfoEXT

Methods

showsPrec :: Int -> VkDeviceEventInfoEXT -> ShowS

show :: VkDeviceEventInfoEXT -> String

showList :: [VkDeviceEventInfoEXT] -> ShowS

Storable VkDeviceEventInfoEXT

Methods

sizeOf :: VkDeviceEventInfoEXT -> Int

alignment :: VkDeviceEventInfoEXT -> Int

peekElemOff :: Ptr VkDeviceEventInfoEXT -> Int -> IO VkDeviceEventInfoEXT

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

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

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

peek :: Ptr VkDeviceEventInfoEXT -> IO VkDeviceEventInfoEXT

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

data VkDisplayEventInfoEXT

VkDisplayEventInfoEXT - Describe a display event to create

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT

• pNext must be NULL
• displayEvent must be a valid VkDisplayEventTypeEXT value

See Also

VkDisplayEventTypeEXT, VkStructureType, vkRegisterDisplayEventEXT

Constructors

VkDisplayEventInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkDisplayEvent :: VkDisplayEventTypeEXT

  displayEvent is a VkDisplayEventTypeEXT specifying when the fence will be signaled.

Instances

Eq VkDisplayEventInfoEXT

Methods

(==) :: VkDisplayEventInfoEXT -> VkDisplayEventInfoEXT -> Bool

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

Show VkDisplayEventInfoEXT

Methods

showsPrec :: Int -> VkDisplayEventInfoEXT -> ShowS

show :: VkDisplayEventInfoEXT -> String

showList :: [VkDisplayEventInfoEXT] -> ShowS

Storable VkDisplayEventInfoEXT

Methods

sizeOf :: VkDisplayEventInfoEXT -> Int

alignment :: VkDisplayEventInfoEXT -> Int

peekElemOff :: Ptr VkDisplayEventInfoEXT -> Int -> IO VkDisplayEventInfoEXT

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

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

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

peek :: Ptr VkDisplayEventInfoEXT -> IO VkDisplayEventInfoEXT

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

data VkSwapchainCounterCreateInfoEXT

VkSwapchainCounterCreateInfoEXT - Specify the surface counters desired

Valid Usage

• The bits in surfaceCounters must be supported by VkSwapchainCreateInfoKHR::surface, as reported by vkGetPhysicalDeviceSurfaceCapabilities2EXT.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

• surfaceCounters must be a valid combination of VkSurfaceCounterFlagBitsEXT values

See Also

VkStructureType, VkSurfaceCounterFlagsEXT

Constructors

VkSwapchainCounterCreateInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkSurfaceCounters :: VkSurfaceCounterFlagsEXT

  surfaceCounters is a bitmask of VkSurfaceCounterFlagBitsEXT specifying surface counters to enable for the swapchain.

Instances

Eq VkSwapchainCounterCreateInfoEXT

Methods

(==) :: VkSwapchainCounterCreateInfoEXT -> VkSwapchainCounterCreateInfoEXT -> Bool

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

Show VkSwapchainCounterCreateInfoEXT

Methods

showsPrec :: Int -> VkSwapchainCounterCreateInfoEXT -> ShowS

show :: VkSwapchainCounterCreateInfoEXT -> String

showList :: [VkSwapchainCounterCreateInfoEXT] -> ShowS

Storable VkSwapchainCounterCreateInfoEXT

Methods

sizeOf :: VkSwapchainCounterCreateInfoEXT -> Int

alignment :: VkSwapchainCounterCreateInfoEXT -> Int

peekElemOff :: Ptr VkSwapchainCounterCreateInfoEXT -> Int -> IO VkSwapchainCounterCreateInfoEXT

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

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

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

peek :: Ptr VkSwapchainCounterCreateInfoEXT -> IO VkSwapchainCounterCreateInfoEXT

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