Vulkan.Extensions.VK_EXT_display_control

Name

VK_EXT_display_control - device extension

VK_EXT_display_control

Name String

VK_EXT_display_control

Extension Type

Device extension

Registered Extension Number

92

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_EXT_display_surface_counter and VK_KHR_swapchain

Contact

• James Jones @cubanismo%0A*Here describe the issue or question you have about the VK_EXT_display_control extension*

Other Extension Metadata

Last Modified Date

2016-12-13

IP Status

No known IP claims.

Contributors

• Pierre Boudier, NVIDIA
• James Jones, NVIDIA
• Damien Leone, NVIDIA
• Pierre-Loup Griffais, Valve
• Daniel Vetter, Intel

Description

This extension defines a set of utility functions for use with the VK_KHR_display and VK_KHR_display_swapchain extensions.

New Commands

• displayPowerControlEXT

• getSwapchainCounterEXT
• registerDeviceEventEXT
• registerDisplayEventEXT

New Structures

• DeviceEventInfoEXT

• DisplayEventInfoEXT
• DisplayPowerInfoEXT

• Extending SwapchainCreateInfoKHR:

  • SwapchainCounterCreateInfoEXT

New Enums

• DeviceEventTypeEXT

• DisplayEventTypeEXT
• DisplayPowerStateEXT

New Enum Constants

• EXT_DISPLAY_CONTROL_EXTENSION_NAME

• EXT_DISPLAY_CONTROL_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT
  • STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
  • STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT
  • STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

Issues

1) Should this extension add an explicit “WaitForVsync” API or a fence signaled at vsync that the application can wait on?

RESOLVED: A fence. A separate API could later be provided that allows exporting the fence to a native object that could be inserted into standard run loops on POSIX and Windows systems.

2) Should callbacks be added for a vsync event, or in general to monitor events in Vulkan?

RESOLVED: No, fences should be used. Some events are generated by interrupts which are managed in the kernel. In order to use a callback provided by the application, drivers would need to have the userspace driver spawn threads that would wait on the kernel event, and hence the callbacks could be difficult for the application to synchronize with its other work given they would arrive on a foreign thread.

3) Should vblank or scanline events be exposed?

RESOLVED: Vblank events. Scanline events could be added by a separate extension, but the latency of processing an interrupt and waking up a userspace event is high enough that the accuracy of a scanline event would be rather low. Further, per-scanline interrupts are not supported by all hardware.

Version History

• Revision 1, 2016-12-13 (James Jones)

  • Initial draft

See Also

DeviceEventInfoEXT, DeviceEventTypeEXT, DisplayEventInfoEXT, DisplayEventTypeEXT, DisplayPowerInfoEXT, DisplayPowerStateEXT, SwapchainCounterCreateInfoEXT, displayPowerControlEXT, getSwapchainCounterEXT, registerDeviceEventEXT, registerDisplayEventEXT

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.

Documentation

displayPowerControlEXT

Arguments

:: forall io. MonadIO io

=> Device

device is a logical device associated with display.

-> DisplayKHR

display is the display whose power state is modified.

-> DisplayPowerInfoEXT

pDisplayPowerInfo is a pointer to a DisplayPowerInfoEXT structure specifying the new power state of display.

-> io ()

vkDisplayPowerControlEXT - Set the power state of a display

Valid Usage (Implicit)

• device must be a valid Device handle

• display must be a valid DisplayKHR handle
• pDisplayPowerInfo must be a valid pointer to a valid DisplayPowerInfoEXT structure
• Both of device, and display must have been created, allocated, or retrieved from the same PhysicalDevice

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_EXT_display_control, Device, DisplayKHR, DisplayPowerInfoEXT

registerDeviceEventEXT

Arguments

:: forall io. MonadIO io

=> Device

device is a logical device on which the event may occur.

-> DeviceEventInfoEXT

pDeviceEventInfo is a pointer to a DeviceEventInfoEXT structure describing the event of interest to the application.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io Fence

vkRegisterDeviceEventEXT - Signal a fence when a device event occurs

Valid Usage (Implicit)

• device must be a valid Device handle

