Skip to content

Commit 1cb8ab2

Browse files
committed
Document the ustring:cleanup flag
Signed-off-by: Larry Gritz <lg@larrygritz.com>
1 parent eecfaaa commit 1cb8ab2

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

src/include/OpenImageIO/imageio.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3953,6 +3953,15 @@ OIIO_API std::string geterror(bool clear = true);
39533953
/// enable globally in an environment where security is a higher priority
39543954
/// than being tolerant of partially broken image files.
39553955
///
3956+
/// - `ustring:cleanup` (int: 0)
3957+
///
3958+
/// If nonzero, upon exit, do a thorough (and possibly expensive) teardown
3959+
/// of ustring internal resources to ensure that there are no apparent
3960+
/// memory leaks. This is only desirable in certain debugging situations.
3961+
/// Ordinarily, it is better to finish as quickly as possible, so the
3962+
/// default of 0 skips a time consuming and pointless teardown of the
3963+
/// ustring internal allocations when the app exits.
3964+
///
39563965
/// EXAMPLES:
39573966
/// ```
39583967
/// // Setting single simple values simply:

0 commit comments

Comments
 (0)