Document filter order

Matrix multiplication is not commutative, so the order of filters
matters.

PR #5455 <https://github.com/Genymobile/scrcpy/pull/5455>
This commit is contained in:
Romain Vimont 2024-11-19 18:30:19 +01:00
parent 172043d9cb
commit 3660594a80
3 changed files with 17 additions and 8 deletions

View File

@ -141,9 +141,7 @@ Default is 0.
.BI "\-\-crop " width\fR:\fIheight\fR:\fIx\fR:\fIy
Crop the device screen on the server.
The values are expressed in the device natural orientation (typically, portrait for a phone, landscape for a tablet). Any
.B \-\-max\-size
value is computed on the cropped size.
The values are expressed in the device natural orientation (typically, portrait for a phone, landscape for a tablet).
.TP
.B \-d, \-\-select\-usb

View File

@ -311,8 +311,7 @@ static const struct sc_option options[] = {
.argdesc = "width:height:x:y",
.text = "Crop the device screen on the server.\n"
"The values are expressed in the device natural orientation "
"(typically, portrait for a phone, landscape for a tablet). "
"Any --max-size value is computed on the cropped size.",
"(typically, portrait for a phone, landscape for a tablet).",
},
{
.shortopt = 'd',

View File

@ -27,6 +27,9 @@ preserved. That way, a device in 1920×1080 will be mirrored at 1024×576.
If encoding fails, scrcpy automatically tries again with a lower definition
(unless `--no-downsize-on-error` is enabled).
For camera mirroring, the `--max-size` value is used to select the camera source
size instead (among the available resolutions).
## Bit rate
@ -138,7 +141,10 @@ scrcpy --capture-orientation=@flip180 # locked to hflip + 180°
scrcpy --capture-orientation=@flip270 # locked to hflip + 270° clockwise
```
To orient the video (on the rendering side):
The capture orientation transform is applied after `--crop`, but before
`--angle`.
To orient the video (on the client side):
```bash
scrcpy --orientation=0
@ -167,7 +173,9 @@ To rotate the video content by a custom angle (in degrees, clockwise):
scrcpy --angle=23
```
The center of rotation is the center of the visible area (after cropping).
The center of rotation is the center of the visible area.
This transformation is applied after `--crop` and `--capture-orientation`.
## Crop
@ -183,7 +191,11 @@ scrcpy --crop=1224:1440:0:0 # 1224x1440 at offset (0,0)
The values are expressed in the device natural orientation (portrait for a
phone, landscape for a tablet).
If `--max-size` is also specified, resizing is applied after cropping.
Cropping is performed before `--capture-orientation` and `--angle`.
For screen mirroring, `--max-size` is applied after cropping. For camera and
virtual display mirroring, `--max-size` is applied first (because it selects the
source size rather than resizing it).
## Display