Skip to content

Commit

Permalink
Merge pull request #76018 from AThousandShips/image_doc
Browse files Browse the repository at this point in the history
Fix `Image.compress` description
  • Loading branch information
akien-mga committed Apr 13, 2023
2 parents 37991a2 + 6312fe2 commit 4dcf2c5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/classes/Image.xml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<param index="2" name="astc_format" type="int" enum="Image.ASTCFormat" default="0" />
<description>
Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.
The [param mode] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
The [param source] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
For ASTC compression, the [param astc_format] parameter must be supplied.
</description>
</method>
Expand Down

0 comments on commit 4dcf2c5

Please sign in to comment.