Vulkan.Extensions.VK_KHR_device_group

Name

VK_KHR_device_group - device extension

VK_KHR_device_group

Name String

VK_KHR_device_group

Extension Type

Device extension

Registered Extension Number

61

Revision

4

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_device_group_creation

Deprecation state

• Promoted to Vulkan 1.1

Contact

• Jeff Bolz @jeffbolznv%0A<<Here describe the issue or question you have about the VK_KHR_device_group extension> >

Other Extension Metadata

Last Modified Date

2017-10-10

IP Status

No known IP claims.

Interactions and External Dependencies

• Promoted to Vulkan 1.1 Core

Contributors

• Jeff Bolz, NVIDIA
• Tobias Hector, Imagination Technologies

Description

This extension provides functionality to use a logical device that consists of multiple physical devices, as created with the VK_KHR_device_group_creation extension. A device group can allocate memory across the subdevices, bind memory from one subdevice to a resource on another subdevice, record command buffers where some work executes on an arbitrary subset of the subdevices, and potentially present a swapchain image from one or more subdevices.

Promotion to Vulkan 1.1

The following enums, types and commands are included as interactions with VK_KHR_swapchain:

• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR
• STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
• STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR
• SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
• DeviceGroupPresentModeFlagBitsKHR
• DeviceGroupPresentCapabilitiesKHR
• ImageSwapchainCreateInfoKHR
• BindImageMemorySwapchainInfoKHR
• AcquireNextImageInfoKHR
• DeviceGroupPresentInfoKHR
• DeviceGroupSwapchainCreateInfoKHR
• getDeviceGroupPresentCapabilitiesKHR
• getDeviceGroupSurfacePresentModesKHR
• getPhysicalDevicePresentRectanglesKHR
• acquireNextImage2KHR

If Vulkan 1.1 and VK_KHR_swapchain are supported, these are included by VK_KHR_swapchain.

The base functionality in this extension is included in core Vulkan 1.1, with the KHR suffix omitted. The original type, enum and command names are still available as aliases of the core functionality.

New Commands

• cmdDispatchBaseKHR

• cmdSetDeviceMaskKHR
• getDeviceGroupPeerMemoryFeaturesKHR

If VK_KHR_surface is supported:

• getDeviceGroupPresentCapabilitiesKHR
• getDeviceGroupSurfacePresentModesKHR
• getPhysicalDevicePresentRectanglesKHR

If VK_KHR_swapchain is supported:

• acquireNextImage2KHR

New Structures

• Extending BindSparseInfo:

  • DeviceGroupBindSparseInfoKHR

• Extending CommandBufferBeginInfo:

  • DeviceGroupCommandBufferBeginInfoKHR

• Extending MemoryAllocateInfo:

  • MemoryAllocateFlagsInfoKHR

• Extending RenderPassBeginInfo, RenderingInfoKHR:

  • DeviceGroupRenderPassBeginInfoKHR

• Extending SubmitInfo:

  • DeviceGroupSubmitInfoKHR

If VK_KHR_bind_memory2 is supported:

• Extending BindBufferMemoryInfo:

  • BindBufferMemoryDeviceGroupInfoKHR

• Extending BindImageMemoryInfo:

  • BindImageMemoryDeviceGroupInfoKHR

If VK_KHR_surface is supported:

• DeviceGroupPresentCapabilitiesKHR

If VK_KHR_swapchain is supported:

• AcquireNextImageInfoKHR

• Extending BindImageMemoryInfo:

  • BindImageMemorySwapchainInfoKHR

• Extending ImageCreateInfo:

  • ImageSwapchainCreateInfoKHR

• Extending PresentInfoKHR:

  • DeviceGroupPresentInfoKHR

• Extending SwapchainCreateInfoKHR:

  • DeviceGroupSwapchainCreateInfoKHR

New Enums

• MemoryAllocateFlagBitsKHR

• PeerMemoryFeatureFlagBitsKHR

If VK_KHR_surface is supported:

• DeviceGroupPresentModeFlagBitsKHR

New Bitmasks

• MemoryAllocateFlagsKHR

• PeerMemoryFeatureFlagsKHR

If VK_KHR_surface is supported:

• DeviceGroupPresentModeFlagsKHR

New Enum Constants

• KHR_DEVICE_GROUP_EXTENSION_NAME

• KHR_DEVICE_GROUP_SPEC_VERSION

