Skip to content

Commit

Permalink
Clarify: if final reserve() call returns false, then no scratch memory
Browse files Browse the repository at this point in the history
  • Loading branch information
jatinchowdhury18 committed Oct 21, 2024
1 parent 5bf4e59 commit 635045c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions include/clap/ext/draft/scratch-memory.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 635045c

Please sign in to comment.