diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_oled_driver.md | 9 | ||||
| -rw-r--r-- | docs/feature_rgb_matrix.md | 20 |
2 files changed, 15 insertions, 14 deletions
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md index fcc19515a..144b695b7 100644 --- a/docs/feature_oled_driver.md +++ b/docs/feature_oled_driver.md | |||
| @@ -108,10 +108,11 @@ void oled_task_user(void) { | |||
| 108 | |`OLED_DISPLAY_CUSTOM` |*Not defined* |Changes the display defines for use with custom displays.<br />Requires user to implement the below defines. | | 108 | |`OLED_DISPLAY_CUSTOM` |*Not defined* |Changes the display defines for use with custom displays.<br />Requires user to implement the below defines. | |
| 109 | |`OLED_DISPLAY_WIDTH` |`128` |The width of the OLED display. | | 109 | |`OLED_DISPLAY_WIDTH` |`128` |The width of the OLED display. | |
| 110 | |`OLED_DISPLAY_HEIGHT` |`32` |The height of the OLED display. | | 110 | |`OLED_DISPLAY_HEIGHT` |`32` |The height of the OLED display. | |
| 111 | |`OLED_MATRIX_SIZE` |`512` |The local buffer size to allocate.<br />`(OLED_DISPLAY_HEIGHT / 8 * OLED_DISPLAY_WIDTH)`| | 111 | |`OLED_MATRIX_SIZE` |`512` |The local buffer size to allocate.<br />`(OLED_DISPLAY_HEIGHT / 8 * OLED_DISPLAY_WIDTH)`. | |
| 112 | |`OLED_BLOCK_TYPE` |`uint16_t` |The unsigned integer type to use for dirty rendering.| | 112 | |`OLED_BLOCK_TYPE` |`uint16_t` |The unsigned integer type to use for dirty rendering. | |
| 113 | |`OLED_BLOCK_COUNT` |`16` |The number of blocks the display is divided into for dirty rendering.<br />`(sizeof(OLED_BLOCK_TYPE) * 8)`| | 113 | |`OLED_BLOCK_COUNT` |`16` |The number of blocks the display is divided into for dirty rendering.<br />`(sizeof(OLED_BLOCK_TYPE) * 8)`. | |
| 114 | |`OLED_BLOCK_SIZE` |`32` |The size of each block for dirty rendering<br />`(OLED_MATRIX_SIZE / OLED_BLOCK_COUNT)`| | 114 | |`OLED_BLOCK_SIZE` |`32` |The size of each block for dirty rendering<br />`(OLED_MATRIX_SIZE / OLED_BLOCK_COUNT)`. | |
| 115 | |`OLED_COM_PINS` |`COM_PINS_SEQ` |How the SSD1306 chip maps it's memory to display.<br />Options are `COM_PINS_SEQ`, `COM_PINS_ALT`, `COM_PINS_SEQ_LR`, & `COM_PINS_ALT_LR`. | | ||
| 115 | |`OLED_SOURCE_MAP` |`{ 0, ... N }` |Precalculated source array to use for mapping source buffer to target OLED memory in 90 degree rendering. | | 116 | |`OLED_SOURCE_MAP` |`{ 0, ... N }` |Precalculated source array to use for mapping source buffer to target OLED memory in 90 degree rendering. | |
| 116 | |`OLED_TARGET_MAP` |`{ 24, ... N }`|Precalculated target array to use for mapping source buffer to target OLED memory in 90 degree rendering. | | 117 | |`OLED_TARGET_MAP` |`{ 24, ... N }`|Precalculated target array to use for mapping source buffer to target OLED memory in 90 degree rendering. | |
| 117 | 118 | ||
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index 8f0cd12b3..916fcdce0 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
| @@ -42,11 +42,11 @@ Define these arrays listing all the LEDs in your `<keyboard>.c`: | |||
| 42 | ```C | 42 | ```C |
| 43 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { | 43 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { |
| 44 | /* Refer to IS31 manual for these locations | 44 | /* Refer to IS31 manual for these locations |
| 45 | * driver | 45 | * driver |
| 46 | * | R location | 46 | * | R location |
| 47 | * | | G location | 47 | * | | G location |
| 48 | * | | | B location | 48 | * | | | B location |
| 49 | * | | | | */ | 49 | * | | | | */ |
| 50 | {0, C1_3, C2_3, C3_3}, | 50 | {0, C1_3, C2_3, C3_3}, |
| 51 | .... | 51 | .... |
| 52 | } | 52 | } |
| @@ -93,11 +93,11 @@ Define these arrays listing all the LEDs in your `<keyboard>.c`: | |||
| 93 | ```C | 93 | ```C |
| 94 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { | 94 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { |
| 95 | /* Refer to IS31 manual for these locations | 95 | /* Refer to IS31 manual for these locations |
| 96 | * driver | 96 | * driver |
| 97 | * | R location | 97 | * | R location |
| 98 | * | | G location | 98 | * | | G location |
| 99 | * | | | B location | 99 | * | | | B location |
| 100 | * | | | | */ | 100 | * | | | | */ |
| 101 | {0, B_1, A_1, C_1}, | 101 | {0, B_1, A_1, C_1}, |
| 102 | .... | 102 | .... |
| 103 | } | 103 | } |
