Vulkan.Extensions.VK_EXT_surface_maintenance1

Name

VK_EXT_surface_maintenance1 - instance extension

VK_EXT_surface_maintenance1

Name String

VK_EXT_surface_maintenance1

Extension Type

Instance extension

Registered Extension Number

275

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_surface to be enabled
• Requires VK_KHR_get_surface_capabilities2 to be enabled

Contact

• Shahbaz Youssefi @syoussefi%0A*Here describe the issue or question you have about the VK_EXT_surface_maintenance1 extension*

Extension Proposal

VK_EXT_surface_maintenance1

Other Extension Metadata

Last Modified Date

2022-11-09

Contributors

• Jeff Juliano, NVIDIA
• Lionel Landwerlin, Intel
• Shahbaz Youssefi, Google
• Chris Forbes, Google
• Ian Elliott, Google
• Hans-Kristian Arntzen, Valve
• Daniel Stone, Collabora

Description

VK_EXT_surface_maintenance1 adds a collection of window system integration features that were intentionally left out or overlooked in the original VK_KHR_surface extension.

The new features are as follows:

• Allow querying number of min/max images from a surface for a particular presentation mode.
• Allow querying a surface’s scaled presentation capabilities.
• Allow querying a surface for the set of presentation modes which can be easily switched between without requiring swapchain recreation.

New Structures

• Extending PhysicalDeviceSurfaceInfo2KHR:

  • SurfacePresentModeEXT

• Extending SurfaceCapabilities2KHR:

  • SurfacePresentModeCompatibilityEXT
  • SurfacePresentScalingCapabilitiesEXT

New Enums

• PresentGravityFlagBitsEXT

• PresentScalingFlagBitsEXT

New Bitmasks

• PresentGravityFlagsEXT

• PresentScalingFlagsEXT

New Enum Constants

• EXT_SURFACE_MAINTENANCE_1_EXTENSION_NAME

• EXT_SURFACE_MAINTENANCE_1_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXT
  • STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT
  • STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_EXT

Version History

• Revision 0, 2019-02-27 (Lionel Landwerlin)

  • Internal revisions

• Revision 1, 2022-11-09 (Shahbaz Youssefi)

  • Add functionality and complete spec

See Also

PresentGravityFlagBitsEXT, PresentGravityFlagsEXT, PresentScalingFlagBitsEXT, PresentScalingFlagsEXT, SurfacePresentModeCompatibilityEXT, SurfacePresentModeEXT, SurfacePresentScalingCapabilitiesEXT

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

data SurfacePresentModeEXT

VkSurfacePresentModeEXT - Structure describing present mode of a surface

Description

If the SurfacePresentModeEXT structure is included in the pNext chain of PhysicalDeviceSurfaceInfo2KHR, the values returned in SurfaceCapabilitiesKHR::minImageCount, SurfaceCapabilitiesKHR::maxImageCount, SurfacePresentScalingCapabilitiesEXT::minScaledImageExtent, and SurfacePresentScalingCapabilitiesEXT::maxScaledImageExtent are valid only for the specified presentMode. If presentMode is PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, the per-present mode image counts must both be one. The per-present mode image counts may be less-than or greater-than the image counts returned when SurfacePresentModeEXT is not provided.

Note

If SwapchainPresentModesCreateInfoEXT is provided to swapchain creation, the requirements for forward progress may be less strict. For example, a FIFO swapchain might only require 2 images to guarantee forward progress, but a MAILBOX one might require 4. Without the per-present image counts, such an implementation would have to return 4 in SurfaceCapabilitiesKHR::minImageCount, which pessimizes FIFO. Conversely, an implementation may return a low number for minImageCount, but internally bump the image count when application queries getSwapchainImagesKHR, which can surprise applications, and is not discoverable until swapchain creation. Using SurfacePresentModeEXT and SwapchainPresentModesCreateInfoEXT together effectively removes this problem.

SwapchainPresentModesCreateInfoEXT is required for the specification to be backwards compatible with applications that do not know about, or make use of this feature.

Valid Usage (Implicit)

See Also

VK_EXT_surface_maintenance1, PresentModeKHR, StructureType

Constructors

SurfacePresentModeEXT

Fields

