Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
Signed-off-by: Basile Fraboni <[email protected]>
  • Loading branch information
bfraboni committed Sep 27, 2024
1 parent 1b8cde5 commit 8e70fc1
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/include/OpenImageIO/imagecache.h
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,7 @@ class OIIO_API ImageCache {
return get_imagespec(file, thread_info, spec, subimage);
}

/// Return a pointer to an ImageSpec associated with the named image file.
/// Return a pointer to an ImageSpec that describes the named image file.
/// If the file is found and is an image format that can be read,
/// otherwise return `nullptr`.
///
Expand Down Expand Up @@ -814,11 +814,13 @@ class OIIO_API ImageCache {
}

/// Copy the image dimensions (x, y, z, width, height, depth, full*,
/// nchannels, format) and data types associated with the named image
/// nchannels, format) and data types that describes the named image
/// cache file for the specified subimage and miplevel. It does *not*
/// copy arbitrary named metadata or channel names (thus, for an
/// `ImageSpec` with lots of metadata, it is much less expensive than
/// copying the whole thing with `operator=()`).
/// copying the whole thing with `operator=()`). The associated
/// metadata and channels names can be retrieved with `imagespec()`
/// or `get_imagespec`.
///
/// @param filename
/// The name of the image, as a UTF-8 encoded ustring.
Expand Down

0 comments on commit 8e70fc1

Please sign in to comment.