diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/custom_quantum_functions.md | 4 | ||||
| -rw-r--r-- | docs/feature_led_matrix.md | 9 | ||||
| -rw-r--r-- | docs/feature_rgb_matrix.md | 2 |
3 files changed, 4 insertions, 11 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 494e76996..b0ed0f588 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md | |||
| @@ -148,8 +148,8 @@ This is useful for setting up stuff that you may need elsewhere, but isn't hardw | |||
| 148 | 148 | ||
| 149 | * GPIO pin initialisation: `void matrix_init_pins(void)` | 149 | * GPIO pin initialisation: `void matrix_init_pins(void)` |
| 150 | * This needs to perform the low-level initialisation of all row and column pins. By default this will initialise the input/output state of each of the GPIO pins listed in `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no initialisation of pin state will occur within QMK itself, instead deferring to the keyboard's override. | 150 | * This needs to perform the low-level initialisation of all row and column pins. By default this will initialise the input/output state of each of the GPIO pins listed in `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no initialisation of pin state will occur within QMK itself, instead deferring to the keyboard's override. |
| 151 | * `COL2ROW`-based row reads: `void matrix_read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)` | 151 | * `COL2ROW`-based row reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` |
| 152 | * `ROW2COL`-based column reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` | 152 | * `ROW2COL`-based column reads: `void matrix_read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)` |
| 153 | * `DIRECT_PINS`-based reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` | 153 | * `DIRECT_PINS`-based reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` |
| 154 | * These three functions need to perform the low-level retrieval of matrix state of relevant input pins, based on the matrix type. Only one of the functions should be implemented, if needed. By default this will iterate through `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, configuring the inputs and outputs based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no manipulation of matrix GPIO pin state will occur within QMK itself, instead deferring to the keyboard's override. | 154 | * These three functions need to perform the low-level retrieval of matrix state of relevant input pins, based on the matrix type. Only one of the functions should be implemented, if needed. By default this will iterate through `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, configuring the inputs and outputs based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no manipulation of matrix GPIO pin state will occur within QMK itself, instead deferring to the keyboard's override. |
| 155 | 155 | ||
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md index 7d7971bbe..ed92bffd9 100644 --- a/docs/feature_led_matrix.md +++ b/docs/feature_led_matrix.md | |||
| @@ -244,14 +244,7 @@ static bool my_cool_effect2(effect_params_t* params) { | |||
| 244 | #endif // LED_MATRIX_CUSTOM_EFFECT_IMPLS | 244 | #endif // LED_MATRIX_CUSTOM_EFFECT_IMPLS |
| 245 | ``` | 245 | ``` |
| 246 | 246 | ||
| 247 | For inspiration and examples, check out the built-in effects under `quantum/led_matrix_animations/` | 247 | For inspiration and examples, check out the built-in effects under `quantum/led_matrix/animations/`. |
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | |||
| 253 | |||
| 254 | |||
| 255 | 248 | ||
| 256 | 249 | ||
| 257 | ## Additional `config.h` Options :id=additional-configh-options | 250 | ## Additional `config.h` Options :id=additional-configh-options |
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index f3189bf84..2660aad09 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
| @@ -562,7 +562,7 @@ static bool my_cool_effect2(effect_params_t* params) { | |||
| 562 | #endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS | 562 | #endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS |
| 563 | ``` | 563 | ``` |
| 564 | 564 | ||
| 565 | For inspiration and examples, check out the built-in effects under `quantum/rgb_matrix_animations/` | 565 | For inspiration and examples, check out the built-in effects under `quantum/rgb_matrix/animations/`. |
| 566 | 566 | ||
| 567 | 567 | ||
| 568 | ## Colors :id=colors | 568 | ## Colors :id=colors |
