Kerry Martin / RA8875

KSM edits to RA8875

Dependents:   Liz_Test_Code

DisplayDefs.h@83:7bad0068cca0, 2015-01-01 (annotated)

Committer:
WiredHome
Date:
Thu Jan 01 20:35:37 2015 +0000
Revision:
83:7bad0068cca0
Parent:
81:01da2e34283d
Child:
88:bfddef6ec836
Improve touch interface to automatically provide no_touch, touch, held, release, no_cal value.; Touch API return codes were modified to accommodate this.; Enhance some APIs with (point_t p) parameters.; Minor internal documentation improvement.

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