Skip to content

Commit 0156e6e

Browse files
authored
docs: Update description for dwaCompressionLevel (#5074)
Clarify in the documentation that `openexr:dwaCompressionLevel` is a read-only attribute and cannot be used to set the compression level on write. Not sure if this is an obvious change or not, but it wasn't immediately clear if the attribute is meant to be writable. Signed-off-by: Aamir Raza <aamir_raza@outlook.com>
1 parent 18619b8 commit 0156e6e

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

src/doc/builtinplugins.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1608,7 +1608,9 @@ The official OpenEXR site is http://www.openexr.com/.
16081608
- the MIPmap rounding mode of the file.
16091609
* - ``openexr:dwaCompressionLevel``
16101610
- float
1611-
- compression level for dwaa or dwab compression (default: 45.0).
1611+
- compression level for dwaa or dwab compression (default: 45.0).
1612+
Reflects the level used when reading an existing file. To set
1613+
the compression level, use the ``compression`` attribute.
16121614
* - ``openexr::luminancechroma``
16131615
- int
16141616
- If nonzero, indicates whether the image is a luminance-chroma image.

0 commit comments

Comments
 (0)