• Extending DependencyFlagBits:

  • DEPENDENCY_DEVICE_GROUP_BIT_KHR

• Extending MemoryAllocateFlagBits:

  • MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHR

• Extending PeerMemoryFeatureFlagBits:

  • PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
  • PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
  • PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR
  • PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR

• Extending PipelineCreateFlagBits:

  • PIPELINE_CREATE_DISPATCH_BASE_KHR
  • PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR
  • STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
  • STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
  • STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
  • STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR

If VK_KHR_bind_memory2 is supported:

• Extending ImageCreateFlagBits:

  • IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR
  • STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR

If VK_KHR_surface is supported:

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR

If VK_KHR_swapchain is supported:

• Extending StructureType:

  • STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
  • STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
  • STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
  • STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR
  • STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR

• Extending SwapchainCreateFlagBitsKHR:

  • SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR

New Built-in Variables

• DeviceIndex

New SPIR-V Capabilities

• DeviceGroup

Version History

• Revision 1, 2016-10-19 (Jeff Bolz)

  • Internal revisions

• Revision 2, 2017-05-19 (Tobias Hector)

  • Removed extended memory bind functions to VK_KHR_bind_memory2, added dependency on that extension, and device-group-specific structs for those functions.

• Revision 3, 2017-10-06 (Ian Elliott)

  • Corrected Vulkan 1.1 interactions with the WSI extensions. All Vulkan 1.1 WSI interactions are with the VK_KHR_swapchain extension.

• Revision 4, 2017-10-10 (Jeff Bolz)

  • Rename “SFR” bits and structure members to use the phrase “split instance bind regions”.

See Also

DeviceGroupBindSparseInfoKHR, DeviceGroupCommandBufferBeginInfoKHR, DeviceGroupRenderPassBeginInfoKHR, DeviceGroupSubmitInfoKHR, MemoryAllocateFlagBitsKHR, MemoryAllocateFlagsInfoKHR, MemoryAllocateFlagsKHR, PeerMemoryFeatureFlagBitsKHR, PeerMemoryFeatureFlagsKHR, cmdDispatchBaseKHR, cmdSetDeviceMaskKHR, getDeviceGroupPeerMemoryFeaturesKHR

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

pattern STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR :: StructureType

pattern STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR :: StructureType

pattern STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR :: StructureType

pattern STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR :: StructureType

pattern STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR :: StructureType

pattern PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR :: PeerMemoryFeatureFlagBits

pattern PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR :: PeerMemoryFeatureFlagBits

pattern PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR :: PeerMemoryFeatureFlagBits

pattern PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR :: PeerMemoryFeatureFlagBits

pattern MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHR :: MemoryAllocateFlagBits

pattern PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR :: PipelineCreateFlagBits

pattern PIPELINE_CREATE_DISPATCH_BASE_KHR :: PipelineCreateFlagBits

pattern DEPENDENCY_DEVICE_GROUP_BIT_KHR :: DependencyFlagBits

pattern STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR :: StructureType

pattern STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR :: StructureType

pattern IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR :: ImageCreateFlagBits

getDeviceGroupPeerMemoryFeaturesKHR :: MonadIO io => Device -> ("heapIndex" ::: Word32) -> ("localDeviceIndex" ::: Word32) -> ("remoteDeviceIndex" ::: Word32) -> io ("peerMemoryFeatures" ::: PeerMemoryFeatureFlags)

cmdSetDeviceMaskKHR :: MonadIO io => CommandBuffer -> ("deviceMask" ::: Word32) -> io ()

cmdDispatchBaseKHR :: MonadIO io => CommandBuffer -> ("baseGroupX" ::: Word32) -> ("baseGroupY" ::: Word32) -> ("baseGroupZ" ::: Word32) -> ("groupCountX" ::: Word32) -> ("groupCountY" ::: Word32) -> ("groupCountZ" ::: Word32) -> io ()

type PeerMemoryFeatureFlagsKHR = PeerMemoryFeatureFlags

type MemoryAllocateFlagsKHR = MemoryAllocateFlags

type PeerMemoryFeatureFlagBitsKHR = PeerMemoryFeatureFlagBits

type MemoryAllocateFlagBitsKHR = MemoryAllocateFlagBits

type MemoryAllocateFlagsInfoKHR = MemoryAllocateFlagsInfo

