Vulkan Memory Allocator

Version 2.4.0-development (2020-03-02)

Copyright (c) 2017-2020 Advanced Micro Devices, Inc. All rights reserved.
License: MIT

Documentation of all members: vk_mem_alloc.h

Table of contents

• User guide
  • Quick start
    • Project setup
    • Initialization
    • Resource allocation
  • Choosing memory type
    • Usage
    • Required and preferred flags
    • Explicit memory types
    • Custom memory pools
    • Dedicated allocations
  • Memory mapping
    • Mapping functions
    • Persistently mapped memory
    • Cache flush and invalidate
    • Finding out if memory is mappable
  • Staying within budget
    • Querying for budget
    • Controlling memory usage
  • Custom memory pools
    • Choosing memory type index
    • Linear allocation algorithm
      • Free-at-once
      • Stack
      • Double stack
      • Ring buffer
    • Buddy allocation algorithm
  • Defragmentation
    • Defragmenting CPU memory
    • Defragmenting GPU memory
    • Additional notes
    • Writing custom allocation algorithm
  • Lost allocations
  • Statistics
    • Numeric statistics
    • JSON dump
  • Allocation names and user data
    • Allocation user data
    • Allocation names
  • Debugging incorrect memory usage
    • Memory initialization
    • Margins
    • Corruption detection
  • Record and replay
• Recommended usage patterns
  • Common mistakes
  • Simple patterns
  • Advanced patterns
• Configuration
  • Pointers to Vulkan functions
  • Custom host memory allocator
  • Device memory allocation callbacks
  • Device heap memory limit
  • VK_KHR_dedicated_allocation
  • Enabling buffer device address
  • VK_AMD_device_coherent_memory
• General considerations
  • Thread safety
  • Validation layer warnings
  • Allocation algorithm
  • Features not supported

See also

• Product page on GPUOpen
• Source repository on GitHub