Skip to content

Commit 77ff294

Browse files
authored
Fix copy/paste error in ImageCache docs for 'failure_retries' attrib (#3147)
1 parent c3cf7b9 commit 77ff294

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/include/OpenImageIO/imagecache.h

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -171,12 +171,14 @@ class OIIO_API ImageCache {
171171
/// consider `float` data. The default is zero, meaning that
172172
/// image pixels are not forced to be `float` when in cache.
173173
/// - `int failure_retries` :
174-
/// When nonzero (the default), ImageCache accepts
175-
/// un-MIPmapped images as usual. When set to zero,
176-
/// ImageCache will reject un-MIPmapped images with an error
177-
/// condition, as if the file could not be properly read. This
178-
/// is sometimes helpful for applications that want to enforce
179-
/// use of MIP-mapped images only. (Default: 1)
174+
/// When an image file is opened or a tile/scanline is read but
175+
/// a file error occurs, if this attribute is nonzero, it will
176+
/// try the operation again up to this many times before giving
177+
/// up and reporting a failure. Setting this to a small nonzero
178+
/// number (like 3) may help make an application more robust to
179+
/// occasional spurious networking or other glitches that would
180+
/// otherwise cause the entire long-running application to fail
181+
/// upon a single transient error. (Default: 0)
180182
/// - `int deduplicate` :
181183
/// When nonzero, the ImageCache will notice duplicate images
182184
/// under different names if their headers contain a SHA-1

0 commit comments

Comments
 (0)