Vulkan.Extensions.VK_EXT_full_screen_exclusive

Name

VK_EXT_full_screen_exclusive - device extension

VK_EXT_full_screen_exclusive

Name String

VK_EXT_full_screen_exclusive

Extension Type

Device extension

Registered Extension Number

256

Revision

4

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2
• Requires VK_KHR_surface
• Requires VK_KHR_get_surface_capabilities2
• Requires VK_KHR_swapchain

Contact

• James Jones https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_EXT_full_screen_exclusive:%20&body=@cubanismo%20

Other Extension Metadata

Last Modified Date

2019-03-12

IP Status

No known IP claims.

Interactions and External Dependencies

• Interacts with Vulkan 1.1
• Interacts with VK_KHR_device_group
• Interacts with VK_KHR_win32_surface

Contributors

• Hans-Kristian Arntzen, ARM
• Slawomir Grajewski, Intel
• Tobias Hector, AMD
• James Jones, NVIDIA
• Daniel Rakos, AMD
• Jeff Juliano, NVIDIA
• Joshua Schnarr, NVIDIA
• Aaron Hagan, AMD

Description

This extension allows applications to set the policy for swapchain creation and presentation mechanisms relating to full-screen access. Implementations may be able to acquire exclusive access to a particular display for an application window that covers the whole screen. This can increase performance on some systems by bypassing composition, however it can also result in disruptive or expensive transitions in the underlying windowing system when a change occurs.

Applications can choose between explicitly disallowing or allowing this behavior, letting the implementation decide, or managing this mode of operation directly using the new acquireFullScreenExclusiveModeEXT and releaseFullScreenExclusiveModeEXT commands.

New Commands

• acquireFullScreenExclusiveModeEXT

• getPhysicalDeviceSurfacePresentModes2EXT
• releaseFullScreenExclusiveModeEXT

If VK_KHR_device_group is supported:

• getDeviceGroupSurfacePresentModes2EXT

If Version 1.1 is supported:

• getDeviceGroupSurfacePresentModes2EXT

New Structures

• Extending PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR:

  • SurfaceFullScreenExclusiveInfoEXT

• Extending SurfaceCapabilities2KHR:

  • SurfaceCapabilitiesFullScreenExclusiveEXT

If VK_KHR_win32_surface is supported:

• Extending PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR:

  • SurfaceFullScreenExclusiveWin32InfoEXT

New Enums

• FullScreenExclusiveEXT

New Enum Constants

• EXT_FULL_SCREEN_EXCLUSIVE_EXTENSION_NAME

• EXT_FULL_SCREEN_EXCLUSIVE_SPEC_VERSION

• Extending Result:

  • ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_SURFACE_CAPABILITIES_FULL_SCREEN_EXCLUSIVE_EXT
  • STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_INFO_EXT

If VK_KHR_win32_surface is supported:

• Extending StructureType:

  • STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_WIN32_INFO_EXT

Issues

1) What should the extension & flag be called?

RESOLVED: VK_EXT_full_screen_exclusive.

Other options considered (prior to the app-controlled mode) were:

• VK_EXT_smooth_fullscreen_transition
• VK_EXT_fullscreen_behavior
• VK_EXT_fullscreen_preference
• VK_EXT_fullscreen_hint
• VK_EXT_fast_fullscreen_transition
• VK_EXT_avoid_fullscreen_exclusive

2) Do we need more than a boolean toggle?

RESOLVED: Yes.

Using an enum with default/allowed/disallowed/app-controlled enables applications to accept driver default behavior, specifically override it in either direction without implying the driver is ever required to use full-screen exclusive mechanisms, or manage this mode explicitly.

3) Should this be a KHR or EXT extension?

RESOLVED: EXT, in order to allow it to be shipped faster.

4) Can the fullscreen hint affect the surface capabilities, and if so, should the hint also be specified as input when querying the surface capabilities?

RESOLVED: Yes on both accounts.

While the hint does not guarantee a particular fullscreen mode will be used when the swapchain is created, it can sometimes imply particular modes will NOT be used. If the driver determines that it will opt-out of using a particular mode based on the policy, and knows it can only support certain capabilities if that mode is used, it would be confusing at best to the application to report those capabilities in such cases. Not allowing implementations to report this state to applications could result in situations where applications are unable to determine why swapchain creation fails when they specify certain hint values, which could result in never- terminating surface creation loops.

5) Should full-screen be one word or two?

RESOLVED: Two words.

