vk::mem

Host-only region placement over an integer byte range.

Allocate separate native storage with automatically admitted allocation flags.

Allocate separate native storage with an optional borrowed allocation chain. Equivalent to allocate_with_options with dedicated_memory enabled.

Allocate for a caller-created unbound ordinary buffer without creating, binding or destroying it.

Allocate for a caller-created unbound ordinary image; no creation, binding or destruction.

Allocate identical ordinary requirement pages; failure releases new pages only.

Allocate unbound ordinary storage from native requirements with explicit policy.

One live native region. No implicit free, unmap, submission or wait in Drop.

Snapshot one live allocation’s binding, actual properties and current mapping.

Borrow an allocation’s diagnostic name; no native lifetime is acquired.

Placement metadata for custom pools and host-only virtual blocks.

A caller-owned VkMemoryAllocateInfo::pNext chain.

Managed-resource policy, including optional borrowed native allocation storage; this Rust record is not part of the Vulkan ABI.

Checked binding and mapping snapshot of one live allocation.

Managed resource storage policy. Required or preferred native dedication takes precedence.

Borrows one device; native memory is released only by explicit operations.

Observe captured native identities without inferring manually omitted parent metadata.

Captured native identities. Manual metadata constructors do not invent parent identities.

Local accounting snapshot; excludes allocations made by other allocators/raw calls.

Reserve earlier free storage without creating native resources, growing blocks or copying data.

Plan a pass with a borrowed cooperative stop predicate, following VMA’s pfnBreakCallback / CheckCounters contract. Returning true stops scheduling; already proposed moves still need explicit resolution. Use was_interrupted to distinguish a stop from an exhausted search. Polls occur between source candidates, after host snapshot/preflight, and never during consumer copies. A panic rolls back unpublished destinations before unwinding (with panic=unwind). The callback is used only during this call and cannot borrow this allocator.

Bind at the allocation’s actual native offset. Failed binds retain allocation and resource for retry.

Bind one ordinary buffer with a checked allocation-local offset and borrowed native chain.

Bind a live ordinary image at its allocation’s native offset; failure retains both objects.

Bind an ordinary image or one disjoint plane with an allocation-local offset and native chain. A plane uses unassociated raw storage allocated from caller-queried plane requirements. The allocator re-queries that exact plane before binding and tracks each plane independently; DRM modifier plane aspects remain excluded.

Local accounting is always distinguished from implementation-reported usage.

Budget provenance. Heap-size/local accounting does not measure external pressure.

One allocation-relative cache range. Each allocation must own a mapping hold.

Check enabled coherent pooled guard tails without waiting for GPU work.

Check coherent guard tails belonging to one checked custom pool.

Checked shutdown after all regions and their blocks have been explicitly released.

Invalidate and copy allocation bytes to initialized writable host storage.

Copy host bytes to an allocation, flush them and release only this helper’s map hold.

Create an ordinary alias buffer at a checked allocation-local offset.

Create a caller-owned ordinary alias image without allocating new native memory.

Transactionally create, query, allocate and bind an ordinary buffer.

Create, allocate, optionally map and bind an ordinary buffer transactionally.

Create, separately allocate and bind a buffer, optionally importing/exporting memory.

Create, separately allocate and bind an ordinary non-disjoint image with an optional chain.

Create an ordinary image with separate storage and explicit memory properties.

Create, query, allocate, optionally map and bind a non-disjoint image transactionally.

Create a fixed-memory-type TLSF pool transactionally.

Create a pool retaining a borrowed native allocation chain for every block. Import chains are rejected: a single imported payload cannot back repeated growth.

Opt-in host-visible debug instrumentation, configured before native acquisition. Guard margins follow VMA’s coherent pooled-memory policy. Zero disables guards.

Existing-block relocation policy, derived from the pinned VMA algorithms.

Persistent multi-pass relocation state with one exclusive allocator borrow. Ignored allocations stay immovable for subsequent passes in this context. Each pass must be explicitly resolved and finished; neither context nor pass Drop submits, waits or destroys native resources. An abandoned unresolved pass leaks its reservations, as documented by DefragmentationPass.

Bounded relocation planning. Zero limits produce an empty pass.

Borrow-free binding snapshots. They do not retain resources or mappings. Mapped pointers describe counted holds owned by the pass’s live regions. Source pointers expire on commit/destroy, destination pointers on ignore/destroy; copied snapshots extend no lifetime.

Exclusively borrows the allocator while replacement resources are prepared.

Allocator-recorded primary resource, or raw storage, associated with a move.

Actual completed work; proposed or ignored moves are not counted as moved bytes.