• presentMode :: PresentModeKHR

  presentMode is the presentation mode the swapchain will use.

  presentMode must be a value reported by getPhysicalDeviceSurfacePresentModesKHR for the specified surface.

  presentMode must be a valid PresentModeKHR value

Instances

Storable SurfacePresentModeEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

sizeOf :: SurfacePresentModeEXT -> Int

alignment :: SurfacePresentModeEXT -> Int

peekElemOff :: Ptr SurfacePresentModeEXT -> Int -> IO SurfacePresentModeEXT

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

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

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

peek :: Ptr SurfacePresentModeEXT -> IO SurfacePresentModeEXT

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

Show SurfacePresentModeEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

showsPrec :: Int -> SurfacePresentModeEXT -> ShowS

show :: SurfacePresentModeEXT -> String

showList :: [SurfacePresentModeEXT] -> ShowS

Eq SurfacePresentModeEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

(==) :: SurfacePresentModeEXT -> SurfacePresentModeEXT -> Bool

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

FromCStruct SurfacePresentModeEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

peekCStruct :: Ptr SurfacePresentModeEXT -> IO SurfacePresentModeEXT

ToCStruct SurfacePresentModeEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

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

pokeCStruct :: Ptr SurfacePresentModeEXT -> SurfacePresentModeEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SurfacePresentModeEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfacePresentModeEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

zero :: SurfacePresentModeEXT

data SurfacePresentScalingCapabilitiesEXT

VkSurfacePresentScalingCapabilitiesEXT - Structure describing the presentation scaling capabilities of the surface

Description

Before creating a swapchain whose scaling mode can be specified through the use of SwapchainPresentScalingCreateInfoEXT, obtain the set of supported scaling modes by including a SurfacePresentModeEXT structure in the pNext chain of PhysicalDeviceSurfaceInfo2KHR when calling getPhysicalDeviceSurfaceCapabilities2KHR. The implementation must return the same values in SurfacePresentScalingCapabilitiesEXT for any of the compatible present modes as obtained through SurfacePresentModeCompatibilityEXT.

Valid Usage (Implicit)

See Also

VK_EXT_surface_maintenance1, Extent2D, PresentGravityFlagsEXT, PresentScalingFlagsEXT, StructureType

Constructors

SurfacePresentScalingCapabilitiesEXT

Fields

• supportedPresentScaling :: PresentScalingFlagsEXT

  supportedPresentScaling is a bitmask of PresentScalingFlagBitsEXT representing the scaling methods supported by the surface, or 0 if application-defined scaling is not supported.

  supportedPresentScaling must be a valid combination of PresentScalingFlagBitsEXT values

• supportedPresentGravityX :: PresentGravityFlagsEXT

  supportedPresentGravityX is a bitmask of PresentGravityFlagBitsEXT representing the X-axis pixel gravity supported by the surface, or 0 if Vulkan-defined pixel gravity is not supported for the X axis.

  supportedPresentGravityX must be a valid combination of PresentGravityFlagBitsEXT values

• supportedPresentGravityY :: PresentGravityFlagsEXT

  supportedPresentGravityY is a bitmask of PresentGravityFlagBitsEXT representing the Y-axis pixel gravity supported by the surface, or 0 if Vulkan-defined pixel gravity is not supported for the Y axis.

  supportedPresentGravityY must be a valid combination of PresentGravityFlagBitsEXT values

• minScaledImageExtent :: Extent2D

  minScaledImageExtent contains the smallest valid swapchain extent for the surface on the specified device when one of the scaling methods specified in supportedPresentScaling is used, or the special value (0xFFFFFFFF, 0xFFFFFFFF) indicating that the surface size will be determined by the extent of a swapchain targeting the surface. The width and height of the extent will each be smaller than or equal to the corresponding width and height of SurfaceCapabilitiesKHR::minImageExtent.

• maxScaledImageExtent :: Extent2D

  maxScaledImageExtent contains the largest valid swapchain extent for the surface on the specified device when one of the scaling methods specified in supportedPresentScaling is used, or the special value described above for minScaledImageExtent. The width and height of the extent will each be greater than or equal to the corresponding width and height of SurfaceCapabilitiesKHR::maxImageExtent.

Instances

Storable SurfacePresentScalingCapabilitiesEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

sizeOf :: SurfacePresentScalingCapabilitiesEXT -> Int

alignment :: SurfacePresentScalingCapabilitiesEXT -> Int

peekElemOff :: Ptr SurfacePresentScalingCapabilitiesEXT -> Int -> IO SurfacePresentScalingCapabilitiesEXT

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

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

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

peek :: Ptr SurfacePresentScalingCapabilitiesEXT -> IO SurfacePresentScalingCapabilitiesEXT

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

Show SurfacePresentScalingCapabilitiesEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

showsPrec :: Int -> SurfacePresentScalingCapabilitiesEXT -> ShowS

show :: SurfacePresentScalingCapabilitiesEXT -> String

showList :: [SurfacePresentScalingCapabilitiesEXT] -> ShowS

FromCStruct SurfacePresentScalingCapabilitiesEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

peekCStruct :: Ptr SurfacePresentScalingCapabilitiesEXT -> IO SurfacePresentScalingCapabilitiesEXT

ToCStruct SurfacePresentScalingCapabilitiesEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

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

pokeCStruct :: Ptr SurfacePresentScalingCapabilitiesEXT -> SurfacePresentScalingCapabilitiesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SurfacePresentScalingCapabilitiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfacePresentScalingCapabilitiesEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

zero :: SurfacePresentScalingCapabilitiesEXT

data SurfacePresentModeCompatibilityEXT

VkSurfacePresentModeCompatibilityEXT - Structure describing the subset of compatible presentation modes for the purposes of switching without swapchain recreation

Description

If pPresentModes is NULL, then the number of present modes that are compatible with the one specified in SurfacePresentModeEXT is returned in presentModeCount. Otherwise, presentModeCount must be set by the user to the number of elements in the pPresentModes array, and on return the variable is overwritten with the number of values actually written to pPresentModes. If the value of presentModeCount is less than the number of compatible present modes that are supported, at most presentModeCount values will be written to pPresentModes. The implementation must include the present mode passed to SurfacePresentModeEXT in pPresentModes, unless presentModeCount is zero.

Before creating a swapchain whose present modes can be modified through the use of SwapchainPresentModesCreateInfoEXT, obtain the set of present modes compatible with a given initial present mode by including a SurfacePresentModeEXT structure in the pNext chain of PhysicalDeviceSurfaceInfo2KHR when calling getPhysicalDeviceSurfaceCapabilities2KHR.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXT

• If presentModeCount is not 0, and pPresentModes is not NULL, pPresentModes must be a valid pointer to an array of presentModeCount PresentModeKHR values

See Also

VK_EXT_surface_maintenance1, PresentModeKHR, StructureType

Constructors

SurfacePresentModeCompatibilityEXT

Fields

• presentModeCount :: Word32

  presentModeCount is an integer related to the number of present modes available or queried, as described below.

• presentModes :: Ptr PresentModeKHR

  pPresentModes is a pointer to an array of PresentModeKHR in which present modes compatible with a given present mode are returned.

Instances

Storable SurfacePresentModeCompatibilityEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

sizeOf :: SurfacePresentModeCompatibilityEXT -> Int

alignment :: SurfacePresentModeCompatibilityEXT -> Int

peekElemOff :: Ptr SurfacePresentModeCompatibilityEXT -> Int -> IO SurfacePresentModeCompatibilityEXT

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

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

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

peek :: Ptr SurfacePresentModeCompatibilityEXT -> IO SurfacePresentModeCompatibilityEXT

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

Show SurfacePresentModeCompatibilityEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

showsPrec :: Int -> SurfacePresentModeCompatibilityEXT -> ShowS

show :: SurfacePresentModeCompatibilityEXT -> String

showList :: [SurfacePresentModeCompatibilityEXT] -> ShowS

Eq SurfacePresentModeCompatibilityEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

(==) :: SurfacePresentModeCompatibilityEXT -> SurfacePresentModeCompatibilityEXT -> Bool

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

FromCStruct SurfacePresentModeCompatibilityEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

peekCStruct :: Ptr SurfacePresentModeCompatibilityEXT -> IO SurfacePresentModeCompatibilityEXT

ToCStruct SurfacePresentModeCompatibilityEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

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

pokeCStruct :: Ptr SurfacePresentModeCompatibilityEXT -> SurfacePresentModeCompatibilityEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SurfacePresentModeCompatibilityEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfacePresentModeCompatibilityEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

zero :: SurfacePresentModeCompatibilityEXT

type PresentScalingFlagsEXT = PresentScalingFlagBitsEXT

newtype PresentScalingFlagBitsEXT

VkPresentScalingFlagBitsEXT - Bitmask specifying presentation scaling methods

See Also

VK_EXT_surface_maintenance1, PresentScalingFlagsEXT

Constructors

PresentScalingFlagBitsEXT Flags

Bundled Patterns

pattern PRESENT_SCALING_ONE_TO_ONE_BIT_EXT :: PresentScalingFlagBitsEXT

PRESENT_SCALING_ONE_TO_ONE_BIT_EXT specifies that no scaling occurs, and pixels in the swapchain image are mapped to one and only one pixel in the surface. The mapping between pixels is defined by the chosen presentation gravity.

pattern PRESENT_SCALING_ASPECT_RATIO_STRETCH_BIT_EXT :: PresentScalingFlagBitsEXT

PRESENT_SCALING_ASPECT_RATIO_STRETCH_BIT_EXT specifies that the swapchain image will be minified or magnified such that at least one of the resulting width or height is equal to the corresponding surface dimension, and the other resulting dimension is less than or equal to the corresponding surface dimension, with the aspect ratio of the resulting image being identical to that of the original swapchain image.

pattern PRESENT_SCALING_STRETCH_BIT_EXT :: PresentScalingFlagBitsEXT

PRESENT_SCALING_STRETCH_BIT_EXT specifies that the swapchain image will be minified or magnified such that the resulting image dimensions are equal to those of the surface.

Instances

Storable PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

sizeOf :: PresentScalingFlagBitsEXT -> Int

alignment :: PresentScalingFlagBitsEXT -> Int

peekElemOff :: Ptr PresentScalingFlagBitsEXT -> Int -> IO PresentScalingFlagBitsEXT

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

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

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

peek :: Ptr PresentScalingFlagBitsEXT -> IO PresentScalingFlagBitsEXT

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

Bits PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

(.&.) :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT

(.|.) :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT

xor :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT

complement :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT

shift :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

rotate :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

zeroBits :: PresentScalingFlagBitsEXT

bit :: Int -> PresentScalingFlagBitsEXT

setBit :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

clearBit :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

complementBit :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

testBit :: PresentScalingFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: PresentScalingFlagBitsEXT -> Maybe Int

bitSize :: PresentScalingFlagBitsEXT -> Int

isSigned :: PresentScalingFlagBitsEXT -> Bool

shiftL :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

unsafeShiftL :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

shiftR :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

unsafeShiftR :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

rotateL :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

rotateR :: PresentScalingFlagBitsEXT -> Int -> PresentScalingFlagBitsEXT

popCount :: PresentScalingFlagBitsEXT -> Int

FiniteBits PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

finiteBitSize :: PresentScalingFlagBitsEXT -> Int

countLeadingZeros :: PresentScalingFlagBitsEXT -> Int

countTrailingZeros :: PresentScalingFlagBitsEXT -> Int

Read PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

readsPrec :: Int -> ReadS PresentScalingFlagBitsEXT

readList :: ReadS [PresentScalingFlagBitsEXT]

readPrec :: ReadPrec PresentScalingFlagBitsEXT

readListPrec :: ReadPrec [PresentScalingFlagBitsEXT]

Show PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

showsPrec :: Int -> PresentScalingFlagBitsEXT -> ShowS

show :: PresentScalingFlagBitsEXT -> String

showList :: [PresentScalingFlagBitsEXT] -> ShowS

Eq PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

(==) :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> Bool

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

Ord PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

compare :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> Ordering

(<) :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> Bool

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

(>) :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> Bool

(>=) :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> Bool

max :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT

min :: PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT -> PresentScalingFlagBitsEXT

Zero PresentScalingFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

zero :: PresentScalingFlagBitsEXT

type PresentGravityFlagsEXT = PresentGravityFlagBitsEXT