"Fullscreen" is not in my dictionary, and web searches did not turn up definitive proof that it is a colloquially accepted compound word. Documentation for the corresponding Windows API mechanisms dithers. The text consistently uses a hyphen, but none-the-less, there is a SetFullscreenState method in the DXGI swapchain object. Given this inconclusive external guidance, it is best to adhere to the Vulkan style guidelines and avoid inventing new compound words.

Version History

• Revision 4, 2019-03-12 (Tobias Hector)

  • Added application-controlled mode, and related functions
  • Tidied up appendix

• Revision 3, 2019-01-03 (James Jones)

  • Renamed to VK_EXT_full_screen_exclusive
  • Made related adjustments to the tri-state enumerant names.

• Revision 2, 2018-11-27 (James Jones)

  • Renamed to VK_KHR_fullscreen_behavior
  • Switched from boolean flag to tri-state enum

• Revision 1, 2018-11-06 (James Jones)

  • Internal revision

See Also

FullScreenExclusiveEXT, SurfaceCapabilitiesFullScreenExclusiveEXT, SurfaceFullScreenExclusiveInfoEXT, acquireFullScreenExclusiveModeEXT, getPhysicalDeviceSurfacePresentModes2EXT, releaseFullScreenExclusiveModeEXT

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

getPhysicalDeviceSurfacePresentModes2EXT

Arguments

:: forall a io. (Extendss PhysicalDeviceSurfaceInfo2KHR a, PokeChain a, MonadIO io)

=> PhysicalDevice

physicalDevice is the physical device that will be associated with the swapchain to be created, as described for createSwapchainKHR.

-> PhysicalDeviceSurfaceInfo2KHR a

pSurfaceInfo is a pointer to a PhysicalDeviceSurfaceInfo2KHR structure describing the surface and other fixed parameters that would be consumed by createSwapchainKHR.

-> io (Result, "presentModes" ::: Vector PresentModeKHR)

vkGetPhysicalDeviceSurfacePresentModes2EXT - Query supported presentation modes

Description

getPhysicalDeviceSurfacePresentModes2EXT behaves similarly to getPhysicalDeviceSurfacePresentModesKHR, with the ability to specify extended inputs via chained input structures.

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• pSurfaceInfo must be a valid pointer to a valid PhysicalDeviceSurfaceInfo2KHR structure
• pPresentModeCount must be a valid pointer to a uint32_t value
• If the value referenced by pPresentModeCount is not 0, and pPresentModes is not NULL, pPresentModes must be a valid pointer to an array of pPresentModeCount PresentModeKHR values

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

PhysicalDevice, PhysicalDeviceSurfaceInfo2KHR, PresentModeKHR

getDeviceGroupSurfacePresentModes2EXT

Arguments

:: forall a io. (Extendss PhysicalDeviceSurfaceInfo2KHR a, PokeChain a, MonadIO io)

=> Device

device is the logical device.

device must be a valid Device handle

-> PhysicalDeviceSurfaceInfo2KHR a

pSurfaceInfo is a pointer to a PhysicalDeviceSurfaceInfo2KHR structure describing the surface and other fixed parameters that would be consumed by createSwapchainKHR.

pSurfaceInfo must be a valid pointer to a valid PhysicalDeviceSurfaceInfo2KHR structure

-> io ("modes" ::: DeviceGroupPresentModeFlagsKHR)

vkGetDeviceGroupSurfacePresentModes2EXT - Query device group present capabilities for a surface

Description

getDeviceGroupSurfacePresentModes2EXT behaves similarly to getDeviceGroupSurfacePresentModesKHR, with the ability to specify extended inputs via chained input structures.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

Device, DeviceGroupPresentModeFlagsKHR, PhysicalDeviceSurfaceInfo2KHR

acquireFullScreenExclusiveModeEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

-> SwapchainKHR

swapchain is the swapchain to acquire exclusive full-screen access for.

-> io ()

vkAcquireFullScreenExclusiveModeEXT - Acquire full-screen exclusive mode for a swapchain

Valid Usage

• swapchain must not be in the retired state

• swapchain must be a swapchain created with a SurfaceFullScreenExclusiveInfoEXT structure, with fullScreenExclusive set to FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT
• swapchain must not currently have exclusive full-screen access

A return value of SUCCESS indicates that the swapchain successfully acquired exclusive full-screen access. The swapchain will retain this exclusivity until either the application releases exclusive full-screen access with releaseFullScreenExclusiveModeEXT, destroys the swapchain, or if any of the swapchain commands return ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT indicating that the mode was lost because of platform-specific changes.