Destroy a matching resource pair in buffer-before-memory order with matching retained callbacks.

Destroy the exact image/token pair with matching retained callbacks before freeing memory.

Destroy an empty pool, releasing its retained native blocks explicitly.

Walk actual blocks/live regions belonging to one checked custom pool.

Walk actual native blocks and live regions to build detailed local statistics.

Detailed local byte/count statistics. Empty populations have None extrema.

Informative notifications for actual native memory allocation/free effects. Callbacks do not allocate Rust metadata and do not own the native memory.

Observe the export flags retained for this allocation’s entire native block.

Select from explicit native memory-type bits without allocating or querying a budget.

Select memory for an ordinary buffer using its actual creation usage and requirements.

Select memory for an ordinary non-disjoint image from creation usage and native requirements.

Flush a bounded allocation-relative mapped range, observing atom/end rules.

Flush checked ranges in one native call; coherent/empty ranges remain checked no-ops.

Release a separate allocation or pooled placement and invalidate its token.

Validate an entire release batch before freeing any allocation.

Export a new caller-owned file descriptor for the complete backing memory. Allocation offsets still apply. Close the returned descriptor using the OS; neither token nor allocator owns it. No GPU synchronization occurs.

Return an owned cached budget, refreshed on frame changes or after 30 region operations.

One heap at the explicit snapshot boundary. Budget/usage can change immediately.

CPU access intent used by automatic memory selection; never submits a transfer.

Actual external backing extent and compatible types for one import.

Resource-specific native dedication for an imported payload. The resource remains caller-owned; this record never destroys it.

Invalidate a bounded allocation-relative mapped range; never waits for the GPU.

Invalidate checked ranges in one native call; never waits for device writes.

Map one allocation. Distinct regions share a reference-counted block mapping. Repeated explicit maps acquire checked holds on the same native mapping.

Return a region pointer only if that region has an explicit or persistent hold. Does not map, acquire a hold, synchronize, or authorize pointer dereferences.

Borrow validated native memory metadata used by this allocator’s selection policy.

Observe one checked native memory type’s actual property flags.

Finite native memory priority in the inclusive range 0..=1.

Explicit diagnostic snapshot, indexed by native memory type and heap.

Validated device memory properties and non-coherent atom size.

Policy for managed resources. Raw allocation always uses explicit flags.

Borrow queried physical-device properties, or None after manual metadata construction.

Identity of one live custom pool. Dropping it never destroys native storage.

Borrow a custom pool’s copied diagnostic name without native effects.

Query a pool’s local native bytes, placements and free ranges.

Fixed-type ordinary-memory pool; not a Vulkan ABI record.

Local pool statistics. No native budget query or host allocation is performed. Free spans describe physical holes; alignment/granularity may prevent their use. Linear holes additionally wait for their stack/ring lifetime to retire. Counts/bytes include pool-owned dedicated allocations and retained empty blocks.

Return an explicit native budget snapshot without caching admission decisions.

Refresh an allocator-owned budget snapshot from the retained native context.

Capture a checked budget context for future refreshes, including manual constructors.

Replace a copied UTF-8 diagnostic name transactionally; None clears it.

Explicitly pin/unpin a region against future allocator relocation planning.

Set uninterpreted consumer metadata. It is never dereferenced, freed or owned.

Mark a frame boundary for budget refresh; this never retires resources or waits.

Configure debug instrumentation before native allocations or pools exist.

Configure copied per-memory-type external export flags before creating pools/storage. Zero flags leave that type ordinary. Every native allocation of a configured type receives VkExportMemoryAllocateInfo, including separate allocations.

Change a local policy ceiling; this never reserves native heap capacity.

Configure native pooled mapping retention before creating storage or pools. Enabled by default. Separate allocations never cache mappings. This affects native map/unmap call counts, never allocation-level pointer access rights.

Replace a pool diagnostic name; metadata allocation failure preserves its old name.

Set preferred block bytes for heaps larger than 1 GiB before pool/storage creation. Small heaps use one eighth of their heap size; both paths round up to 32 bytes. Does not alter explicit Pooled/Adaptive policies or query/reserve a budget.

Calculate local live-region/native-block accounting without querying the driver.

One allocator with synchronized direct operations and concurrent pool scopes.

One virtual block with serialized operation access from any host thread.

Release surplus empty, unmapped cached blocks, preserving each pool minimum.

Query an explicit budget snapshot, then trim surplus empty blocks on pressured heaps.

Native cache released by one explicit maintenance call. Live regions never move.

Release one explicit map; persistent holds and other regions remain mapped.

Write ordered local allocator diagnostics as vk.memory.statistics.v1 JSON.