Skip to content

Commit 80f4809

Browse files
authored
[mipi_rgb] [mipi_spi] Document transform: disabled (#5533)
1 parent 49d3b50 commit 80f4809

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

content/components/display/mipi_rgb.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ display:
6666
id: my_display
6767
```
6868
69-
## Configuration variables
69+
## Configuration options
7070
7171
- **rotation** (*Optional*): Rotate the display presentation in software. Choose one of `0°`, `90°`, `180°`, or `270°`.
7272
This option cannot be used with `transform`.
@@ -135,7 +135,8 @@ Displays needing a custom init sequence require an SPI bus to be configured, plu
135135
- **invert_colors** (*Optional*): Inverts the display colors, (white becomes black.) Defaults to false.
136136
- **color_order** (*Optional*): Should be one of `bgr` (default) or `rgb`.
137137
- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are `false`.
138-
This option cannot be used with `rotation`.
138+
This option should not be used with `rotation`. For the `CUSTOM` model, use `transform: disabled`
139+
if the display does not support it, which will prevent a `rotation` being translated to a hardware transform.
139140

140141
- **mirror_x** (*Optional*, boolean): If true, mirror the x-axis.
141142
- **mirror_y** (*Optional*, boolean): If true, mirror the y-axis.

content/components/display/mipi_spi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ most of the configuration will be set by default, but can be overridden if neede
127127
- **invert_colors** (*Optional*, boolean): Specifies whether the display colors should be inverted. Options are `true` or `false`. Defaults to `false`.
128128
- **rotation** (*Optional*): Rotate the display presentation in software. Choose one of `0°`, `90°`, `180°`, or `270°`. If the driver chip supports hardware rotation for the given orientation this will be translated to the appropriate hardware command. If hardware rotation is not supported, the display will be rotated in software.
129129
- **transform** (*Optional*): If `rotation` is not sufficient, use this to transform the display. If this option is specified, then the `dimensions` option must also be provided. The value can either be the string `disabled` to disable hardware transform, or a dictionary. Options are:
130+
This option should not be used with `rotation`. For the `CUSTOM` model, use `transform: disabled`
131+
if the display does not support it, which will prevent a `rotation` being translated to a hardware transform.
130132

131133
- **swap_xy** (**Required**, boolean): If true, exchange the x and y axes.
132134
- **mirror_x** (**Required**, boolean): If true, mirror the x axis.

0 commit comments

Comments
 (0)