Add mention of max() to preserve ratio in withoutEnlargement (#1077)

This commit is contained in:
Tony Mobily 2018-01-13 17:59:59 +08:00 committed by Lovell Fuller
parent da5deb8177
commit 573836e2b8

View File

@ -253,6 +253,7 @@ function ignoreAspectRatio () {
* Do not enlarge the output image if the input image width *or* height are already less than the required dimensions. * Do not enlarge the output image if the input image width *or* height are already less than the required dimensions.
* This is equivalent to GraphicsMagick's `>` geometry option: * This is equivalent to GraphicsMagick's `>` geometry option:
* "*change the dimensions of the image only if its width or height exceeds the geometry specification*". * "*change the dimensions of the image only if its width or height exceeds the geometry specification*".
* Use with `max()` to preserve the image's aspect ratio.
* *
* The default behaviour *before* function call is `false`, meaning the image will be enlarged. * The default behaviour *before* function call is `false`, meaning the image will be enlarged.
* *