type BindBufferMemoryDeviceGroupInfoKHR = BindBufferMemoryDeviceGroupInfo

type BindImageMemoryDeviceGroupInfoKHR = BindImageMemoryDeviceGroupInfo

type DeviceGroupRenderPassBeginInfoKHR = DeviceGroupRenderPassBeginInfo

type DeviceGroupCommandBufferBeginInfoKHR = DeviceGroupCommandBufferBeginInfo

type DeviceGroupSubmitInfoKHR = DeviceGroupSubmitInfo

type DeviceGroupBindSparseInfoKHR = DeviceGroupBindSparseInfo

type KHR_DEVICE_GROUP_SPEC_VERSION = 4

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

type KHR_DEVICE_GROUP_EXTENSION_NAME = "VK_KHR_device_group"

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

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

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

VK_KHR_swapchain, AcquireNextImageInfoKHR, BindImageMemorySwapchainInfoKHR, ImageSwapchainCreateInfoKHR, PresentInfoKHR, SwapchainCreateInfoKHR, acquireFullScreenExclusiveModeEXT, acquireNextImageKHR, createSharedSwapchainsKHR, createSwapchainKHR, destroySwapchainKHR, getPastPresentationTimingGOOGLE, getRefreshCycleDurationGOOGLE, getSwapchainCounterEXT, getSwapchainImagesKHR, getSwapchainStatusKHR, queuePresentKHR, 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 DeviceGroupPresentCapabilitiesKHR

VkDeviceGroupPresentCapabilitiesKHR - Present capabilities from other physical devices

Description

modes always has DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR set.

The present mode flags are also used when presenting an image, in DeviceGroupPresentInfoKHR::mode.

If a device group only includes a single physical device, then modes must equal DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR.

Valid Usage (Implicit)

See Also

VK_KHR_device_group, VK_KHR_surface, VK_KHR_swapchain, VK_VERSION_1_1, DeviceGroupPresentModeFlagsKHR, StructureType, getDeviceGroupPresentCapabilitiesKHR

Constructors

DeviceGroupPresentCapabilitiesKHR

Fields

• presentMask :: Vector Word32

  presentMask is an array of MAX_DEVICE_GROUP_SIZE uint32_t masks, where the mask at element i is non-zero if physical device i has a presentation engine, and where bit j is set in element i if physical device i can present swapchain images from physical device j. If element i is non-zero, then bit i must be set.

• modes :: DeviceGroupPresentModeFlagsKHR

  modes is a bitmask of DeviceGroupPresentModeFlagBitsKHR indicating which device group presentation modes are supported.

Instances

Show DeviceGroupPresentCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> DeviceGroupPresentCapabilitiesKHR -> ShowS

show :: DeviceGroupPresentCapabilitiesKHR -> String

showList :: [DeviceGroupPresentCapabilitiesKHR] -> ShowS

Storable DeviceGroupPresentCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: DeviceGroupPresentCapabilitiesKHR -> Int

alignment :: DeviceGroupPresentCapabilitiesKHR -> Int

peekElemOff :: Ptr DeviceGroupPresentCapabilitiesKHR -> Int -> IO DeviceGroupPresentCapabilitiesKHR

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

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

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

peek :: Ptr DeviceGroupPresentCapabilitiesKHR -> IO DeviceGroupPresentCapabilitiesKHR

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

FromCStruct DeviceGroupPresentCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

peekCStruct :: Ptr DeviceGroupPresentCapabilitiesKHR -> IO DeviceGroupPresentCapabilitiesKHR

ToCStruct DeviceGroupPresentCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

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

pokeCStruct :: Ptr DeviceGroupPresentCapabilitiesKHR -> DeviceGroupPresentCapabilitiesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceGroupPresentCapabilitiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceGroupPresentCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: DeviceGroupPresentCapabilitiesKHR

data ImageSwapchainCreateInfoKHR

VkImageSwapchainCreateInfoKHR - Specify that an image will be bound to swapchain memory

Valid Usage

• If swapchain is not NULL_HANDLE, the fields of ImageCreateInfo must match the implied image creation parameters of the swapchain

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR

• If swapchain is not NULL_HANDLE, swapchain must be a valid SwapchainKHR handle

See Also

VK_KHR_device_group, VK_KHR_swapchain, VK_VERSION_1_1, StructureType, SwapchainKHR

