Update src/include/OpenImageIO/imagebufalgo.h

Signed-off-by: Larry Gritz <[email protected]>

Author: lgritz

src/include/OpenImageIO/imagebufalgo.h

@@ -953,10 +953,14 @@ ImageBuf OIIO_API abs (const ImageBuf &A, ROI roi={}, int nthreads=0);
 bool OIIO_API abs (ImageBuf &dst, const ImageBuf &A, ROI roi={}, int nthreads=0);
 
 
-/// Compute per-pixel product `A * B`, returning the result image.
+/// Compute per-pixel product `A * B`, returning the result image. At least
+/// one of `A` and `B` must be a single channel image, whose value is used to
+/// scale all channels of the other image.
+///
+/// @param  options
+///         Optional ParamValue's that may control the reconstruction.
+///         (Reserved for future expansion.)
 ///
-/// All channels of one of the images get multiplied by the value in the only channel of the other image.
-/// Either `A` or `B` must be a single channel image.
 ImageBuf OIIO_API scale (const ImageBuf &A, const ImageBuf &B,
                          KWArgs options = {}, ROI roi={}, int nthreads=0);
 /// Write to an existing image `dst` (allocating if it is uninitialized).