Skip to content

Commit c1f0ef6

Browse files
nitinseshadrimateoconlechuga
authored andcommitted
Clarify documentation for lcd_CrsrSetImage
1 parent 7a0b19d commit c1f0ef6

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/ce/include/sys/lcd.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,18 @@ do { \
114114
/**
115115
* Sets cursor image.
116116
*
117-
* @param[in] data A pointer to 256 or 1024 bytes of packed 2bpp image data.
117+
* @param[in] data A pointer to 256 or 1024 bytes of packed 2bpp image data,
118+
* depending on the value of lcd_CrsrGetSize().
118119
* @see lcd_cursor_size_t
119120
*
120121
* @note
121122
* To use convimg to create the required data, add `bpp: 2`
122123
* to the converts section in convimg.yaml corresponding
123124
* to your image(s).
125+
*
126+
* @note
127+
* If the cursor size is set to small (32x32), this will copy the data
128+
* to image index 0.
124129
*/
125130
#define lcd_CrsrSetImage(data) \
126131
do { \

0 commit comments

Comments
 (0)