From 635045cb5dbcf71fd0fa00d42277c3656470853f Mon Sep 17 00:00:00 2001 From: jatin Date: Sun, 20 Oct 2024 19:33:45 -0700 Subject: [PATCH] Clarify: if final reserve() call returns false, then no scratch memory --- include/clap/ext/draft/scratch-memory.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/clap/ext/draft/scratch-memory.h b/include/clap/ext/draft/scratch-memory.h index b98d6bde..cc2764c0 100644 --- a/include/clap/ext/draft/scratch-memory.h +++ b/include/clap/ext/draft/scratch-memory.h @@ -38,9 +38,11 @@ typedef struct clap_host_scratch_memory { // being asked for until the host returns true), however, // the plugin should avoid calling this method un-neccesarily // since the host implementation may be relatively expensive. - // If the plugin calls this method multiple times, then the + // If the plugin calls `reserve()` multiple times, then the // final call determines the actual amount of scratch memory - // that will be available to the plugin. + // that will be available to the plugin. If the final call + // returns false then no scratch memory will be provided, + // regardless of any previous calls to `reserve()`. // // Note that any memory the host allocates to satisfy // the requested scratch size can be de-allocated by the