Constructors

ImageSwapchainCreateInfoKHR

Fields

• swapchain :: SwapchainKHR

  swapchain is NULL_HANDLE or a handle of a swapchain that the image will be bound to.

Instances

Eq ImageSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: ImageSwapchainCreateInfoKHR -> ImageSwapchainCreateInfoKHR -> Bool

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

Show ImageSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> ImageSwapchainCreateInfoKHR -> ShowS

show :: ImageSwapchainCreateInfoKHR -> String

showList :: [ImageSwapchainCreateInfoKHR] -> ShowS

Storable ImageSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: ImageSwapchainCreateInfoKHR -> Int

alignment :: ImageSwapchainCreateInfoKHR -> Int

peekElemOff :: Ptr ImageSwapchainCreateInfoKHR -> Int -> IO ImageSwapchainCreateInfoKHR

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

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

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

peek :: Ptr ImageSwapchainCreateInfoKHR -> IO ImageSwapchainCreateInfoKHR

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

FromCStruct ImageSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

peekCStruct :: Ptr ImageSwapchainCreateInfoKHR -> IO ImageSwapchainCreateInfoKHR

ToCStruct ImageSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

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

pokeCStruct :: Ptr ImageSwapchainCreateInfoKHR -> ImageSwapchainCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ImageSwapchainCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: ImageSwapchainCreateInfoKHR

data BindImageMemorySwapchainInfoKHR

VkBindImageMemorySwapchainInfoKHR - Structure specifying swapchain image memory to bind to

Description

If swapchain is not NULL, the swapchain and imageIndex are used to determine the memory that the image is bound to, instead of memory and memoryOffset.

Memory can be bound to a swapchain and use the pDeviceIndices or pSplitInstanceBindRegions members of BindImageMemoryDeviceGroupInfo.

Valid Usage

• imageIndex must be less than the number of images in swapchain

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR

• swapchain must be a valid SwapchainKHR handle

Host Synchronization

• Host access to swapchain must be externally synchronized

See Also

VK_KHR_device_group, VK_KHR_swapchain, VK_VERSION_1_1, StructureType, SwapchainKHR

Constructors

BindImageMemorySwapchainInfoKHR

Fields

• swapchain :: SwapchainKHR

  swapchain is NULL_HANDLE or a swapchain handle.

• imageIndex :: Word32

  imageIndex is an image index within swapchain.

Instances

Eq BindImageMemorySwapchainInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: BindImageMemorySwapchainInfoKHR -> BindImageMemorySwapchainInfoKHR -> Bool

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

Show BindImageMemorySwapchainInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> BindImageMemorySwapchainInfoKHR -> ShowS

show :: BindImageMemorySwapchainInfoKHR -> String

showList :: [BindImageMemorySwapchainInfoKHR] -> ShowS

Storable BindImageMemorySwapchainInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: BindImageMemorySwapchainInfoKHR -> Int

alignment :: BindImageMemorySwapchainInfoKHR -> Int

peekElemOff :: Ptr BindImageMemorySwapchainInfoKHR -> Int -> IO BindImageMemorySwapchainInfoKHR

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

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

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

peek :: Ptr BindImageMemorySwapchainInfoKHR -> IO BindImageMemorySwapchainInfoKHR

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

FromCStruct BindImageMemorySwapchainInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

peekCStruct :: Ptr BindImageMemorySwapchainInfoKHR -> IO BindImageMemorySwapchainInfoKHR

ToCStruct BindImageMemorySwapchainInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

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

pokeCStruct :: Ptr BindImageMemorySwapchainInfoKHR -> BindImageMemorySwapchainInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BindImageMemorySwapchainInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BindImageMemorySwapchainInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: BindImageMemorySwapchainInfoKHR

data AcquireNextImageInfoKHR

VkAcquireNextImageInfoKHR - Structure specifying parameters of the acquire

Description

If acquireNextImageKHR is used, the device mask is considered to include all physical devices in the logical device.

Note

acquireNextImage2KHR signals at most one semaphore, even if the application requests waiting for multiple physical devices to be ready via the deviceMask. However, only a single physical device can wait on that semaphore, since the semaphore becomes unsignaled when the wait succeeds. For other physical devices to wait for the image to be ready, it is necessary for the application to submit semaphore signal operation(s) to that first physical device to signal additional semaphore(s) after the wait succeeds, which the other physical device(s) can wait upon.

