Skip to content

Commit

Permalink
Docs: multi-page images cannot be flipped
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed May 13, 2023
1 parent e873978 commit dc4b39f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/api-operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,11 @@ const resizeThenRotate = await sharp(input)
## flip
Mirror the image vertically (up-down) about the x-axis.
This always occurs before rotation, if any.

The use of `flip` implies the removal of the EXIF `Orientation` tag, if any.

This operation does not work correctly with multi-page images.



| Param | Type | Default |
Expand All @@ -76,6 +79,7 @@ const output = await sharp(input).flip().toBuffer();
## flop
Mirror the image horizontally (left-right) about the y-axis.
This always occurs before rotation, if any.

The use of `flop` implies the removal of the EXIF `Orientation` tag, if any.


Expand Down
Loading

0 comments on commit dc4b39f

Please sign in to comment.