Vulkan.Extensions.VK_KHR_maintenance4

Name

VK_KHR_maintenance4 - device extension

VK_KHR_maintenance4

Name String

VK_KHR_maintenance4

Extension Type

Device extension

Registered Extension Number

414

Revision

2

Extension and Version Dependencies

• Requires Vulkan 1.1

Contact

• Piers Daniell @pdaniell-nv%0A<<Here describe the issue or question you have about the VK_KHR_maintenance4 extension> >

Other Extension Metadata

Last Modified Date

2021-10-25

Interactions and External Dependencies

• Requires SPIR-V 1.2 for LocalSizeId

Contributors

• Lionel Duc, NVIDIA
• Jason Ekstrand, Intel
• Spencer Fricke, Samsung
• Tobias Hector, AMD
• Lionel Landwerlin, Intel
• Graeme Leese, Broadcom
• Tom Olson, Arm
• Stu Smith, AMD
• Yiwei Zhang, Google

Description

VK_KHR_maintenance4 adds a collection of minor features, none of which would warrant an entire extension of their own.

The new features are as follows:

• Allow the application to destroy their PipelineLayout object immediately after it was used to create another object. It is no longer necessary to keep its handle valid while the created object is in use.
• Add a new maxBufferSize implementation-defined limit for the maximum size Buffer that can be created.
• Add support for the SPIR-V 1.2 LocalSizeId execution mode, which can be used as an alternative to LocalSize to specify the local workgroup size with specialization constants.
• Add a guarantee that images created with identical creation parameters will always have the same alignment requirements.
• Add new getDeviceBufferMemoryRequirementsKHR, getDeviceImageMemoryRequirementsKHR, and getDeviceImageSparseMemoryRequirementsKHR to allow the application to query the image memory requirements without having to create an image object and query it.
• Relax the requirement that push constants must be initialized before they are dynamically accessed.
• Relax the interface matching rules to allow a larger output vector to match with a smaller input vector, with additional values being discarded.
• Add a guarantee for buffer memory requirement that the size memory requirement is never greater than the result of aligning create size with the alignment memory requirement.

New Commands

• getDeviceBufferMemoryRequirementsKHR

• getDeviceImageMemoryRequirementsKHR
• getDeviceImageSparseMemoryRequirementsKHR

New Structures

• DeviceBufferMemoryRequirementsKHR

• DeviceImageMemoryRequirementsKHR

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceMaintenance4FeaturesKHR

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceMaintenance4PropertiesKHR

New Enum Constants

• KHR_MAINTENANCE_4_EXTENSION_NAME

• KHR_MAINTENANCE_4_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_BUFFER_MEMORY_REQUIREMENTS_KHR
  • STRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTS_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_4_FEATURES_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_4_PROPERTIES_KHR

Issues

None.

Version History

• Revision 1, 2021-08-18 (Piers Daniell)

  • Internal revisions

• Revision 2, 2021-10-25 (Yiwei Zhang)

  • More guarantees on buffer memory requirements

See Also

DeviceBufferMemoryRequirementsKHR, DeviceImageMemoryRequirementsKHR, PhysicalDeviceMaintenance4FeaturesKHR, PhysicalDeviceMaintenance4PropertiesKHR, getDeviceBufferMemoryRequirementsKHR, getDeviceImageMemoryRequirementsKHR, getDeviceImageSparseMemoryRequirementsKHR

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

getDeviceBufferMemoryRequirementsKHR

Arguments

:: forall a io. (Extendss MemoryRequirements2 a, PokeChain a, PeekChain a, MonadIO io)

=> Device

device is the logical device intended to own the buffer.

device must be a valid Device handle

-> ("info" ::: DeviceBufferMemoryRequirementsKHR)

pInfo is a pointer to a DeviceBufferMemoryRequirementsKHR structure containing parameters required for the memory requirements query.

pInfo must be a valid pointer to a valid DeviceBufferMemoryRequirementsKHR structure

-> io (MemoryRequirements2 a)

vkGetDeviceBufferMemoryRequirementsKHR - Returns the memory requirements for specified Vulkan object

Valid Usage (Implicit)

See Also

VK_KHR_maintenance4, Device, DeviceBufferMemoryRequirementsKHR, MemoryRequirements2

getDeviceImageMemoryRequirementsKHR

Arguments

:: forall a io. (Extendss MemoryRequirements2 a, PokeChain a, PeekChain a, MonadIO io)

=> Device

device is the logical device intended to own the image.

device must be a valid Device handle

-> ("info" ::: DeviceImageMemoryRequirementsKHR)

pInfo is a pointer to a DeviceImageMemoryRequirementsKHR structure containing parameters required for the memory requirements query.

pInfo must be a valid pointer to a valid DeviceImageMemoryRequirementsKHR structure

-> io (MemoryRequirements2 a)

vkGetDeviceImageMemoryRequirementsKHR - Returns the memory requirements for specified Vulkan object

Valid Usage (Implicit)

See Also

VK_KHR_maintenance4, Device, DeviceImageMemoryRequirementsKHR, MemoryRequirements2

getDeviceImageSparseMemoryRequirementsKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device intended to own the image.

-> ("info" ::: DeviceImageMemoryRequirementsKHR)

pInfo is a pointer to a DeviceImageMemoryRequirementsKHR structure containing parameters required for the memory requirements query.

-> io ("sparseMemoryRequirements" ::: Vector SparseImageMemoryRequirements2)

vkGetDeviceImageSparseMemoryRequirementsKHR - Query the memory requirements for a sparse image

Valid Usage (Implicit)

• device must be a valid Device handle

• pInfo must be a valid pointer to a valid DeviceImageMemoryRequirementsKHR structure
• pSparseMemoryRequirementCount must be a valid pointer to a uint32_t value
• If the value referenced by pSparseMemoryRequirementCount is not 0, and pSparseMemoryRequirements is not NULL, pSparseMemoryRequirements must be a valid pointer to an array of pSparseMemoryRequirementCount SparseImageMemoryRequirements2 structures

See Also

VK_KHR_maintenance4, Device, DeviceImageMemoryRequirementsKHR, SparseImageMemoryRequirements2

data DeviceBufferMemoryRequirementsKHR

VkDeviceBufferMemoryRequirementsKHR - (None)

Valid Usage (Implicit)

See Also

VK_KHR_maintenance4, BufferCreateInfo, StructureType, getDeviceBufferMemoryRequirementsKHR

Constructors

DeviceBufferMemoryRequirementsKHR

Fields

• createInfo :: SomeStruct BufferCreateInfo

  pCreateInfo is a pointer to a BufferCreateInfo structure containing parameters affecting creation of the buffer to query.

  pCreateInfo must be a valid pointer to a valid BufferCreateInfo structure

Instances

Show DeviceBufferMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

showsPrec :: Int -> DeviceBufferMemoryRequirementsKHR -> ShowS

show :: DeviceBufferMemoryRequirementsKHR -> String

showList :: [DeviceBufferMemoryRequirementsKHR] -> ShowS

FromCStruct DeviceBufferMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

peekCStruct :: Ptr DeviceBufferMemoryRequirementsKHR -> IO DeviceBufferMemoryRequirementsKHR

ToCStruct DeviceBufferMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

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

pokeCStruct :: Ptr DeviceBufferMemoryRequirementsKHR -> DeviceBufferMemoryRequirementsKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceBufferMemoryRequirementsKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceBufferMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

zero :: DeviceBufferMemoryRequirementsKHR

data DeviceImageMemoryRequirementsKHR

VkDeviceImageMemoryRequirementsKHR - (None)

Valid Usage

• The pCreateInfo::pNext chain must not contain a ImageSwapchainCreateInfoKHR structure

• If pCreateInfo::flags has IMAGE_CREATE_DISJOINT_BIT set then planAspect must not be zero
• If pCreateInfo::flags has IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT set then planAspect must not be zero
• If pCreateInfo::flags has IMAGE_CREATE_DISJOINT_BIT set and if the pCreateInfo::tiling is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, then planeAspect must be a single valid format plane for the image (that is, for a two-plane image planeAspect must be IMAGE_ASPECT_PLANE_0_BIT or IMAGE_ASPECT_PLANE_1_BIT, and for a three-plane image planeAspect must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or IMAGE_ASPECT_PLANE_2_BIT)
• If pCreateInfo::flags has IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT set and the pCreateInfo::tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then planeAspect must be a single valid memory plane for the image (that is, aspectMask must specify a plane index that is less than the DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and ImageDrmFormatModifierPropertiesEXT::drmFormatModifier)

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTS_KHR

• pNext must be NULL
• pCreateInfo must be a valid pointer to a valid ImageCreateInfo structure
• planeAspect must be a valid ImageAspectFlagBits value

See Also

VK_KHR_maintenance4, ImageAspectFlagBits, ImageCreateInfo, StructureType, getDeviceImageMemoryRequirementsKHR, getDeviceImageSparseMemoryRequirementsKHR

Constructors

DeviceImageMemoryRequirementsKHR

Fields

• createInfo :: SomeStruct ImageCreateInfo

  pCreateInfo is a pointer to a ImageCreateInfo structure containing parameters affecting creation of the image to query.

• planeAspect :: ImageAspectFlagBits

  planeAspect is a ImageAspectFlagBits value specifying the aspect corresponding to the image plane to query. This parameter is ignored unless pCreateInfo::flags has IMAGE_CREATE_DISJOINT_BIT or IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT set.

Instances

Show DeviceImageMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

showsPrec :: Int -> DeviceImageMemoryRequirementsKHR -> ShowS

show :: DeviceImageMemoryRequirementsKHR -> String

showList :: [DeviceImageMemoryRequirementsKHR] -> ShowS

FromCStruct DeviceImageMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

peekCStruct :: Ptr DeviceImageMemoryRequirementsKHR -> IO DeviceImageMemoryRequirementsKHR

ToCStruct DeviceImageMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

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

pokeCStruct :: Ptr DeviceImageMemoryRequirementsKHR -> DeviceImageMemoryRequirementsKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceImageMemoryRequirementsKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceImageMemoryRequirementsKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