Valid Usage

• swapchain must not be in the retired state

• If semaphore is not NULL_HANDLE it must be unsignaled
• If semaphore is not NULL_HANDLE it must not have any uncompleted signal or wait operations pending
• If fence is not NULL_HANDLE it must be unsignaled and must not be associated with any other queue command that has not yet completed execution on that queue
• semaphore and fence must not both be equal to NULL_HANDLE
• deviceMask must be a valid device mask
• deviceMask must not be zero
• semaphore must have a SemaphoreType of SEMAPHORE_TYPE_BINARY

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR

• pNext must be NULL
• swapchain must be a valid SwapchainKHR handle
• If semaphore is not NULL_HANDLE, semaphore must be a valid Semaphore handle
• If fence is not NULL_HANDLE, fence must be a valid Fence handle
• Each of fence, semaphore, and swapchain that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Instance

Host Synchronization

• Host access to swapchain must be externally synchronized

• Host access to semaphore must be externally synchronized
• Host access to fence must be externally synchronized

See Also

VK_KHR_device_group, VK_KHR_swapchain, VK_VERSION_1_1, Fence, Semaphore, StructureType, SwapchainKHR, acquireNextImage2KHR

Constructors

AcquireNextImageInfoKHR

Fields

• swapchain :: SwapchainKHR

  swapchain is a non-retired swapchain from which an image is acquired.

• timeout :: Word64

  timeout specifies how long the function waits, in nanoseconds, if no image is available.

• semaphore :: Semaphore

  semaphore is NULL_HANDLE or a semaphore to signal.

• fence :: Fence

  fence is NULL_HANDLE or a fence to signal.

• deviceMask :: Word32

  deviceMask is a mask of physical devices for which the swapchain image will be ready to use when the semaphore or fence is signaled.

Instances

Eq AcquireNextImageInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: AcquireNextImageInfoKHR -> AcquireNextImageInfoKHR -> Bool

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

Show AcquireNextImageInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> AcquireNextImageInfoKHR -> ShowS

show :: AcquireNextImageInfoKHR -> String

showList :: [AcquireNextImageInfoKHR] -> ShowS

Storable AcquireNextImageInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: AcquireNextImageInfoKHR -> Int

alignment :: AcquireNextImageInfoKHR -> Int

peekElemOff :: Ptr AcquireNextImageInfoKHR -> Int -> IO AcquireNextImageInfoKHR

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

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

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

peek :: Ptr AcquireNextImageInfoKHR -> IO AcquireNextImageInfoKHR

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

FromCStruct AcquireNextImageInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

peekCStruct :: Ptr AcquireNextImageInfoKHR -> IO AcquireNextImageInfoKHR

ToCStruct AcquireNextImageInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

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

pokeCStruct :: Ptr AcquireNextImageInfoKHR -> AcquireNextImageInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AcquireNextImageInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AcquireNextImageInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: AcquireNextImageInfoKHR

data DeviceGroupPresentInfoKHR

VkDeviceGroupPresentInfoKHR - Mode and mask controlling which physical devices' images are presented

Description

If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element of pDeviceMasks selects which instance of the swapchain image is presented. Each element of pDeviceMasks must have exactly one bit set, and the corresponding physical device must have a presentation engine as reported by DeviceGroupPresentCapabilitiesKHR.

If mode is DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR, then each element of pDeviceMasks selects which instance of the swapchain image is presented. Each element of pDeviceMasks must have exactly one bit set, and some physical device in the logical device must include that bit in its DeviceGroupPresentCapabilitiesKHR::presentMask.

If mode is DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR, then each element of pDeviceMasks selects which instances of the swapchain image are component-wise summed and the sum of those images is presented. If the sum in any component is outside the representable range, the value of that component is undefined. Each element of pDeviceMasks must have a value for which all set bits are set in one of the elements of DeviceGroupPresentCapabilitiesKHR::presentMask.

If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then each element of pDeviceMasks selects which instance(s) of the swapchain images are presented. For each bit set in each element of pDeviceMasks, the corresponding physical device must have a presentation engine as reported by DeviceGroupPresentCapabilitiesKHR.

If DeviceGroupPresentInfoKHR is not provided or swapchainCount is zero then the masks are considered to be 1. If DeviceGroupPresentInfoKHR is not provided, mode is considered to be DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR.

