Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 10:30:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: clarify which axis is used when mirroring

Browse Source
This commit is contained in:
Lovell Fuller 2023-05-11 10:24:24 +01:00
parent 5255964c79
commit e873978e53
4 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-operation.md
View File

@ -57,7 +57,8 @@ const resizeThenRotate = await sharp(input)
## flip
Flip the image about the vertical Y axis. This always occurs before rotation, if any.
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.
@ -73,7 +74,8 @@ const output = await sharp(input).flip().toBuffer();
## flop
Flop the image about the horizontal X axis. This always occurs before rotation, if any.
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.

2
docs/search-index.json
View File

File diff suppressed because one or more lines are too long

6
lib/operation.js
View File

@ -80,7 +80,8 @@ function rotate (angle, options) {
}
/**
* Flip the image about the vertical Y axis. This always occurs before rotation, if any.
* 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.
*
* @example
@ -95,7 +96,8 @@ function flip (flip) {
}
/**
* Flop the image about the horizontal X axis. This always occurs before rotation, if any.
* 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.
*
* @example

4
src/pipeline.cc
View File

@ -380,11 +380,11 @@ class PipelineWorker : public Napi::AsyncWorker {
if (autoRotation != VIPS_ANGLE_D0) {
image = image.rot(autoRotation);
}
// Flip (mirror about Y axis)
// Mirror vertically (up-down) about the x-axis
if (baton->flip || autoFlip) {
image = image.flip(VIPS_DIRECTION_VERTICAL);
}
// Flop (mirror about X axis)
// Mirror horizontally (left-right) about the y-axis
if (baton->flop || autoFlop) {
image = image.flip(VIPS_DIRECTION_HORIZONTAL);
}