newtype PresentGravityFlagBitsEXT

VkPresentGravityFlagBitsEXT - Bitmask specifying presentation pixel gravity on either the x or y axis

Description

If the value in SurfaceCapabilitiesKHR::currentTransform is not SURFACE_TRANSFORM_IDENTITY_BIT_KHR, it is implementation-defined whether the gravity configuration applies to the presented image before or after transformation.

See Also

VK_EXT_surface_maintenance1, PresentGravityFlagsEXT

Constructors

PresentGravityFlagBitsEXT Flags

Bundled Patterns

pattern PRESENT_GRAVITY_MIN_BIT_EXT :: PresentGravityFlagBitsEXT

PRESENT_GRAVITY_MIN_BIT_EXT means that the pixels will gravitate towards the top or left side of the surface.

pattern PRESENT_GRAVITY_MAX_BIT_EXT :: PresentGravityFlagBitsEXT

PRESENT_GRAVITY_MAX_BIT_EXT means that the pixels will gravitate towards the bottom or right side of the surface.

pattern PRESENT_GRAVITY_CENTERED_BIT_EXT :: PresentGravityFlagBitsEXT

PRESENT_GRAVITY_CENTERED_BIT_EXT means that the pixels will be centered in the surface.

Instances

Storable PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

sizeOf :: PresentGravityFlagBitsEXT -> Int

alignment :: PresentGravityFlagBitsEXT -> Int

peekElemOff :: Ptr PresentGravityFlagBitsEXT -> Int -> IO PresentGravityFlagBitsEXT

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

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

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

peek :: Ptr PresentGravityFlagBitsEXT -> IO PresentGravityFlagBitsEXT

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

Bits PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

(.&.) :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT

(.|.) :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT

xor :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT

complement :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT

shift :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

rotate :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

zeroBits :: PresentGravityFlagBitsEXT

bit :: Int -> PresentGravityFlagBitsEXT

setBit :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

clearBit :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

complementBit :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

testBit :: PresentGravityFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: PresentGravityFlagBitsEXT -> Maybe Int

bitSize :: PresentGravityFlagBitsEXT -> Int

isSigned :: PresentGravityFlagBitsEXT -> Bool

shiftL :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

unsafeShiftL :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

shiftR :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

unsafeShiftR :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

rotateL :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

rotateR :: PresentGravityFlagBitsEXT -> Int -> PresentGravityFlagBitsEXT

popCount :: PresentGravityFlagBitsEXT -> Int

FiniteBits PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

finiteBitSize :: PresentGravityFlagBitsEXT -> Int

countLeadingZeros :: PresentGravityFlagBitsEXT -> Int

countTrailingZeros :: PresentGravityFlagBitsEXT -> Int

Read PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

readsPrec :: Int -> ReadS PresentGravityFlagBitsEXT

readList :: ReadS [PresentGravityFlagBitsEXT]

readPrec :: ReadPrec PresentGravityFlagBitsEXT

readListPrec :: ReadPrec [PresentGravityFlagBitsEXT]

Show PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

showsPrec :: Int -> PresentGravityFlagBitsEXT -> ShowS

show :: PresentGravityFlagBitsEXT -> String

showList :: [PresentGravityFlagBitsEXT] -> ShowS

Eq PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

(==) :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> Bool

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

Ord PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

compare :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> Ordering

(<) :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> Bool

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

(>) :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> Bool

(>=) :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> Bool

max :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT

min :: PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT -> PresentGravityFlagBitsEXT

Zero PresentGravityFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_surface_maintenance1

Methods

zero :: PresentGravityFlagBitsEXT

type EXT_SURFACE_MAINTENANCE_1_SPEC_VERSION = 1

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

type EXT_SURFACE_MAINTENANCE_1_EXTENSION_NAME = "VK_EXT_surface_maintenance1"

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

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

VK_KHR_surface, SurfacePresentModeCompatibilityEXT, SurfacePresentModeEXT, SwapchainCreateInfoKHR, SwapchainPresentModeInfoEXT, SwapchainPresentModesCreateInfoEXT, 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

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

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

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

Zero PresentModeKHR

Defined in Vulkan.Extensions.VK_KHR_surface

Methods

zero :: PresentModeKHR