• pDeviceEventInfo must be a valid pointer to a valid DeviceEventInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pFence must be a valid pointer to a Fence handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_EXT_display_control, AllocationCallbacks, Device, DeviceEventInfoEXT, Fence

registerDisplayEventEXT

Arguments

:: forall io. MonadIO io

=> Device

device is a logical device associated with display

-> DisplayKHR

display is the display on which the event may occur.

-> DisplayEventInfoEXT

pDisplayEventInfo is a pointer to a DisplayEventInfoEXT structure describing the event of interest to the application.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io Fence

vkRegisterDisplayEventEXT - Signal a fence when a display event occurs

Valid Usage (Implicit)

• device must be a valid Device handle

• display must be a valid DisplayKHR handle
• pDisplayEventInfo must be a valid pointer to a valid DisplayEventInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pFence must be a valid pointer to a Fence handle
• Both of device, and display must have been created, allocated, or retrieved from the same PhysicalDevice

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_EXT_display_control, AllocationCallbacks, Device, DisplayEventInfoEXT, DisplayKHR, Fence

getSwapchainCounterEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the Device associated with swapchain.

-> SwapchainKHR

swapchain is the swapchain from which to query the counter value.

-> SurfaceCounterFlagBitsEXT

counter is a SurfaceCounterFlagBitsEXT value specifying the counter to query.

-> 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 swapchain must have been processed by the presentation engine

Valid Usage (Implicit)

• device must be a valid Device handle

• swapchain must be a valid SwapchainKHR handle
• counter must be a valid SurfaceCounterFlagBitsEXT value
• pCounterValue must be a valid pointer to a uint64_t value
• swapchain must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_DEVICE_LOST
• ERROR_OUT_OF_DATE_KHR

See Also

VK_EXT_display_control, Device, SurfaceCounterFlagBitsEXT, SwapchainKHR

data DisplayPowerInfoEXT

VkDisplayPowerInfoEXT - Describe the power state of a display

Valid Usage (Implicit)

See Also

VK_EXT_display_control, DisplayPowerStateEXT, StructureType, displayPowerControlEXT

Constructors

DisplayPowerInfoEXT

Fields

• powerState :: DisplayPowerStateEXT

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

  powerState must be a valid DisplayPowerStateEXT value

Instances

Storable DisplayPowerInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: DisplayPowerInfoEXT -> Int

alignment :: DisplayPowerInfoEXT -> Int

peekElemOff :: Ptr DisplayPowerInfoEXT -> Int -> IO DisplayPowerInfoEXT

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

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

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

peek :: Ptr DisplayPowerInfoEXT -> IO DisplayPowerInfoEXT

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

Show DisplayPowerInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> DisplayPowerInfoEXT -> ShowS

show :: DisplayPowerInfoEXT -> String

showList :: [DisplayPowerInfoEXT] -> ShowS

Eq DisplayPowerInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: DisplayPowerInfoEXT -> DisplayPowerInfoEXT -> Bool

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

FromCStruct DisplayPowerInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

peekCStruct :: Ptr DisplayPowerInfoEXT -> IO DisplayPowerInfoEXT

ToCStruct DisplayPowerInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