Valid Usage

• swapchainCount must equal 0 or PresentInfoKHR::swapchainCount

• If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element of pDeviceMasks must have exactly one bit set, and the corresponding element of DeviceGroupPresentCapabilitiesKHR::presentMask must be non-zero
• If mode is DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR, then each element of pDeviceMasks must have exactly one bit set, and some physical device in the logical device must include that bit in its DeviceGroupPresentCapabilitiesKHR::presentMask
• If mode is DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR, then each element of pDeviceMasks must have a value for which all set bits are set in one of the elements of DeviceGroupPresentCapabilitiesKHR::presentMask
• If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then for each bit set in each element of pDeviceMasks, the corresponding element of DeviceGroupPresentCapabilitiesKHR::presentMask must be non-zero
• The value of each element of pDeviceMasks must be equal to the device mask passed in AcquireNextImageInfoKHR::deviceMask when the image index was last acquired
• mode must have exactly one bit set, and that bit must have been included in DeviceGroupSwapchainCreateInfoKHR::modes

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR

• If swapchainCount is not 0, pDeviceMasks must be a valid pointer to an array of swapchainCount uint32_t values
• mode must be a valid DeviceGroupPresentModeFlagBitsKHR value

See Also

VK_KHR_device_group, VK_KHR_swapchain, VK_VERSION_1_1, DeviceGroupPresentModeFlagBitsKHR, StructureType

Constructors

DeviceGroupPresentInfoKHR

Fields

• deviceMasks :: Vector Word32

  pDeviceMasks is a pointer to an array of device masks, one for each element of PresentInfoKHR::pSwapchains.

• mode :: DeviceGroupPresentModeFlagBitsKHR

  mode is a DeviceGroupPresentModeFlagBitsKHR value specifying the device group present mode that will be used for this present.

Instances

Show DeviceGroupPresentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> DeviceGroupPresentInfoKHR -> ShowS

show :: DeviceGroupPresentInfoKHR -> String

showList :: [DeviceGroupPresentInfoKHR] -> ShowS

FromCStruct DeviceGroupPresentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

peekCStruct :: Ptr DeviceGroupPresentInfoKHR -> IO DeviceGroupPresentInfoKHR

ToCStruct DeviceGroupPresentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

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

pokeCStruct :: Ptr DeviceGroupPresentInfoKHR -> DeviceGroupPresentInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceGroupPresentInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceGroupPresentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: DeviceGroupPresentInfoKHR

data DeviceGroupSwapchainCreateInfoKHR

VkDeviceGroupSwapchainCreateInfoKHR - Structure specifying parameters of a newly created swapchain object

Description

If this structure is not present, modes is considered to be DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR.

Valid Usage (Implicit)

See Also

VK_KHR_device_group, VK_KHR_swapchain, VK_VERSION_1_1, DeviceGroupPresentModeFlagsKHR, StructureType

Constructors

DeviceGroupSwapchainCreateInfoKHR

Fields

• modes :: DeviceGroupPresentModeFlagsKHR

  modes is a bitfield of modes that the swapchain can be used with.

  modes must be a valid combination of DeviceGroupPresentModeFlagBitsKHR values

  modes must not be 0

Instances

Eq DeviceGroupSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: DeviceGroupSwapchainCreateInfoKHR -> DeviceGroupSwapchainCreateInfoKHR -> Bool

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

Show DeviceGroupSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> DeviceGroupSwapchainCreateInfoKHR -> ShowS

show :: DeviceGroupSwapchainCreateInfoKHR -> String

showList :: [DeviceGroupSwapchainCreateInfoKHR] -> ShowS

Storable DeviceGroupSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: DeviceGroupSwapchainCreateInfoKHR -> Int

alignment :: DeviceGroupSwapchainCreateInfoKHR -> Int

peekElemOff :: Ptr DeviceGroupSwapchainCreateInfoKHR -> Int -> IO DeviceGroupSwapchainCreateInfoKHR

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

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

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

peek :: Ptr DeviceGroupSwapchainCreateInfoKHR -> IO DeviceGroupSwapchainCreateInfoKHR

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

FromCStruct DeviceGroupSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

peekCStruct :: Ptr DeviceGroupSwapchainCreateInfoKHR -> IO DeviceGroupSwapchainCreateInfoKHR

