Mercurial > octave
changeset 33106:f3c6badd9dd4 stable
doc: Document cdata image property class dependence. (bug #56175)
* doc/interpreter/genpropdoc.m: Update property description for image cdata
to describe the RGB color range dependence on cdata type.
| author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
|---|---|
| date | Thu, 29 Feb 2024 01:37:05 -0500 |
| parents | 71bbf3d89efe |
| children | 63cf01d7c543 030686799759 |
| files | doc/interpreter/genpropdoc.m |
| diffstat | 1 files changed, 5 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/genpropdoc.m Tue Feb 27 23:48:37 2024 -0500 +++ b/doc/interpreter/genpropdoc.m Thu Feb 29 01:37:05 2024 -0500 @@ -1876,7 +1876,11 @@ s.doc = "Color data for the image object. Data is either stored as \ a 2-D matrix where each element's value determines that pixel's color \ according to the current colormap, or as a 3-D array where the third \ -dimension contains separate red, blue, and green components for each pixel."; +dimension contains separate red, blue, and green components for each pixel. \ +For RGB arrays, the values that map to minimum to a maximum color value \ +depend on the class of @qcode{\"cdata\"}. Floating point and logical values \ +range from 0 to 1 while integer value range from @code{intmin} to \ +@code{intmax} for that integer class."; s.valid = "array"; s.category = "Image Data";