If the swapchain was unable to acquire exclusive full-screen access to the display then ERROR_INITIALIZATION_FAILED is returned. An application can attempt to acquire exclusive full-screen access again for the same swapchain even if this command fails, or if ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT has been returned by a swapchain command.

Valid Usage (Implicit)

• device must be a valid Device handle

• swapchain must be a valid SwapchainKHR handle
• Both of device, and swapchain must have been created, allocated, or retrieved from the same Instance

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED
• ERROR_SURFACE_LOST_KHR

See Also

Device, SwapchainKHR

releaseFullScreenExclusiveModeEXT

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

-> SwapchainKHR

swapchain is the swapchain to release exclusive full-screen access from.

swapchain must not be in the retired state

swapchain must be a swapchain created with a SurfaceFullScreenExclusiveInfoEXT structure, with fullScreenExclusive set to FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT

-> io ()

vkReleaseFullScreenExclusiveModeEXT - Release full-screen exclusive mode from a swapchain

Description

Note

Applications will not be able to present to swapchain after this call until exclusive full-screen access is reacquired. This is usually useful to handle when an application is minimised or otherwise intends to stop presenting for a time.

Valid Usage

See Also

Device, SwapchainKHR

data SurfaceFullScreenExclusiveInfoEXT

VkSurfaceFullScreenExclusiveInfoEXT - Structure specifying the preferred full-screen transition behavior

Description

If this structure is not present, fullScreenExclusive is considered to be FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT.

Valid Usage (Implicit)

See Also

FullScreenExclusiveEXT, StructureType

Constructors

SurfaceFullScreenExclusiveInfoEXT

Fields

• fullScreenExclusive :: FullScreenExclusiveEXT

  fullScreenExclusive is a FullScreenExclusiveEXT value specifying the preferred full-screen transition behavior.

  fullScreenExclusive must be a valid FullScreenExclusiveEXT value

Instances

Eq SurfaceFullScreenExclusiveInfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

(==) :: SurfaceFullScreenExclusiveInfoEXT -> SurfaceFullScreenExclusiveInfoEXT -> Bool

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

Show SurfaceFullScreenExclusiveInfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

showsPrec :: Int -> SurfaceFullScreenExclusiveInfoEXT -> ShowS

show :: SurfaceFullScreenExclusiveInfoEXT -> String

showList :: [SurfaceFullScreenExclusiveInfoEXT] -> ShowS

Storable SurfaceFullScreenExclusiveInfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

sizeOf :: SurfaceFullScreenExclusiveInfoEXT -> Int

alignment :: SurfaceFullScreenExclusiveInfoEXT -> Int

peekElemOff :: Ptr SurfaceFullScreenExclusiveInfoEXT -> Int -> IO SurfaceFullScreenExclusiveInfoEXT

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

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

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

peek :: Ptr SurfaceFullScreenExclusiveInfoEXT -> IO SurfaceFullScreenExclusiveInfoEXT

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

FromCStruct SurfaceFullScreenExclusiveInfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

peekCStruct :: Ptr SurfaceFullScreenExclusiveInfoEXT -> IO SurfaceFullScreenExclusiveInfoEXT

ToCStruct SurfaceFullScreenExclusiveInfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

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

pokeCStruct :: Ptr SurfaceFullScreenExclusiveInfoEXT -> SurfaceFullScreenExclusiveInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SurfaceFullScreenExclusiveInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfaceFullScreenExclusiveInfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

zero :: SurfaceFullScreenExclusiveInfoEXT

data SurfaceFullScreenExclusiveWin32InfoEXT

VkSurfaceFullScreenExclusiveWin32InfoEXT - Structure specifying additional creation parameters specific to Win32 fullscreen exclusive mode

Description

Note

If hmonitor is invalidated (e.g. the monitor is unplugged) during the lifetime of a swapchain created with this structure, operations on that swapchain will return ERROR_OUT_OF_DATE_KHR.

Note

It is the responsibility of the application to change the display settings of the targeted Win32 display using the appropriate platform APIs. Such changes may alter the surface capabilities reported for the created surface.

Valid Usage (Implicit)

See Also

StructureType

Constructors

SurfaceFullScreenExclusiveWin32InfoEXT

Fields

• hmonitor :: HMONITOR

  hmonitor is the Win32 HMONITOR handle identifying the display to create the surface with.

  hmonitor must be a valid HMONITOR