ToCStruct DeviceGroupSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

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

pokeCStruct :: Ptr DeviceGroupSwapchainCreateInfoKHR -> DeviceGroupSwapchainCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceGroupSwapchainCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceGroupSwapchainCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: DeviceGroupSwapchainCreateInfoKHR

getDeviceGroupPresentCapabilitiesKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device.

device must be a valid Device handle

-> io DeviceGroupPresentCapabilitiesKHR

vkGetDeviceGroupPresentCapabilitiesKHR - Query present capabilities from other physical devices

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_device_group, VK_KHR_surface, VK_KHR_swapchain, VK_VERSION_1_1, Device, DeviceGroupPresentCapabilitiesKHR

getDeviceGroupSurfacePresentModesKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device.

-> SurfaceKHR

surface is the surface.

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

vkGetDeviceGroupSurfacePresentModesKHR - Query present capabilities for a surface

Description

The modes returned by this command are not invariant, and may change in response to the surface being moved, resized, or occluded. These modes must be a subset of the modes returned by getDeviceGroupPresentCapabilitiesKHR.

Valid Usage

• surface must be supported by all physical devices associated with device, as reported by getPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

Valid Usage (Implicit)

• device must be a valid Device handle

• surface must be a valid SurfaceKHR handle
• pModes must be a valid pointer to a DeviceGroupPresentModeFlagsKHR value
• Both of device, and surface must have been created, allocated, or retrieved from the same Instance

Host Synchronization

• Host access to surface must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

VK_KHR_device_group, VK_KHR_surface, VK_KHR_swapchain, VK_VERSION_1_1, Device, DeviceGroupPresentModeFlagsKHR, SurfaceKHR

acquireNextImage2KHR

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

-> ("acquireInfo" ::: AcquireNextImageInfoKHR)

pAcquireInfo is a pointer to a AcquireNextImageInfoKHR structure containing parameters of the acquire.

-> io (Result, "imageIndex" ::: Word32)

vkAcquireNextImage2KHR - Retrieve the index of the next available presentable image

Valid Usage

• If the number of currently acquired images is greater than the difference between the number of images in the swapchain member of pAcquireInfo and the value of SurfaceCapabilitiesKHR::minImageCount as returned by a call to getPhysicalDeviceSurfaceCapabilities2KHR with the surface used to create swapchain, the timeout member of pAcquireInfo must not be UINT64_MAX

Valid Usage (Implicit)

• device must be a valid Device handle

• pAcquireInfo must be a valid pointer to a valid AcquireNextImageInfoKHR structure
• pImageIndex must be a valid pointer to a uint32_t value

Return Codes

Success

• SUCCESS
• TIMEOUT
• NOT_READY
• SUBOPTIMAL_KHR

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST
• ERROR_OUT_OF_DATE_KHR
• ERROR_SURFACE_LOST_KHR
• ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT

See Also

VK_KHR_device_group, VK_KHR_swapchain, VK_VERSION_1_1, AcquireNextImageInfoKHR, Device

acquireNextImage2KHRSafe

Arguments

:: forall io. MonadIO io

=> Device

device is the device associated with swapchain.

-> ("acquireInfo" ::: AcquireNextImageInfoKHR)

pAcquireInfo is a pointer to a AcquireNextImageInfoKHR structure containing parameters of the acquire.

-> io (Result, "imageIndex" ::: Word32)

A variant of acquireNextImage2KHR which makes a *safe* FFI call

getPhysicalDevicePresentRectanglesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the physical device.

-> SurfaceKHR

surface is the surface.

-> io (Result, "rects" ::: Vector Rect2D)

vkGetPhysicalDevicePresentRectanglesKHR - Query present rectangles for a surface on a physical device

Description

If pRects is NULL, then the number of rectangles used when presenting the given surface is returned in pRectCount. Otherwise, pRectCount must point to a variable set by the user to the number of elements in the pRects array, and on return the variable is overwritten with the number of structures actually written to pRects. If the value of pRectCount is less than the number of rectangles, at most pRectCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available rectangles were returned.

The values returned by this command are not invariant, and may change in response to the surface being moved, resized, or occluded.

The rectangles returned by this command must not overlap.

Valid Usage

