From fd64a6095709e534d2b752c1038a1e3d07f2674c Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Tue, 21 Aug 2018 11:38:32 +0200 Subject: [PATCH] Added documentation of the whole "Record and replay" feature to Doxygen docs and README.md. --- README.md | 1 + docs/html/general_considerations.html | 2 +- docs/html/index.html | 1 + docs/html/record_and_replay.html | 97 ++++++++++ docs/html/search/all_b.js | 1 + docs/html/search/pages_7.js | 1 + docs/html/vk__mem__alloc_8h_source.html | 236 ++++++++++++------------ src/vk_mem_alloc.h | 49 ++++- 8 files changed, 268 insertions(+), 120 deletions(-) create mode 100644 docs/html/record_and_replay.html diff --git a/README.md b/README.md index 10be08b..6815d7a 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ Additional features: - JSON dump: Obtain a string in JSON format with detailed map of internal state, including list of allocations and gaps between them. - Convert this JSON dump into a picture to visualize your memory. See [tools/VmaDumpVis](tools/VmaDumpVis/README.md). - Debugging incorrect memory usage: Enable initialization of all allocated memory with a bit pattern to detect usage of uninitialized or freed memory. Enable validation of a magic number before and after every allocation to detect out-of-bounds memory corruption. +- Record and replay sequence of calls to library functions to a file to check correctness, measure performance, and gather statistics. # Prequisites diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html index 300ab1b..f631ac8 100644 --- a/docs/html/general_considerations.html +++ b/docs/html/general_considerations.html @@ -107,7 +107,7 @@ Allocation algorithm Features not supported

Features deliberately excluded from the scope of this library:

diff --git a/docs/html/index.html b/docs/html/index.html index e4dc71d..dc62c22 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -112,6 +112,7 @@ Table of contents
  • Corruption detection
    • +
  • Record and replay
  • Recommended usage patterns