Kerry Martin / RA8875

KSM edits to RA8875

Dependents:   Liz_Test_Code

DisplayDefs.h@123:2f45e80fec5f, 2016-07-25 (annotated)

Committer:
WiredHome
Date:
Mon Jul 25 10:55:58 2016 +0000
Revision:
123:2f45e80fec5f
Parent:
122:79e431f98fa9
Child:
125:7a0b70f56550
Added idle callback - when the RA8875 driver is stuck waiting on the HW, or on a long timeout, it can call an optional callback. This could be used for maintaining the Watchdog, or other activities.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 31:c72e12cd5c67 1 #ifndef DISPLAYDEFS_H
WiredHome 31:c72e12cd5c67 2 #define DISPLAYDEFS_H
WiredHome 31:c72e12cd5c67 3
WiredHome 32:0e4f2ae512e2 4 #define RGB(r,g,b) ( ((r<<8)&0xF800) | ((g<<3)&0x07E0) | (b>>3) )
WiredHome 32:0e4f2ae512e2 5
WiredHome 31:c72e12cd5c67 6
WiredHome 79:544eb4964795 7 /// return values from functions. Use this number, or use the
WiredHome 79:544eb4964795 8 /// lookup function to get a text string. @see GetErrorMessage.
WiredHome 79:544eb4964795 9 ///
WiredHome 31:c72e12cd5c67 10 typedef enum
WiredHome 31:c72e12cd5c67 11 {
WiredHome 31:c72e12cd5c67 12 noerror, ///< no errors, command completed successfully
WiredHome 31:c72e12cd5c67 13 bad_parameter, ///< one or more parameters are invalid
WiredHome 31:c72e12cd5c67 14 file_not_found, ///< specified file could not be found
WiredHome 42:7cbdfd2bbfc5 15 not_bmp_format, ///< file is not a .bmp file
WiredHome 42:7cbdfd2bbfc5 16 not_ico_format, ///< file is not a .ico file
WiredHome 112:325ca91bc03d 17 not_supported_format, ///< file format is not yet supported (e.g. bits per pixel, compression)
WiredHome 31:c72e12cd5c67 18 image_too_big, ///< image is too large for the screen
WiredHome 31:c72e12cd5c67 19 not_enough_ram, ///< could not allocate ram for scanline
WiredHome 122:79e431f98fa9 20 touch_cal_timeout, ///< timeout while trying to calibrate touchscreen, perhaps it is not installed.
WiredHome 115:c9862fd0c689 21 external_abort, ///< an external process caused an abort
WiredHome 79:544eb4964795 22 LastErrCode, // Private marker.
WiredHome 31:c72e12cd5c67 23 } RetCode_t;
WiredHome 31:c72e12cd5c67 24
WiredHome 83:7bad0068cca0 25 /// return values from TouchPanelReadable, TouchPanelA2DRaw, TouchPanelA2DFiltered.
WiredHome 83:7bad0068cca0 26 /// @see TouchPanelReadable.
WiredHome 83:7bad0068cca0 27 typedef enum
WiredHome 83:7bad0068cca0 28 {
WiredHome 83:7bad0068cca0 29 no_touch, ///< no touch is detected
WiredHome 83:7bad0068cca0 30 touch, ///< touch is detected
WiredHome 83:7bad0068cca0 31 held, ///< held after touch
WiredHome 83:7bad0068cca0 32 release, ///< release is detected
WiredHome 83:7bad0068cca0 33 no_cal, ///< no calibration matrix is available
WiredHome 83:7bad0068cca0 34 } TouchCode_t;
WiredHome 83:7bad0068cca0 35
WiredHome 37:f19b7e7449dc 36 /// type that manages locations, which is typically an x or y pixel location,
WiredHome 37:f19b7e7449dc 37 /// which can range from -N to +N (even if the screen is 0 to +n). @see textloc_t.
WiredHome 37:f19b7e7449dc 38 typedef int16_t loc_t;
WiredHome 37:f19b7e7449dc 39
WiredHome 37:f19b7e7449dc 40 /// type that manages text locations, which are row or column values in
WiredHome 37:f19b7e7449dc 41 /// units of character, not pixel. @see loc_t.
WiredHome 37:f19b7e7449dc 42 typedef uint16_t textloc_t;
WiredHome 37:f19b7e7449dc 43
WiredHome 37:f19b7e7449dc 44 /// type that manages dimensions of width or height, which range from 0 to N.
WiredHome 37:f19b7e7449dc 45 typedef uint16_t dim_t;
WiredHome 37:f19b7e7449dc 46
WiredHome 32:0e4f2ae512e2 47 /// type that manages x,y pairs
WiredHome 32:0e4f2ae512e2 48 typedef struct
WiredHome 32:0e4f2ae512e2 49 {
WiredHome 37:f19b7e7449dc 50 loc_t x; ///< x value in the point
WiredHome 37:f19b7e7449dc 51 loc_t y; ///< y value in the point
WiredHome 32:0e4f2ae512e2 52 } point_t;
WiredHome 32:0e4f2ae512e2 53
WiredHome 81:01da2e34283d 54 /// type that manages rectangles, which are pairs of points. It is recommended
WiredHome 81:01da2e34283d 55 /// that p1 contains the top-left point and p2 contains the bottom-right point,
WiredHome 81:01da2e34283d 56 /// even though eventually this should not matter.
WiredHome 81:01da2e34283d 57 typedef struct
WiredHome 81:01da2e34283d 58 {
WiredHome 81:01da2e34283d 59 point_t p1; ///< p1 defines one point on the rectangle
WiredHome 81:01da2e34283d 60 point_t p2; ///< p2 defines the opposite point on the rectangle
WiredHome 81:01da2e34283d 61 } rect_t;
WiredHome 81:01da2e34283d 62
WiredHome 77:9206c13aa527 63 typedef struct
WiredHome 77:9206c13aa527 64 {
WiredHome 77:9206c13aa527 65 int32_t An, Bn, Cn, Dn, En, Fn, Divider;
WiredHome 77:9206c13aa527 66 } tpMatrix_t;
WiredHome 77:9206c13aa527 67
WiredHome 32:0e4f2ae512e2 68 /// color type definition to let the compiler help keep us honest.
WiredHome 32:0e4f2ae512e2 69 ///
WiredHome 32:0e4f2ae512e2 70 /// colors can be defined with the RGB(r,g,b) macro, and there
WiredHome 32:0e4f2ae512e2 71 /// are a number of predefined colors:
WiredHome 32:0e4f2ae512e2 72 /// - Black, Blue, Green, Cyan,
WiredHome 32:0e4f2ae512e2 73 /// - Red, Magenta, Brown, Gray,
WiredHome 32:0e4f2ae512e2 74 /// - Charcoal, BrightBlue, BrightGreen, BrightCyan,
WiredHome 32:0e4f2ae512e2 75 /// - Orange, Pink, Yellow, White
WiredHome 32:0e4f2ae512e2 76 ///
WiredHome 32:0e4f2ae512e2 77 typedef uint16_t color_t;
WiredHome 32:0e4f2ae512e2 78
WiredHome 32:0e4f2ae512e2 79 /// background fill info for drawing Text, Rectangles, RoundedRectanges, Circles, Ellipses and Triangles.
WiredHome 32:0e4f2ae512e2 80 typedef enum
WiredHome 32:0e4f2ae512e2 81 {
WiredHome 32:0e4f2ae512e2 82 NOFILL, ///< do not fill the object with the background color
WiredHome 32:0e4f2ae512e2 83 FILL ///< fill the object space with the background color
WiredHome 32:0e4f2ae512e2 84 } fill_t;
WiredHome 32:0e4f2ae512e2 85
WiredHome 31:c72e12cd5c67 86 #endif // DISPLAYDEFS_H