• surface must be supported by physicalDevice, as reported by getPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• surface must be a valid SurfaceKHR handle
• pRectCount must be a valid pointer to a uint32_t value
• If the value referenced by pRectCount is not 0, and pRects is not NULL, pRects must be a valid pointer to an array of pRectCount Rect2D structures
• Both of physicalDevice, and surface must have been created, allocated, or retrieved from the same Instance

Host Synchronization

• Host access to surface must be externally synchronized

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_KHR_device_group, VK_KHR_surface, VK_KHR_swapchain, VK_VERSION_1_1, PhysicalDevice, Rect2D, SurfaceKHR

newtype DeviceGroupPresentModeFlagBitsKHR

VkDeviceGroupPresentModeFlagBitsKHR - Bitmask specifying supported device group present modes

See Also

VK_KHR_device_group, VK_KHR_surface, VK_KHR_swapchain, VK_VERSION_1_1, 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

newtype SwapchainCreateFlagBitsKHR

VkSwapchainCreateFlagBitsKHR - Bitmask controlling swapchain creation

See Also

VK_KHR_swapchain, SwapchainCreateFlagsKHR

Constructors

SwapchainCreateFlagBitsKHR Flags

Bundled Patterns

pattern SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR :: SwapchainCreateFlagBitsKHR

SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR specifies that the images of the swapchain can be used to create a ImageView with a different format than what the swapchain was created with. The list of allowed image view formats is specified by adding a ImageFormatListCreateInfo structure to the pNext chain of SwapchainCreateInfoKHR. In addition, this flag also specifies that the swapchain can be created with usage flags that are not supported for the format the swapchain is created with but are supported for at least one of the allowed image view formats.

pattern SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR :: SwapchainCreateFlagBitsKHR

SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR specifies that images created from the swapchain (i.e. with the swapchain member of ImageSwapchainCreateInfoKHR set to this swapchain’s handle) must use IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT.

pattern SWAPCHAIN_CREATE_PROTECTED_BIT_KHR :: SwapchainCreateFlagBitsKHR

SWAPCHAIN_CREATE_PROTECTED_BIT_KHR specifies that images created from the swapchain are protected images.

Instances

Eq SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool

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

Ord SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

compare :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Ordering

(<) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool

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

(>) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool

(>=) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool

max :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR

min :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR

Read SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

readsPrec :: Int -> ReadS SwapchainCreateFlagBitsKHR

readList :: ReadS [SwapchainCreateFlagBitsKHR]

readPrec :: ReadPrec SwapchainCreateFlagBitsKHR

readListPrec :: ReadPrec [SwapchainCreateFlagBitsKHR]

Show SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> SwapchainCreateFlagBitsKHR -> ShowS

show :: SwapchainCreateFlagBitsKHR -> String

showList :: [SwapchainCreateFlagBitsKHR] -> ShowS

Storable SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: SwapchainCreateFlagBitsKHR -> Int

alignment :: SwapchainCreateFlagBitsKHR -> Int

peekElemOff :: Ptr SwapchainCreateFlagBitsKHR -> Int -> IO SwapchainCreateFlagBitsKHR

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

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

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

peek :: Ptr SwapchainCreateFlagBitsKHR -> IO SwapchainCreateFlagBitsKHR

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

Bits SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(.&.) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR

(.|.) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR

xor :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR

complement :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR

shift :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

rotate :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

zeroBits :: SwapchainCreateFlagBitsKHR

bit :: Int -> SwapchainCreateFlagBitsKHR

setBit :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

clearBit :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

complementBit :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

testBit :: SwapchainCreateFlagBitsKHR -> Int -> Bool

bitSizeMaybe :: SwapchainCreateFlagBitsKHR -> Maybe Int

bitSize :: SwapchainCreateFlagBitsKHR -> Int

isSigned :: SwapchainCreateFlagBitsKHR -> Bool

shiftL :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

unsafeShiftL :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

shiftR :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

unsafeShiftR :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

rotateL :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

rotateR :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR

popCount :: SwapchainCreateFlagBitsKHR -> Int

FiniteBits SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

finiteBitSize :: SwapchainCreateFlagBitsKHR -> Int

countLeadingZeros :: SwapchainCreateFlagBitsKHR -> Int

countTrailingZeros :: SwapchainCreateFlagBitsKHR -> Int

Zero SwapchainCreateFlagBitsKHR

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: SwapchainCreateFlagBitsKHR

type SwapchainCreateFlagsKHR = SwapchainCreateFlagBitsKHR