|
| 1 | +# Summary |
| 2 | + |
| 3 | + Members | Descriptions |
| 4 | +--------------------------------|--------------------------------------------- |
| 5 | +`class` [`Arduino_H7_Video`](#class-arduino_h7_video) | The main class for managing the video controller and the display. |
| 6 | + |
| 7 | +# class [`Arduino_H7_Video`](#class-arduino_h7_video) |
| 8 | +The main class for managing the video controller and the display. |
| 9 | + |
| 10 | +## Summary |
| 11 | + |
| 12 | +| Members | Descriptions | |
| 13 | +|-------------------------------------------------------------|---------------------------------------------| |
| 14 | +| `public ` [`Arduino_H7_Video`](#public-arduino_h7_videoint-width-int-height-h7displayshield-shield) | Construct a new Arduino_H7_Video object with the specified width, height, and display shield. | |
| 15 | +| `public int` [`begin`](#public-int-begin) | Initialize the video controller and display. | |
| 16 | +| `public void` [`end`](#public-void-end) | De-initialize the video controller and display. | |
| 17 | +| `public int` [`width`](#public-int-width) | Get the width of the display. | |
| 18 | +| `public int` [`height`](#public-int-height) | Get the height of the display. | |
| 19 | +| `public bool` [`isRotated`](#public-bool-isrotated) | Check if the display is rotated. | |
| 20 | +| `public void` [`clear`](#public-void-clear) | Clear the display. | |
| 21 | +| `public void` [`beginDraw`](#public-void-begindraw) | Begin drawing operations on the display. | |
| 22 | +| `public void` [`endDraw`](#public-void-enddraw) | End drawing operations on the display. | |
| 23 | +| `public void` [`set`](#public-void-setint-x-int-y-uint8_t-r-uint8_t-g-uint8_t-b) | Set the color of the pixel at the specified coordinates. | |
| 24 | + |
| 25 | +> *Note: For all drawing functions, refer to the documentation of the [`ArduinoGraphics`](https://reference.arduino.cc/reference/en/libraries/arduinographics/) library.* |
| 26 | +
|
| 27 | +## Members |
| 28 | + |
| 29 | +### `public ` [`Arduino_H7_Video`](#)`(int width, int height, H7DisplayShield &shield)` |
| 30 | + |
| 31 | +Construct a new Arduino_H7_Video object with the specified width, height, and display shield. |
| 32 | + |
| 33 | +#### Parameters |
| 34 | +- `width`: The width of the display. |
| 35 | +- `height`: The height of the display. |
| 36 | +- `shield`: The display shield used. |
| 37 | + - *GigaDisplayShield*: Giga Display Shield |
| 38 | + - *USBCVideo*: Display attach to the USB-C port |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +### `public int` [`begin`](#)`()` |
| 43 | + |
| 44 | +Initialize the video controller and display. |
| 45 | + |
| 46 | +#### Returns |
| 47 | +`int`: 0 if initialization is successful, otherwise an error code. |
| 48 | + |
| 49 | +--- |
| 50 | + |
| 51 | +### `public void` [`end`](#)`()` |
| 52 | + |
| 53 | +De-initialize the video controller and display. |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +### `public int` [`width`](#)`()` |
| 58 | + |
| 59 | +Get the width of the display. |
| 60 | + |
| 61 | +#### Returns |
| 62 | +`int`: The width of the display. |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +### `public int` [`height`](#)`()` |
| 67 | + |
| 68 | +Get the height of the display. |
| 69 | + |
| 70 | +#### Returns |
| 71 | +`int`: The height of the display. |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +### `public bool` [`isRotated`](#)`()` |
| 76 | + |
| 77 | +Check if the display is rotated. |
| 78 | + |
| 79 | +#### Returns |
| 80 | +`bool`: True if the display is rotated, false otherwise. |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +### `public void` [`clear`](#)`()` |
| 85 | + |
| 86 | +Clear the display. |
| 87 | + |
| 88 | +--- |
| 89 | + |
| 90 | +### `public void` [`beginDraw`](#)`()` |
| 91 | + |
| 92 | +Begin drawing operations on the display. |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +### `public void` [`endDraw`](#)`()` |
| 97 | + |
| 98 | +End drawing operations on the display. |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +### `public void` [`set`](#)`(int x, int y, uint8_t r, uint8_t g, uint8_t b)` |
| 103 | + |
| 104 | +Set the color of the pixel at the specified coordinates. |
| 105 | + |
| 106 | +#### Parameters |
| 107 | +- `x`: The x-coordinate of the pixel. |
| 108 | +- `y`: The y-coordinate of the pixel. |
| 109 | +- `r`: The red component of the color. |
| 110 | +- `g`: The green component of the color. |
| 111 | +- `b`: The blue component of the color. |
| 112 | + |
| 113 | +--- |
| 114 | + |
| 115 | +> *Note: For detailed information on drawing functions, please refer to the documentation of the [`ArduinoGraphics`](https://reference.arduino.cc/reference/en/libraries/arduinographics/) library.* |
| 116 | +
|
| 117 | + |
0 commit comments