Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_zero_initialize_device_memory

Description

Name

VK_EXT_zero_initialize_device_memory - device extension

VK_EXT_zero_initialize_device_memory

Name String: VK_EXT_zero_initialize_device_memory

Extension Type

Device extension

Registered Extension Number

621

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Vulkan Version 1.1

Contact

Mike Blumenkrantz @zmike%0A*Here describe the issue or question you have about the VK_EXT_zero_initialize_device_memory extension*

Extension Proposal

VK_EXT_zero_initialize_device_memory

Other Extension Metadata

Last Modified Date: 2025-04-09

Interactions and External Dependencies

Interacts with Vulkan 1.1.
Interacts with VK_KHR_get_physical_device_properties2.

IP Status

No known IP claims.

Contributors

Hans-Kristian Arntzen, VALVE
Mike Blumenkrantz, VALVE
Tobias Hector, AMD
Faith Ekstrand, Collabora
Ricardo Garcia, Igalia
Jan-Harald Fredriksen, ARM
Spencer Fricke, LunarG

Description

By default, Vulkan provides no guarantees that device memory allocated through vkAllocateMemory is cleared to zero. This means that applications wanting resources to be zero-initialized must execute a command such as vkCmdFillBuffer or vkCmdClearColorImage on the device to ensure a deterministic result. This can be wasteful if the underlying platform either:

Already performs that zero clear anyway, due to e.g. security concerns.
Can be performed more efficiently in implementation, by e.g. clearing pages to zero in the background after device memory is freed.

This extension also has uses in API layering and porting efforts, where zero memory behavior may be more strict than Vulkan. Different OS platforms also have wildly different behaviors here, which leads to implementations needing to apply workarounds to paper over these issues in the wild. If an extension exists to make allocation behavior explicit, we hopefully achieve a more robust ecosystem for Vulkan.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT

New Enum Constants

EXT_ZERO_INITIALIZE_DEVICE_MEMORY_EXTENSION_NAME

EXT_ZERO_INITIALIZE_DEVICE_MEMORY_SPEC_VERSION
Extending ImageLayout:
- IMAGE_LAYOUT_ZERO_INITIALIZED_EXT
Extending MemoryAllocateFlagBits:
- MEMORY_ALLOCATE_ZERO_INITIALIZE_BIT_EXT
Extending StructureType:
- STRUCTURE_TYPE_PHYSICAL_DEVICE_ZERO_INITIALIZE_DEVICE_MEMORY_FEATURES_EXT

Version History

Revision 1, 2025-03-10 (Mike Blumenkrantz)
- Initial version

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.

Synopsis

data PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT = PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT {
- zeroInitializeDeviceMemory :: Bool
}
type EXT_ZERO_INITIALIZE_DEVICE_MEMORY_SPEC_VERSION = 1
pattern EXT_ZERO_INITIALIZE_DEVICE_MEMORY_SPEC_VERSION :: Integral a => a
type EXT_ZERO_INITIALIZE_DEVICE_MEMORY_EXTENSION_NAME = "VK_EXT_zero_initialize_device_memory"
pattern EXT_ZERO_INITIALIZE_DEVICE_MEMORY_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

data PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #

VkPhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT - Structure describing whether the implementation supports cleared allocation functionality

Members

This structure describes the following features:

Description

If the PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT 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. If the application wishes to use a Device with any features described by PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

Eq PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_zero_initialize_device_memory Methods (==) :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> Bool # (/=) :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> Bool #
Storable PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_zero_initialize_device_memory Methods sizeOf :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> Int # alignment :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> Int -> IO PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT # pokeElemOff :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> Int -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO () # peek :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT # poke :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO () #
Show PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_zero_initialize_device_memory Methods showsPrec :: Int -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> ShowS # show :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> String # showList :: [PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT] -> ShowS #
FromCStruct PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_zero_initialize_device_memory Methods peekCStruct :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
ToCStruct PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_zero_initialize_device_memory Methods withCStruct :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> (Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_zero_initialize_device_memory Methods zero :: PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT Source #

type EXT_ZERO_INITIALIZE_DEVICE_MEMORY_SPEC_VERSION = 1 Source #

pattern EXT_ZERO_INITIALIZE_DEVICE_MEMORY_SPEC_VERSION :: Integral a => a Source #

type EXT_ZERO_INITIALIZE_DEVICE_MEMORY_EXTENSION_NAME = "VK_EXT_zero_initialize_device_memory" Source #

pattern EXT_ZERO_INITIALIZE_DEVICE_MEMORY_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

Name

VK_EXT_zero_initialize_device_memory

Other Extension Metadata

Description

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Members

Description

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceZeroInitializeDeviceMemoryFeaturesEXT
Fields zeroInitializeDeviceMemory :: Bool `zeroInitializeDeviceMemory` indicates that the implementation supports zeroing memory allocations using a user-specified flag.