Instances

Eq SurfaceFullScreenExclusiveWin32InfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

(==) :: SurfaceFullScreenExclusiveWin32InfoEXT -> SurfaceFullScreenExclusiveWin32InfoEXT -> Bool

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

Show SurfaceFullScreenExclusiveWin32InfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

showsPrec :: Int -> SurfaceFullScreenExclusiveWin32InfoEXT -> ShowS

show :: SurfaceFullScreenExclusiveWin32InfoEXT -> String

showList :: [SurfaceFullScreenExclusiveWin32InfoEXT] -> ShowS

Storable SurfaceFullScreenExclusiveWin32InfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

sizeOf :: SurfaceFullScreenExclusiveWin32InfoEXT -> Int

alignment :: SurfaceFullScreenExclusiveWin32InfoEXT -> Int

peekElemOff :: Ptr SurfaceFullScreenExclusiveWin32InfoEXT -> Int -> IO SurfaceFullScreenExclusiveWin32InfoEXT

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

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

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

peek :: Ptr SurfaceFullScreenExclusiveWin32InfoEXT -> IO SurfaceFullScreenExclusiveWin32InfoEXT

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

FromCStruct SurfaceFullScreenExclusiveWin32InfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

peekCStruct :: Ptr SurfaceFullScreenExclusiveWin32InfoEXT -> IO SurfaceFullScreenExclusiveWin32InfoEXT

ToCStruct SurfaceFullScreenExclusiveWin32InfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

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

pokeCStruct :: Ptr SurfaceFullScreenExclusiveWin32InfoEXT -> SurfaceFullScreenExclusiveWin32InfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SurfaceFullScreenExclusiveWin32InfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfaceFullScreenExclusiveWin32InfoEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

zero :: SurfaceFullScreenExclusiveWin32InfoEXT

data SurfaceCapabilitiesFullScreenExclusiveEXT

VkSurfaceCapabilitiesFullScreenExclusiveEXT - Structure describing full screen exclusive capabilities of a surface

Description

This structure can be included in the pNext chain of SurfaceCapabilities2KHR to determine support for exclusive full-screen access. If fullScreenExclusiveSupported is FALSE, it indicates that exclusive full-screen access is not obtainable for this surface.

Applications must not attempt to create swapchains with FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT set if fullScreenExclusiveSupported is FALSE.

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

SurfaceCapabilitiesFullScreenExclusiveEXT

Fields

• fullScreenExclusiveSupported :: Bool

Instances

Eq SurfaceCapabilitiesFullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

(==) :: SurfaceCapabilitiesFullScreenExclusiveEXT -> SurfaceCapabilitiesFullScreenExclusiveEXT -> Bool

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

Show SurfaceCapabilitiesFullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

showsPrec :: Int -> SurfaceCapabilitiesFullScreenExclusiveEXT -> ShowS

show :: SurfaceCapabilitiesFullScreenExclusiveEXT -> String

showList :: [SurfaceCapabilitiesFullScreenExclusiveEXT] -> ShowS

Storable SurfaceCapabilitiesFullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

sizeOf :: SurfaceCapabilitiesFullScreenExclusiveEXT -> Int

alignment :: SurfaceCapabilitiesFullScreenExclusiveEXT -> Int

peekElemOff :: Ptr SurfaceCapabilitiesFullScreenExclusiveEXT -> Int -> IO SurfaceCapabilitiesFullScreenExclusiveEXT

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

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

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

peek :: Ptr SurfaceCapabilitiesFullScreenExclusiveEXT -> IO SurfaceCapabilitiesFullScreenExclusiveEXT

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

FromCStruct SurfaceCapabilitiesFullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

peekCStruct :: Ptr SurfaceCapabilitiesFullScreenExclusiveEXT -> IO SurfaceCapabilitiesFullScreenExclusiveEXT

ToCStruct SurfaceCapabilitiesFullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

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

pokeCStruct :: Ptr SurfaceCapabilitiesFullScreenExclusiveEXT -> SurfaceCapabilitiesFullScreenExclusiveEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SurfaceCapabilitiesFullScreenExclusiveEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfaceCapabilitiesFullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

zero :: SurfaceCapabilitiesFullScreenExclusiveEXT

newtype FullScreenExclusiveEXT

VkFullScreenExclusiveEXT - Hint values an application can specify affecting full-screen transition behavior

See Also

SurfaceFullScreenExclusiveInfoEXT

Constructors

