Skip to content

Commit 79f7290

Browse files
authored
[mipi_rgb] Clarify use of transform (#5649)
1 parent b384bc5 commit 79f7290

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

content/components/display/mipi_rgb.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,11 @@ Displays needing a custom init sequence require an SPI bus to be configured, plu
134134
`16bit` (default) or `18bit`.
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`.
137-
- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are `false`.
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.
137+
- **transform** (*Optional*): Transform the display presentation using hardware.
138+
This is typically used only to correct for displays that have x or y drivers wired backwards. To rotate the
139+
display the `rotation` option is preferred - it will automatically use hardware transform if possible.
140+
The default values for the `mirror_x` and `mirror_y` options are model dependent.
141+
For the `CUSTOM` model, use of `transform: disabled` will prevent a `rotation` being translated to a hardware transform.
140142

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

0 commit comments

Comments
 (0)