zero :: DeviceImageMemoryRequirementsKHR

data PhysicalDeviceMaintenance4FeaturesKHR

VkPhysicalDeviceMaintenance4FeaturesKHR - Structure describing whether the implementation supports maintenance4 functionality

Members

This structure describes the following features:

Description

If the PhysicalDeviceMaintenance4FeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceMaintenance4FeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance4, Bool32, StructureType

Constructors

PhysicalDeviceMaintenance4FeaturesKHR

Fields

• maintenance4 :: Bool

  maintenance4 indicates that the implementation supports the following:

  • The application may destroy a PipelineLayout object immediately after using it to create another object.
  • LocalSizeId can be used as an alternative to LocalSize to specify the local workgroup size with specialization constants.
  • Images created with identical creation parameters will always have the same alignment requirements.
  • The size memory requirement of a buffer or image is never greater than that of another buffer or image created with a greater or equal size.
  • Push constants do not have to be initialized before they are dynamically accessed.
  • The interface matching rules allow a larger output vector to match with a smaller input vector, with additional values being discarded.

Instances

Eq PhysicalDeviceMaintenance4FeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

(==) :: PhysicalDeviceMaintenance4FeaturesKHR -> PhysicalDeviceMaintenance4FeaturesKHR -> Bool

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

Show PhysicalDeviceMaintenance4FeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

showsPrec :: Int -> PhysicalDeviceMaintenance4FeaturesKHR -> ShowS

show :: PhysicalDeviceMaintenance4FeaturesKHR -> String

showList :: [PhysicalDeviceMaintenance4FeaturesKHR] -> ShowS

Storable PhysicalDeviceMaintenance4FeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

sizeOf :: PhysicalDeviceMaintenance4FeaturesKHR -> Int

alignment :: PhysicalDeviceMaintenance4FeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceMaintenance4FeaturesKHR -> Int -> IO PhysicalDeviceMaintenance4FeaturesKHR

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

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

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

peek :: Ptr PhysicalDeviceMaintenance4FeaturesKHR -> IO PhysicalDeviceMaintenance4FeaturesKHR

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

FromCStruct PhysicalDeviceMaintenance4FeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

peekCStruct :: Ptr PhysicalDeviceMaintenance4FeaturesKHR -> IO PhysicalDeviceMaintenance4FeaturesKHR

ToCStruct PhysicalDeviceMaintenance4FeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

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

pokeCStruct :: Ptr PhysicalDeviceMaintenance4FeaturesKHR -> PhysicalDeviceMaintenance4FeaturesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceMaintenance4FeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMaintenance4FeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

zero :: PhysicalDeviceMaintenance4FeaturesKHR

data PhysicalDeviceMaintenance4PropertiesKHR

VkPhysicalDeviceMaintenance4PropertiesKHR - Structure describing various implementation-defined properties introduced with VK_KHR_maintenance4

Description

If the PhysicalDeviceMaintenance4PropertiesKHR structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance4, DeviceSize, StructureType

Constructors

PhysicalDeviceMaintenance4PropertiesKHR

Fields

• maxBufferSize :: DeviceSize

  maxBufferSize is the maximum size Buffer that can be created.

Instances

Eq PhysicalDeviceMaintenance4PropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

(==) :: PhysicalDeviceMaintenance4PropertiesKHR -> PhysicalDeviceMaintenance4PropertiesKHR -> Bool

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

Show PhysicalDeviceMaintenance4PropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

showsPrec :: Int -> PhysicalDeviceMaintenance4PropertiesKHR -> ShowS

show :: PhysicalDeviceMaintenance4PropertiesKHR -> String

showList :: [PhysicalDeviceMaintenance4PropertiesKHR] -> ShowS

Storable PhysicalDeviceMaintenance4PropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

sizeOf :: PhysicalDeviceMaintenance4PropertiesKHR -> Int

alignment :: PhysicalDeviceMaintenance4PropertiesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceMaintenance4PropertiesKHR -> Int -> IO PhysicalDeviceMaintenance4PropertiesKHR

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

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

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

peek :: Ptr PhysicalDeviceMaintenance4PropertiesKHR -> IO PhysicalDeviceMaintenance4PropertiesKHR

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

FromCStruct PhysicalDeviceMaintenance4PropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

peekCStruct :: Ptr PhysicalDeviceMaintenance4PropertiesKHR -> IO PhysicalDeviceMaintenance4PropertiesKHR

ToCStruct PhysicalDeviceMaintenance4PropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

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

pokeCStruct :: Ptr PhysicalDeviceMaintenance4PropertiesKHR -> PhysicalDeviceMaintenance4PropertiesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceMaintenance4PropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMaintenance4PropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_maintenance4

Methods

zero :: PhysicalDeviceMaintenance4PropertiesKHR

type KHR_MAINTENANCE_4_SPEC_VERSION = 2

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

type KHR_MAINTENANCE_4_EXTENSION_NAME = "VK_KHR_maintenance4"

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