FullScreenExclusiveEXT Int32

Bundled Patterns

pattern FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT :: FullScreenExclusiveEXT

FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT indicates the implementation should determine the appropriate full-screen method by whatever means it deems appropriate.

pattern FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT :: FullScreenExclusiveEXT

FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT indicates the implementation may use full-screen exclusive mechanisms when available. Such mechanisms may result in better performance and/or the availability of different presentation capabilities, but may require a more disruptive transition during swapchain initialization, first presentation and/or destruction.

pattern FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT :: FullScreenExclusiveEXT

FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT indicates the implementation should avoid using full-screen mechanisms which rely on disruptive transitions.

pattern FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT :: FullScreenExclusiveEXT

FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT indicates the application will manage full-screen exclusive mode by using the acquireFullScreenExclusiveModeEXT and releaseFullScreenExclusiveModeEXT commands.

Instances

Eq FullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

(==) :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> Bool

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

Ord FullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

compare :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> Ordering

(<) :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> Bool

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

(>) :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> Bool

(>=) :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> Bool

max :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> FullScreenExclusiveEXT

min :: FullScreenExclusiveEXT -> FullScreenExclusiveEXT -> FullScreenExclusiveEXT

Read FullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

readsPrec :: Int -> ReadS FullScreenExclusiveEXT

readList :: ReadS [FullScreenExclusiveEXT]

readPrec :: ReadPrec FullScreenExclusiveEXT

readListPrec :: ReadPrec [FullScreenExclusiveEXT]

Show FullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

showsPrec :: Int -> FullScreenExclusiveEXT -> ShowS

show :: FullScreenExclusiveEXT -> String

showList :: [FullScreenExclusiveEXT] -> ShowS

Storable FullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

sizeOf :: FullScreenExclusiveEXT -> Int

alignment :: FullScreenExclusiveEXT -> Int

peekElemOff :: Ptr FullScreenExclusiveEXT -> Int -> IO FullScreenExclusiveEXT

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

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

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

peek :: Ptr FullScreenExclusiveEXT -> IO FullScreenExclusiveEXT

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

Zero FullScreenExclusiveEXT

Defined in Vulkan.Extensions.VK_EXT_full_screen_exclusive

Methods

zero :: FullScreenExclusiveEXT

type EXT_FULL_SCREEN_EXCLUSIVE_SPEC_VERSION = 4

pattern EXT_FULL_SCREEN_EXCLUSIVE_SPEC_VERSION :: forall a. Integral a => a

type EXT_FULL_SCREEN_EXCLUSIVE_EXTENSION_NAME = "VK_EXT_full_screen_exclusive"

pattern EXT_FULL_SCREEN_EXCLUSIVE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

type HMONITOR = Ptr ()

newtype SurfaceKHR

VkSurfaceKHR - Opaque handle to a surface object

Description

The VK_KHR_surface extension declares the SurfaceKHR object, and provides a function for destroying SurfaceKHR objects. Separate platform-specific extensions each provide a function for creating a SurfaceKHR object for the respective platform. From the application’s perspective this is an opaque handle, just like the handles of other Vulkan objects.

See Also

PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createScreenSurfaceQNX, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64

Instances

Eq SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: SurfaceKHR -> SurfaceKHR -> Bool

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

Ord SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SurfaceKHR -> SurfaceKHR -> Ordering

(<) :: SurfaceKHR -> SurfaceKHR -> Bool

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

(>) :: SurfaceKHR -> SurfaceKHR -> Bool

(>=) :: SurfaceKHR -> SurfaceKHR -> Bool

max :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

min :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

Show SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

Storable SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SurfaceKHR -> Int

alignment :: SurfaceKHR -> Int

peekElemOff :: Ptr SurfaceKHR -> Int -> IO SurfaceKHR

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

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

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

peek :: Ptr SurfaceKHR -> IO SurfaceKHR

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

Zero SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles

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 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, waitForPresentKHR

Constructors

SwapchainKHR Word64

Instances

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

Show SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SwapchainKHR -> ShowS

show :: SwapchainKHR -> String

showList :: [SwapchainKHR] -> ShowS

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 ()

Zero SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SwapchainKHR

HasObjectType SwapchainKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SwapchainKHR -> (ObjectType, Word64)

IsHandle SwapchainKHR

Defined in Vulkan.Extensions.Handles

data PhysicalDeviceSurfaceInfo2KHR (es :: [Type])