withCStruct :: DisplayPowerInfoEXT -> (Ptr DisplayPowerInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr DisplayPowerInfoEXT -> DisplayPowerInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayPowerInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayPowerInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayPowerInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: DisplayPowerInfoEXT

data DeviceEventInfoEXT

VkDeviceEventInfoEXT - Describe a device event to create

Valid Usage (Implicit)

See Also

VK_EXT_display_control, DeviceEventTypeEXT, StructureType, registerDeviceEventEXT

Constructors

DeviceEventInfoEXT

Fields

• deviceEvent :: DeviceEventTypeEXT

  deviceEvent must be a valid DeviceEventTypeEXT value

Instances

Storable DeviceEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: DeviceEventInfoEXT -> Int

alignment :: DeviceEventInfoEXT -> Int

peekElemOff :: Ptr DeviceEventInfoEXT -> Int -> IO DeviceEventInfoEXT

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

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

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

peek :: Ptr DeviceEventInfoEXT -> IO DeviceEventInfoEXT

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

Show DeviceEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> DeviceEventInfoEXT -> ShowS

show :: DeviceEventInfoEXT -> String

showList :: [DeviceEventInfoEXT] -> ShowS

Eq DeviceEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: DeviceEventInfoEXT -> DeviceEventInfoEXT -> Bool

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

FromCStruct DeviceEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

peekCStruct :: Ptr DeviceEventInfoEXT -> IO DeviceEventInfoEXT

ToCStruct DeviceEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

withCStruct :: DeviceEventInfoEXT -> (Ptr DeviceEventInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr DeviceEventInfoEXT -> DeviceEventInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DeviceEventInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DeviceEventInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: DeviceEventInfoEXT

data DisplayEventInfoEXT

VkDisplayEventInfoEXT - Describe a display event to create

Valid Usage (Implicit)

See Also

VK_EXT_display_control, DisplayEventTypeEXT, StructureType, registerDisplayEventEXT

Constructors

DisplayEventInfoEXT

Fields

• displayEvent :: DisplayEventTypeEXT

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

  displayEvent must be a valid DisplayEventTypeEXT value

Instances

Storable DisplayEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: DisplayEventInfoEXT -> Int

alignment :: DisplayEventInfoEXT -> Int

peekElemOff :: Ptr DisplayEventInfoEXT -> Int -> IO DisplayEventInfoEXT

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

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

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

peek :: Ptr DisplayEventInfoEXT -> IO DisplayEventInfoEXT

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

Show DisplayEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> DisplayEventInfoEXT -> ShowS

show :: DisplayEventInfoEXT -> String

showList :: [DisplayEventInfoEXT] -> ShowS

Eq DisplayEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: DisplayEventInfoEXT -> DisplayEventInfoEXT -> Bool

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

FromCStruct DisplayEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

peekCStruct :: Ptr DisplayEventInfoEXT -> IO DisplayEventInfoEXT

ToCStruct DisplayEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

withCStruct :: DisplayEventInfoEXT -> (Ptr DisplayEventInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr DisplayEventInfoEXT -> DisplayEventInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayEventInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayEventInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: DisplayEventInfoEXT

data SwapchainCounterCreateInfoEXT

VkSwapchainCounterCreateInfoEXT - Specify the surface counters desired

Valid Usage

• The bits in surfaceCounters must be supported by SwapchainCreateInfoKHR::surface, as reported by getPhysicalDeviceSurfaceCapabilities2EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

• surfaceCounters must be a valid combination of SurfaceCounterFlagBitsEXT values

See Also

VK_EXT_display_control, StructureType, SurfaceCounterFlagsEXT

Constructors

SwapchainCounterCreateInfoEXT

Fields

• surfaceCounters :: SurfaceCounterFlagsEXT

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

Instances

Storable SwapchainCounterCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: SwapchainCounterCreateInfoEXT -> Int

alignment :: SwapchainCounterCreateInfoEXT -> Int

peekElemOff :: Ptr SwapchainCounterCreateInfoEXT -> Int -> IO SwapchainCounterCreateInfoEXT

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

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

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

peek :: Ptr SwapchainCounterCreateInfoEXT -> IO SwapchainCounterCreateInfoEXT

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

Show SwapchainCounterCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> SwapchainCounterCreateInfoEXT -> ShowS

show :: SwapchainCounterCreateInfoEXT -> String

showList :: [SwapchainCounterCreateInfoEXT] -> ShowS

Eq SwapchainCounterCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: SwapchainCounterCreateInfoEXT -> SwapchainCounterCreateInfoEXT -> Bool

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

FromCStruct SwapchainCounterCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

peekCStruct :: Ptr SwapchainCounterCreateInfoEXT -> IO SwapchainCounterCreateInfoEXT

ToCStruct SwapchainCounterCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

withCStruct :: SwapchainCounterCreateInfoEXT -> (Ptr SwapchainCounterCreateInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr SwapchainCounterCreateInfoEXT -> SwapchainCounterCreateInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr SwapchainCounterCreateInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr SwapchainCounterCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SwapchainCounterCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: SwapchainCounterCreateInfoEXT

newtype DisplayPowerStateEXT

VkDisplayPowerStateEXT - Possible power states for a display

See Also

VK_EXT_display_control, DisplayPowerInfoEXT

Constructors

DisplayPowerStateEXT Int32

Bundled Patterns

pattern DISPLAY_POWER_STATE_OFF_EXT :: DisplayPowerStateEXT

DISPLAY_POWER_STATE_OFF_EXT specifies that the display is powered down.

pattern DISPLAY_POWER_STATE_SUSPEND_EXT :: DisplayPowerStateEXT

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 DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in DISPLAY_POWER_STATE_OFF_EXT. This state may be the same as DISPLAY_POWER_STATE_OFF_EXT.

pattern DISPLAY_POWER_STATE_ON_EXT :: DisplayPowerStateEXT

DISPLAY_POWER_STATE_ON_EXT specifies that the display is powered on.

Instances

Storable DisplayPowerStateEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: DisplayPowerStateEXT -> Int

alignment :: DisplayPowerStateEXT -> Int

peekElemOff :: Ptr DisplayPowerStateEXT -> Int -> IO DisplayPowerStateEXT

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

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

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

peek :: Ptr DisplayPowerStateEXT -> IO DisplayPowerStateEXT

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

Read DisplayPowerStateEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

readsPrec :: Int -> ReadS DisplayPowerStateEXT

readList :: ReadS [DisplayPowerStateEXT]

readPrec :: ReadPrec DisplayPowerStateEXT

readListPrec :: ReadPrec [DisplayPowerStateEXT]

Show DisplayPowerStateEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> DisplayPowerStateEXT -> ShowS

show :: DisplayPowerStateEXT -> String

showList :: [DisplayPowerStateEXT] -> ShowS

Eq DisplayPowerStateEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> Bool

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

Ord DisplayPowerStateEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

compare :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> Ordering

(<) :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> Bool

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

(>) :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> Bool

(>=) :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> Bool

max :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> DisplayPowerStateEXT

min :: DisplayPowerStateEXT -> DisplayPowerStateEXT -> DisplayPowerStateEXT

Zero DisplayPowerStateEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: DisplayPowerStateEXT

newtype DeviceEventTypeEXT

VkDeviceEventTypeEXT - Events that can occur on a device object

See Also

VK_EXT_display_control, DeviceEventInfoEXT

Constructors

DeviceEventTypeEXT Int32

Bundled Patterns

pattern DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT :: DeviceEventTypeEXT

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.

Instances

Storable DeviceEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: DeviceEventTypeEXT -> Int

alignment :: DeviceEventTypeEXT -> Int

peekElemOff :: Ptr DeviceEventTypeEXT -> Int -> IO DeviceEventTypeEXT

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

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

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

peek :: Ptr DeviceEventTypeEXT -> IO DeviceEventTypeEXT

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

Read DeviceEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

readsPrec :: Int -> ReadS DeviceEventTypeEXT

readList :: ReadS [DeviceEventTypeEXT]

readPrec :: ReadPrec DeviceEventTypeEXT

readListPrec :: ReadPrec [DeviceEventTypeEXT]

Show DeviceEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> DeviceEventTypeEXT -> ShowS

show :: DeviceEventTypeEXT -> String

showList :: [DeviceEventTypeEXT] -> ShowS

Eq DeviceEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> Bool

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

Ord DeviceEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

compare :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> Ordering

(<) :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> Bool

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

(>) :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> Bool

(>=) :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> Bool

max :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> DeviceEventTypeEXT

min :: DeviceEventTypeEXT -> DeviceEventTypeEXT -> DeviceEventTypeEXT

Zero DeviceEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: DeviceEventTypeEXT

newtype DisplayEventTypeEXT

VkDisplayEventTypeEXT - Events that can occur on a display object

See Also

VK_EXT_display_control, DisplayEventInfoEXT

Constructors

DisplayEventTypeEXT Int32

Bundled Patterns

pattern DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT :: DisplayEventTypeEXT

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.

Instances

Storable DisplayEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

sizeOf :: DisplayEventTypeEXT -> Int

alignment :: DisplayEventTypeEXT -> Int

peekElemOff :: Ptr DisplayEventTypeEXT -> Int -> IO DisplayEventTypeEXT

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

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

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

peek :: Ptr DisplayEventTypeEXT -> IO DisplayEventTypeEXT

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

Read DisplayEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

readsPrec :: Int -> ReadS DisplayEventTypeEXT

readList :: ReadS [DisplayEventTypeEXT]

readPrec :: ReadPrec DisplayEventTypeEXT

readListPrec :: ReadPrec [DisplayEventTypeEXT]

Show DisplayEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

showsPrec :: Int -> DisplayEventTypeEXT -> ShowS

show :: DisplayEventTypeEXT -> String

showList :: [DisplayEventTypeEXT] -> ShowS

Eq DisplayEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

(==) :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> Bool

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

Ord DisplayEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

compare :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> Ordering

(<) :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> Bool

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

(>) :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> Bool

(>=) :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> Bool

max :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> DisplayEventTypeEXT

min :: DisplayEventTypeEXT -> DisplayEventTypeEXT -> DisplayEventTypeEXT

Zero DisplayEventTypeEXT

Defined in Vulkan.Extensions.VK_EXT_display_control

Methods

zero :: DisplayEventTypeEXT

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

VkDisplayKHR - Opaque handle to a display object

See Also

VK_KHR_display, DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireDrmDisplayEXT, acquireWinrtDisplayNV, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getDrmDisplayEXT, getRandROutputDisplayEXT, getWinrtDisplayNV, registerDisplayEventEXT, releaseDisplayEXT

Constructors

DisplayKHR Word64

Instances

Storable DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: DisplayKHR -> Int

alignment :: DisplayKHR -> Int

peekElemOff :: Ptr DisplayKHR -> Int -> IO DisplayKHR

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

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

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

peek :: Ptr DisplayKHR -> IO DisplayKHR

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

Show DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayKHR -> ShowS

show :: DisplayKHR -> String

showList :: [DisplayKHR] -> ShowS

Eq DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: DisplayKHR -> DisplayKHR -> Bool

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

Ord DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: DisplayKHR -> DisplayKHR -> Ordering

(<) :: DisplayKHR -> DisplayKHR -> Bool

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

(>) :: DisplayKHR -> DisplayKHR -> Bool

(>=) :: DisplayKHR -> DisplayKHR -> Bool

max :: DisplayKHR -> DisplayKHR -> DisplayKHR

min :: DisplayKHR -> DisplayKHR -> DisplayKHR

HasObjectType DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayKHR -> (ObjectType, Word64)

IsHandle DisplayKHR

Defined in Vulkan.Extensions.Handles

Zero DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayKHR

newtype SwapchainKHR

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 released 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 application can also release the acquisition of the image through releaseSwapchainImagesEXT, if the image is not in use by the device, and skip the present operation.

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

VK_KHR_swapchain, AcquireNextImageInfoKHR, BindImageMemorySwapchainInfoKHR, ImageSwapchainCreateInfoKHR, PresentInfoKHR, ReleaseSwapchainImagesInfoEXT, SwapchainCreateInfoKHR, acquireFullScreenExclusiveModeEXT, acquireNextImageKHR, createSharedSwapchainsKHR, createSwapchainKHR, destroySwapchainKHR, getLatencyTimingsNV, getPastPresentationTimingGOOGLE, getRefreshCycleDurationGOOGLE, getSwapchainCounterEXT, getSwapchainImagesKHR, getSwapchainStatusKHR, latencySleepNV, queuePresentKHR, releaseFullScreenExclusiveModeEXT, setHdrMetadataEXT, setLatencyMarkerNV, setLatencySleepModeNV, setLocalDimmingAMD, waitForPresentKHR

Constructors

SwapchainKHR Word64

Instances

Storable SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SwapchainKHR -> Int

alignment :: SwapchainKHR -> Int

peekElemOff :: Ptr SwapchainKHR -> Int -> IO SwapchainKHR

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

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

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

peek :: Ptr SwapchainKHR -> IO SwapchainKHR

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

Show SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SwapchainKHR -> ShowS

show :: SwapchainKHR -> String

showList :: [SwapchainKHR] -> ShowS

Eq SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: SwapchainKHR -> SwapchainKHR -> Bool

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

Ord SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SwapchainKHR -> SwapchainKHR -> Ordering

(<) :: SwapchainKHR -> SwapchainKHR -> Bool

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

(>) :: SwapchainKHR -> SwapchainKHR -> Bool

(>=) :: SwapchainKHR -> SwapchainKHR -> Bool

max :: SwapchainKHR -> SwapchainKHR -> SwapchainKHR

min :: SwapchainKHR -> SwapchainKHR -> SwapchainKHR

HasObjectType SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SwapchainKHR -> (ObjectType, Word64)

IsHandle SwapchainKHR

Defined in Vulkan.Extensions.Handles

Zero SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SwapchainKHR

newtype SurfaceCounterFlagBitsEXT

VkSurfaceCounterFlagBitsEXT - Surface-relative counter types

See Also

VK_EXT_display_surface_counter, SurfaceCounterFlagsEXT, getSwapchainCounterEXT

Constructors

SurfaceCounterFlagBitsEXT Flags

Bundled Patterns

pattern SURFACE_COUNTER_VBLANK_BIT_EXT :: SurfaceCounterFlagBitsEXT

SURFACE_COUNTER_VBLANK_BIT_EXT specifies a counter incrementing once every time a vertical blanking period occurs on the display associated with the surface.

Instances

Storable SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

sizeOf :: SurfaceCounterFlagBitsEXT -> Int

alignment :: SurfaceCounterFlagBitsEXT -> Int

peekElemOff :: Ptr SurfaceCounterFlagBitsEXT -> Int -> IO SurfaceCounterFlagBitsEXT

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

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

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

peek :: Ptr SurfaceCounterFlagBitsEXT -> IO SurfaceCounterFlagBitsEXT

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

Bits SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

(.&.) :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT

(.|.) :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT

xor :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT

complement :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT

shift :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

rotate :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

zeroBits :: SurfaceCounterFlagBitsEXT

bit :: Int -> SurfaceCounterFlagBitsEXT

setBit :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

clearBit :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

complementBit :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

testBit :: SurfaceCounterFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: SurfaceCounterFlagBitsEXT -> Maybe Int

bitSize :: SurfaceCounterFlagBitsEXT -> Int

isSigned :: SurfaceCounterFlagBitsEXT -> Bool

shiftL :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

unsafeShiftL :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

shiftR :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

unsafeShiftR :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

rotateL :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

rotateR :: SurfaceCounterFlagBitsEXT -> Int -> SurfaceCounterFlagBitsEXT

popCount :: SurfaceCounterFlagBitsEXT -> Int

FiniteBits SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

finiteBitSize :: SurfaceCounterFlagBitsEXT -> Int

countLeadingZeros :: SurfaceCounterFlagBitsEXT -> Int

countTrailingZeros :: SurfaceCounterFlagBitsEXT -> Int

Read SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

readsPrec :: Int -> ReadS SurfaceCounterFlagBitsEXT

readList :: ReadS [SurfaceCounterFlagBitsEXT]

readPrec :: ReadPrec SurfaceCounterFlagBitsEXT

readListPrec :: ReadPrec [SurfaceCounterFlagBitsEXT]

Show SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

showsPrec :: Int -> SurfaceCounterFlagBitsEXT -> ShowS

show :: SurfaceCounterFlagBitsEXT -> String

showList :: [SurfaceCounterFlagBitsEXT] -> ShowS

Eq SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

(==) :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> Bool

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

Ord SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

compare :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> Ordering

(<) :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> Bool

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

(>) :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> Bool

(>=) :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> Bool

max :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT

min :: SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT -> SurfaceCounterFlagBitsEXT

Zero SurfaceCounterFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_display_surface_counter

Methods

zero :: SurfaceCounterFlagBitsEXT

type SurfaceCounterFlagsEXT = SurfaceCounterFlagBitsEXT