VkPhysicalDeviceSurfaceInfo2KHR - Structure specifying a surface and related swapchain creation parameters

Description

The members of PhysicalDeviceSurfaceInfo2KHR correspond to the arguments to getPhysicalDeviceSurfaceCapabilitiesKHR, with sType and pNext added for extensibility.

Additional capabilities of a surface may be available to swapchains created with different full-screen exclusive settings - particularly if exclusive full-screen access is application controlled. These additional capabilities can be queried by adding a SurfaceFullScreenExclusiveInfoEXT structure to the pNext chain of this structure when used to query surface properties. Additionally, for Win32 surfaces with application controlled exclusive full-screen access, chaining a SurfaceFullScreenExclusiveWin32InfoEXT structure may also report additional surface capabilities. These additional capabilities only apply to swapchains created with the same parameters included in the pNext chain of SwapchainCreateInfoKHR.

Valid Usage

• If the pNext chain includes a SurfaceFullScreenExclusiveInfoEXT structure with its fullScreenExclusive member set to FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, and surface was created using createWin32SurfaceKHR, a SurfaceFullScreenExclusiveWin32InfoEXT structure must be included in the pNext chain

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of SurfaceFullScreenExclusiveInfoEXT or SurfaceFullScreenExclusiveWin32InfoEXT
• The sType value of each struct in the pNext chain must be unique
• surface must be a valid SurfaceKHR handle

See Also

StructureType, SurfaceKHR, getDeviceGroupSurfacePresentModes2EXT, getPhysicalDeviceSurfaceCapabilities2KHR, getPhysicalDeviceSurfaceFormats2KHR, getPhysicalDeviceSurfacePresentModes2EXT

Constructors

PhysicalDeviceSurfaceInfo2KHR

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• surface :: SurfaceKHR

  surface is the surface that will be associated with the swapchain.

Instances

Extensible PhysicalDeviceSurfaceInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_get_surface_capabilities2

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). PhysicalDeviceSurfaceInfo2KHR es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). PhysicalDeviceSurfaceInfo2KHR ds -> Chain es -> PhysicalDeviceSurfaceInfo2KHR es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends PhysicalDeviceSurfaceInfo2KHR e => b) -> Maybe b

Show (Chain es) => Show (PhysicalDeviceSurfaceInfo2KHR es)

Defined in Vulkan.Extensions.VK_KHR_get_surface_capabilities2

Methods

showsPrec :: Int -> PhysicalDeviceSurfaceInfo2KHR es -> ShowS

show :: PhysicalDeviceSurfaceInfo2KHR es -> String

showList :: [PhysicalDeviceSurfaceInfo2KHR es] -> ShowS

(Extendss PhysicalDeviceSurfaceInfo2KHR es, PeekChain es) => FromCStruct (PhysicalDeviceSurfaceInfo2KHR es)

Defined in Vulkan.Extensions.VK_KHR_get_surface_capabilities2

Methods

peekCStruct :: Ptr (PhysicalDeviceSurfaceInfo2KHR es) -> IO (PhysicalDeviceSurfaceInfo2KHR es)

(Extendss PhysicalDeviceSurfaceInfo2KHR es, PokeChain es) => ToCStruct (PhysicalDeviceSurfaceInfo2KHR es)

Defined in Vulkan.Extensions.VK_KHR_get_surface_capabilities2

Methods

withCStruct :: PhysicalDeviceSurfaceInfo2KHR es -> (Ptr (PhysicalDeviceSurfaceInfo2KHR es) -> IO b) -> IO b

pokeCStruct :: Ptr (PhysicalDeviceSurfaceInfo2KHR es) -> PhysicalDeviceSurfaceInfo2KHR es -> IO b -> IO b

withZeroCStruct :: (Ptr (PhysicalDeviceSurfaceInfo2KHR es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (PhysicalDeviceSurfaceInfo2KHR es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (PhysicalDeviceSurfaceInfo2KHR es)

Defined in Vulkan.Extensions.VK_KHR_get_surface_capabilities2

Methods

zero :: PhysicalDeviceSurfaceInfo2KHR es

newtype PresentModeKHR

VkPresentModeKHR - presentation mode supported for a surface

Description

The supported ImageUsageFlagBits of the presentable images of a swapchain created for a surface may differ depending on the presentation mode, and can be determined as per the table below:

Presentation mode	Image usage flags
PRESENT_MODE_IMMEDIATE_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_MAILBOX_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_FIFO_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_FIFO_RELAXED_KHR	SurfaceCapabilitiesKHR::supportedUsageFlags
PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR	SharedPresentSurfaceCapabilitiesKHR::sharedPresentSupportedUsageFlags
PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR	SharedPresentSurfaceCapabilitiesKHR::sharedPresentSupportedUsageFlags

Presentable image usage queries

Note

For reference, the mode indicated by PRESENT_MODE_FIFO_KHR is equivalent to the behavior of {wgl|glX|egl}SwapBuffers with a swap interval of 1, while the mode indicated by PRESENT_MODE_FIFO_RELAXED_KHR is equivalent to the behavior of {wgl|glX}SwapBuffers with a swap interval of -1 (from the {WGL|GLX}_EXT_swap_control_tear extensions).

See Also

SwapchainCreateInfoKHR, getPhysicalDeviceSurfacePresentModes2EXT, getPhysicalDeviceSurfacePresentModesKHR

Constructors

PresentModeKHR Int32

Bundled Patterns

pattern PRESENT_MODE_IMMEDIATE_KHR :: PresentModeKHR

PRESENT_MODE_IMMEDIATE_KHR specifies that the presentation engine does not wait for a vertical blanking period to update the current image, meaning this mode may result in visible tearing. No internal queuing of presentation requests is needed, as the requests are applied immediately.

pattern PRESENT_MODE_MAILBOX_KHR :: PresentModeKHR

PRESENT_MODE_MAILBOX_KHR specifies that the presentation engine waits for the next vertical blanking period to update the current image. Tearing cannot be observed. An internal single-entry queue is used to hold pending presentation requests. If the queue is full when a new presentation request is received, the new request replaces the existing entry, and any images associated with the prior entry become available for re-use by the application. One request is removed from the queue and processed during each vertical blanking period in which the queue is non-empty.

pattern PRESENT_MODE_FIFO_KHR :: PresentModeKHR

PRESENT_MODE_FIFO_KHR specifies that the presentation engine waits for the next vertical blanking period to update the current image. Tearing cannot be observed. An internal queue is used to hold pending presentation requests. New requests are appended to the end of the queue, and one request is removed from the beginning of the queue and processed during each vertical blanking period in which the queue is non-empty. This is the only value of presentMode that is required to be supported.

pattern PRESENT_MODE_FIFO_RELAXED_KHR :: PresentModeKHR

PRESENT_MODE_FIFO_RELAXED_KHR specifies that the presentation engine generally waits for the next vertical blanking period to update the current image. If a vertical blanking period has already passed since the last update of the current image then the presentation engine does not wait for another vertical blanking period for the update, meaning this mode may result in visible tearing in this case. This mode is useful for reducing visual stutter with an application that will mostly present a new image before the next vertical blanking period, but may occasionally be late, and present a new image just after the next vertical blanking period. An internal queue is used to hold pending presentation requests. New requests are appended to the end of the queue, and one request is removed from the beginning of the queue and processed during or after each vertical blanking period in which the queue is non-empty.

pattern PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR :: PresentModeKHR

PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR specifies that the presentation engine and application have concurrent access to a single image, which is referred to as a shared presentable image. The presentation engine periodically updates the current image on its regular refresh cycle. The application is only required to make one initial presentation request, after which the presentation engine must update the current image without any need for further presentation requests. The application can indicate the image contents have been updated by making a presentation request, but this does not guarantee the timing of when it will be updated. This mode may result in visible tearing if rendering to the image is not timed correctly.

pattern PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR :: PresentModeKHR

PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR specifies that the presentation engine and application have concurrent access to a single image, which is referred to as a shared presentable image. The presentation engine is only required to update the current image after a new presentation request is received. Therefore the application must make a presentation request whenever an update is required. However, the presentation engine may update the current image at any point, meaning this mode may result in visible tearing.

Instances

Eq PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

(==) :: PresentModeKHR -> PresentModeKHR -> Bool

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

Ord PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

compare :: PresentModeKHR -> PresentModeKHR -> Ordering

(<) :: PresentModeKHR -> PresentModeKHR -> Bool

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

(>) :: PresentModeKHR -> PresentModeKHR -> Bool

(>=) :: PresentModeKHR -> PresentModeKHR -> Bool

max :: PresentModeKHR -> PresentModeKHR -> PresentModeKHR

min :: PresentModeKHR -> PresentModeKHR -> PresentModeKHR

Read PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

readsPrec :: Int -> ReadS PresentModeKHR

readList :: ReadS [PresentModeKHR]

readPrec :: ReadPrec PresentModeKHR

readListPrec :: ReadPrec [PresentModeKHR]

Show PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

showsPrec :: Int -> PresentModeKHR -> ShowS

show :: PresentModeKHR -> String

showList :: [PresentModeKHR] -> ShowS

Storable PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

sizeOf :: PresentModeKHR -> Int

alignment :: PresentModeKHR -> Int

peekElemOff :: Ptr PresentModeKHR -> Int -> IO PresentModeKHR

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

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

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

peek :: Ptr PresentModeKHR -> IO PresentModeKHR

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

Zero PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

zero :: PresentModeKHR

newtype DeviceGroupPresentModeFlagBitsKHR

VkDeviceGroupPresentModeFlagBitsKHR - Bitmask specifying supported device group present modes

See Also

DeviceGroupPresentInfoKHR, DeviceGroupPresentModeFlagsKHR

Constructors

DeviceGroupPresentModeFlagBitsKHR Flags

Bundled Patterns

pattern DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR :: DeviceGroupPresentModeFlagBitsKHR

DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR specifies that any physical device with a presentation engine can present its own swapchain images.

pattern DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR :: DeviceGroupPresentModeFlagBitsKHR

DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR specifies that any physical device with a presentation engine can present swapchain images from any physical device in its presentMask.

pattern DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR :: DeviceGroupPresentModeFlagBitsKHR

DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR specifies that any physical device with a presentation engine can present the sum of swapchain images from any physical devices in its presentMask.

pattern DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR :: DeviceGroupPresentModeFlagBitsKHR

DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR specifies that multiple physical devices with a presentation engine can each present their own swapchain images.

Instances

Eq DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> Bool

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

Ord DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

compare :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> Ordering

(<) :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> Bool

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

(>) :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> Bool

(>=) :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> Bool

max :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR

min :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR

Read DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

readsPrec :: Int -> ReadS DeviceGroupPresentModeFlagBitsKHR

readList :: ReadS [DeviceGroupPresentModeFlagBitsKHR]

readPrec :: ReadPrec DeviceGroupPresentModeFlagBitsKHR

readListPrec :: ReadPrec [DeviceGroupPresentModeFlagBitsKHR]

Show DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> DeviceGroupPresentModeFlagBitsKHR -> ShowS

show :: DeviceGroupPresentModeFlagBitsKHR -> String

showList :: [DeviceGroupPresentModeFlagBitsKHR] -> ShowS

Storable DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: DeviceGroupPresentModeFlagBitsKHR -> Int

alignment :: DeviceGroupPresentModeFlagBitsKHR -> Int

peekElemOff :: Ptr DeviceGroupPresentModeFlagBitsKHR -> Int -> IO DeviceGroupPresentModeFlagBitsKHR

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

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

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

peek :: Ptr DeviceGroupPresentModeFlagBitsKHR -> IO DeviceGroupPresentModeFlagBitsKHR

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

Bits DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(.&.) :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR

(.|.) :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR

xor :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR

complement :: DeviceGroupPresentModeFlagBitsKHR -> DeviceGroupPresentModeFlagBitsKHR

shift :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

rotate :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

zeroBits :: DeviceGroupPresentModeFlagBitsKHR

bit :: Int -> DeviceGroupPresentModeFlagBitsKHR

setBit :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

clearBit :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

complementBit :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

testBit :: DeviceGroupPresentModeFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: DeviceGroupPresentModeFlagBitsKHR -> Maybe Int

bitSize :: DeviceGroupPresentModeFlagBitsKHR -> Int

isSigned :: DeviceGroupPresentModeFlagBitsKHR -> Bool

shiftL :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

unsafeShiftL :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

shiftR :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

unsafeShiftR :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

rotateL :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

rotateR :: DeviceGroupPresentModeFlagBitsKHR -> Int -> DeviceGroupPresentModeFlagBitsKHR

popCount :: DeviceGroupPresentModeFlagBitsKHR -> Int

FiniteBits DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

finiteBitSize :: DeviceGroupPresentModeFlagBitsKHR -> Int

countLeadingZeros :: DeviceGroupPresentModeFlagBitsKHR -> Int

countTrailingZeros :: DeviceGroupPresentModeFlagBitsKHR -> Int

Zero DeviceGroupPresentModeFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: DeviceGroupPresentModeFlagBitsKHR

type DeviceGroupPresentModeFlagsKHR = DeviceGroupPresentModeFlagBitsKHR