diff options
Diffstat (limited to 'src/gdisp/gdisp_options.h')
| -rw-r--r-- | src/gdisp/gdisp_options.h | 252 |
1 files changed, 126 insertions, 126 deletions
diff --git a/src/gdisp/gdisp_options.h b/src/gdisp/gdisp_options.h index f5f2c18b..8fb409a2 100644 --- a/src/gdisp/gdisp_options.h +++ b/src/gdisp/gdisp_options.h @@ -22,175 +22,175 @@ */ /** * @brief Should drawing operations be automatically flushed. - * @details Defaults to FALSE - * @note If set to FALSE and the controller requires flushing + * @details Defaults to GFXOFF + * @note If set to GFXOFF and the controller requires flushing * then the application must manually call @p gdispGFlush(). - * Setting this to TRUE causes GDISP to automatically flush + * Setting this to GFXON causes GDISP to automatically flush * after each drawing operation. Note this may be slow but enables * an application to avoid having to manually call the flush routine. - * @note If TRUE and GDISP_NEED_TIMERFLUSH is also TRUE, this takes precedence. + * @note If GFXON and GDISP_NEED_TIMERFLUSH is also GFXON, this takes precedence. * @note Most controllers don't need flushing which is why this is set to - * FALSE by default. + * GFXOFF by default. */ #ifndef GDISP_NEED_AUTOFLUSH - #define GDISP_NEED_AUTOFLUSH FALSE + #define GDISP_NEED_AUTOFLUSH GFXOFF #endif /** * @brief Should drawing operations be automatically flushed on a timer. - * @details Defaults to FALSE, Can be set to FALSE or a timer period in milliseconds. + * @details Defaults to GFXOFF, Can be set to GFXOFF or a timer period in milliseconds. * @note The period should not be set too short or it will consume all your CPU. A * value between 250 and 500 milliseconds would probably be suitable. - * @note If TRUE and GDISP_NEED_AUTOFLUSH is also TRUE, this is ineffective. + * @note If GFXON and GDISP_NEED_AUTOFLUSH is also GFXON, this is ineffective. * @note Most controllers don't need flushing which is why this is set to - * FALSE by default. + * GFXOFF by default. */ #ifndef GDISP_NEED_TIMERFLUSH - #define GDISP_NEED_TIMERFLUSH FALSE + #define GDISP_NEED_TIMERFLUSH GFXOFF #endif /** * @brief Should all operations be clipped to the screen and colors validated. - * @details Defaults to TRUE. - * @note If this is FALSE, any operations that extend beyond the + * @details Defaults to GFXON. + * @note If this is GFXOFF, any operations that extend beyond the * edge of the screen will have undefined results. Any * out-of-range colors will produce undefined results. - * @note This should always be left as the default (TRUE) unless you + * @note This should always be left as the default (GFXON) unless you * are a maniac for speed and you have thoroughly tested your code * and it never overwrites the edges of the screen. - * @note Setting GDISP_NEED_CLIP to TRUE internally uses the same mechanism - * as this validation. There is no advantage in setting this FALSE if - * GDISP_NEED_CLIP is TRUE. + * @note Setting GDISP_NEED_CLIP to GFXON internally uses the same mechanism + * as this validation. There is no advantage in setting this GFXOFF if + * GDISP_NEED_CLIP is GFXON. */ #ifndef GDISP_NEED_VALIDATION - #define GDISP_NEED_VALIDATION TRUE + #define GDISP_NEED_VALIDATION GFXON #endif /** * @brief Are clipping functions needed. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_CLIP - #define GDISP_NEED_CLIP TRUE + #define GDISP_NEED_CLIP GFXON #endif /** * @brief Streaming functions are needed - * @details Defaults to FALSE. + * @details Defaults to GFXOFF. */ #ifndef GDISP_NEED_STREAMING - #define GDISP_NEED_STREAMING FALSE + #define GDISP_NEED_STREAMING GFXOFF #endif /** * @brief Are text functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note You must also define at least one font. */ #ifndef GDISP_NEED_TEXT - #define GDISP_NEED_TEXT FALSE + #define GDISP_NEED_TEXT GFXOFF #endif /** * @brief Are circle functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note Uses integer algorithms only. It does not use any trig or floating point. */ #ifndef GDISP_NEED_CIRCLE - #define GDISP_NEED_CIRCLE FALSE + #define GDISP_NEED_CIRCLE GFXOFF #endif /** * @brief Are dual circle functions needed (one circle inside another). - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note Uses integer algorithms only. It does not use any trig or floating point. */ #ifndef GDISP_NEED_DUALCIRCLE - #define GDISP_NEED_DUALCIRCLE FALSE + #define GDISP_NEED_DUALCIRCLE GFXOFF #endif /** * @brief Are ellipse functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note Uses integer algorithms only. It does not use any trig or floating point. */ #ifndef GDISP_NEED_ELLIPSE - #define GDISP_NEED_ELLIPSE FALSE + #define GDISP_NEED_ELLIPSE GFXOFF #endif /** * @brief Are arc sector functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note Uses integer algorithms only. It does not use any trig or floating point. */ #ifndef GDISP_NEED_ARCSECTORS - #define GDISP_NEED_ARCSECTORS FALSE + #define GDISP_NEED_ARCSECTORS GFXOFF #endif /** * @brief Are arc functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note This can be compiled using fully integer mathematics by - * defining GFX_USE_GMISC and GMISC_NEED_FIXEDTRIG as TRUE. + * defining GFX_USE_GMISC and GMISC_NEED_FIXEDTRIG as GFXON. * @note This can be compiled to use floating point but no trig functions - * by defining GFX_USE_GMISC and GMISC_NEED_FASTTRIG as TRUE. + * by defining GFX_USE_GMISC and GMISC_NEED_FASTTRIG as GFXON. * @note If neither of the above are defined it requires the maths library * to be included in the link to provide floating point and trig support. * ie include -lm in your compiler flags. */ #ifndef GDISP_NEED_ARC - #define GDISP_NEED_ARC FALSE + #define GDISP_NEED_ARC GFXOFF #endif /** * @brief Are convex polygon functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note Convex polygons are those that have no internal angles. That is; * you can draw a line from any point on the polygon to any other point * on the polygon without it going outside the polygon. */ #ifndef GDISP_NEED_CONVEX_POLYGON - #define GDISP_NEED_CONVEX_POLYGON FALSE + #define GDISP_NEED_CONVEX_POLYGON GFXOFF #endif /** * @brief Are scrolling functions needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note This function must be supported by the low level GDISP driver * you have included in your project. If it isn't, defining this * option will cause a compile error. */ #ifndef GDISP_NEED_SCROLL - #define GDISP_NEED_SCROLL FALSE + #define GDISP_NEED_SCROLL GFXOFF #endif /** * @brief Is the capability to read pixels back needed. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note This function must be supported by the low level GDISP driver * you have included in your project. If it isn't, defining this * option will cause a compile error. */ #ifndef GDISP_NEED_PIXELREAD - #define GDISP_NEED_PIXELREAD FALSE + #define GDISP_NEED_PIXELREAD GFXOFF #endif /** * @brief Control some aspect of the hardware operation. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note This allows control of hardware specific features such as * screen rotation, backlight levels, contrast etc */ #ifndef GDISP_NEED_CONTROL - #define GDISP_NEED_CONTROL FALSE + #define GDISP_NEED_CONTROL GFXOFF #endif /** * @brief Query some aspect of the hardware operation. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note This allows query of hardware specific features */ #ifndef GDISP_NEED_QUERY - #define GDISP_NEED_QUERY FALSE + #define GDISP_NEED_QUERY GFXOFF #endif /** * @brief Is the image interface required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE - #define GDISP_NEED_IMAGE FALSE + #define GDISP_NEED_IMAGE GFXOFF #endif /** * @brief Is the image interface required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_PIXMAP - #define GDISP_NEED_PIXMAP FALSE + #define GDISP_NEED_PIXMAP GFXOFF #endif /** * @} @@ -200,10 +200,10 @@ */ /** * @brief Do the drawing functions need to be thread-safe. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_MULTITHREAD - #define GDISP_NEED_MULTITHREAD FALSE + #define GDISP_NEED_MULTITHREAD GFXOFF #endif /** * @} @@ -214,10 +214,10 @@ /** * @brief Should the startup logo be displayed * - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_STARTUP_LOGO - #define GDISP_NEED_STARTUP_LOGO TRUE + #define GDISP_NEED_STARTUP_LOGO GFXON #endif /** * @brief Define the initial background color for all displays in the system. @@ -270,8 +270,8 @@ * @note The same driver can occur more than once in the list to create an extra instance of that driver. * @note If defining this you must also define GDISP_PIXELFORMAT for your application to use. * Choose a value that is most common accross all your drivers for efficiency. - * @note If using this you may optionally define the GDISP_HARDWARE_xxx values as either TRUE or FALSE. - * Doing this causes GDISP to assume that all (TRUE) or none (FALSE) of the listed drivers have that + * @note If using this you may optionally define the GDISP_HARDWARE_xxx values as either GFXON or GFXOFF. + * Doing this causes GDISP to assume that all (GFXON) or none (GFXOFF) of the listed drivers have that * capability. This can help improve drawing speed and efficiency. */ #define GDISP_DRIVER_LIST GDISPVMT_Win32, GDISPVMT_SSD1963 @@ -280,113 +280,113 @@ * @} * * @name GDISP Image Options - * @pre GDISP_NEED_IMAGE must be TRUE + * @pre GDISP_NEED_IMAGE must be GFXON * @{ */ /** * @brief Is native image decoding required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE_NATIVE - #define GDISP_NEED_IMAGE_NATIVE FALSE + #define GDISP_NEED_IMAGE_NATIVE GFXOFF #endif /** * @brief Is GIF image decoding required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE_GIF - #define GDISP_NEED_IMAGE_GIF FALSE + #define GDISP_NEED_IMAGE_GIF GFXOFF #endif /** * @brief Is BMP image decoding required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE_BMP - #define GDISP_NEED_IMAGE_BMP FALSE + #define GDISP_NEED_IMAGE_BMP GFXOFF #endif /** * @brief Is JPG image decoding required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE_JPG - #define GDISP_NEED_IMAGE_JPG FALSE + #define GDISP_NEED_IMAGE_JPG GFXOFF #endif /** * @brief Is PNG image decoding required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE_PNG - #define GDISP_NEED_IMAGE_PNG FALSE + #define GDISP_NEED_IMAGE_PNG GFXOFF #endif /** * @brief Is memory accounting required during image decoding. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_IMAGE_ACCOUNTING - #define GDISP_NEED_IMAGE_ACCOUNTING FALSE + #define GDISP_NEED_IMAGE_ACCOUNTING GFXOFF #endif /** * @} * * @name GDISP BMP Image Options - * @pre GDISP_NEED_IMAGE and GDISP_NEED_IMAGE_BMP must be TRUE + * @pre GDISP_NEED_IMAGE and GDISP_NEED_IMAGE_BMP must be GFXON * @{ */ /** * @brief Is BMP 1 bit per pixel (monochrome/2 color) image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_1 - #define GDISP_NEED_IMAGE_BMP_1 TRUE + #define GDISP_NEED_IMAGE_BMP_1 GFXON #endif /** * @brief Is BMP 4 bits per pixel (16 color) image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_4 - #define GDISP_NEED_IMAGE_BMP_4 TRUE + #define GDISP_NEED_IMAGE_BMP_4 GFXON #endif /** * @brief Is BMP 4 bits per pixel (16 color) with RLE compression image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_4_RLE - #define GDISP_NEED_IMAGE_BMP_4_RLE TRUE + #define GDISP_NEED_IMAGE_BMP_4_RLE GFXON #endif /** * @brief Is BMP 8 bits per pixel (256 color) image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_8 - #define GDISP_NEED_IMAGE_BMP_8 TRUE + #define GDISP_NEED_IMAGE_BMP_8 GFXON #endif /** * @brief Is BMP 8 bits per pixel (256 color) with RLE compression image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_8_RLE - #define GDISP_NEED_IMAGE_BMP_8_RLE TRUE + #define GDISP_NEED_IMAGE_BMP_8_RLE GFXON #endif /** * @brief Is BMP 16 bits per pixel (65536 color) image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_16 - #define GDISP_NEED_IMAGE_BMP_16 TRUE + #define GDISP_NEED_IMAGE_BMP_16 GFXON #endif /** * @brief Is BMP 24 bits per pixel (true-color) image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_24 - #define GDISP_NEED_IMAGE_BMP_24 TRUE + #define GDISP_NEED_IMAGE_BMP_24 GFXON #endif /** * @brief Is BMP 32 bits per pixel (true-color) image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_BMP_32 - #define GDISP_NEED_IMAGE_BMP_32 TRUE + #define GDISP_NEED_IMAGE_BMP_32 GFXON #endif /** * @brief The BMP blit buffer size. @@ -401,7 +401,7 @@ * @} * * @name GDISP GIF Image Options - * @pre GDISP_NEED_IMAGE and GDISP_NEED_IMAGE_GIF must be TRUE + * @pre GDISP_NEED_IMAGE and GDISP_NEED_IMAGE_GIF must be GFXON * @{ */ /** @@ -416,37 +416,37 @@ * @} * * @name GDISP PNG Image Options - * @pre GDISP_NEED_IMAGE and GDISP_NEED_IMAGE_PNG must be TRUE + * @pre GDISP_NEED_IMAGE and GDISP_NEED_IMAGE_PNG must be GFXON * @{ */ /** * @brief Is PNG Interlaced image decoding required. - * @details Defaults to FALSE + * @details Defaults to GFXOFF * @note Currently not supported due to the complex decoding and display requirements */ #ifndef GDISP_NEED_IMAGE_PNG_INTERLACED - #define GDISP_NEED_IMAGE_PNG_INTERLACED FALSE + #define GDISP_NEED_IMAGE_PNG_INTERLACED GFXOFF #endif /** * @brief Is PNG image transparency processed. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_TRANSPARENCY - #define GDISP_NEED_IMAGE_PNG_TRANSPARENCY TRUE + #define GDISP_NEED_IMAGE_PNG_TRANSPARENCY GFXON #endif /** * @brief Is PNG background data processed. - * @details Defaults to TRUE - * @note If the background is specified in the image file and this define is TRUE, + * @details Defaults to GFXON + * @note If the background is specified in the image file and this define is GFXON, * that background color is used for transparency and alpha blending. */ #ifndef GDISP_NEED_IMAGE_PNG_BACKGROUND - #define GDISP_NEED_IMAGE_PNG_BACKGROUND TRUE + #define GDISP_NEED_IMAGE_PNG_BACKGROUND GFXON #endif /** * @brief What is the cliff between non-blended alpha pixels being displayed or not. * @details Range of 0 to 255 - * @note If GDISP_NEED_IMAGE_PNG_BACKGROUND is TRUE and the PNG file contains a + * @note If GDISP_NEED_IMAGE_PNG_BACKGROUND is GFXON and the PNG file contains a * background color then the pixel will be blended with the background color * according to the alpha. * If not then no blending occurs. The pixel will either be set or not. @@ -458,80 +458,80 @@ #endif /** * @brief Is 1, 2 and 4 bit PNG palettized image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_PALETTE_124 - #define GDISP_NEED_IMAGE_PNG_PALETTE_124 TRUE + #define GDISP_NEED_IMAGE_PNG_PALETTE_124 GFXON #endif /** * @brief Is 8 bit PNG palettized image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_PALETTE_8 - #define GDISP_NEED_IMAGE_PNG_PALETTE_8 TRUE + #define GDISP_NEED_IMAGE_PNG_PALETTE_8 GFXON #endif /** * @brief Is 1,2 and 4 bit PNG grayscale image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_GRAYSCALE_124 - #define GDISP_NEED_IMAGE_PNG_GRAYSCALE_124 TRUE + #define GDISP_NEED_IMAGE_PNG_GRAYSCALE_124 GFXON #endif /** * @brief Is 8 bit PNG grayscale image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_GRAYSCALE_8 - #define GDISP_NEED_IMAGE_PNG_GRAYSCALE_8 TRUE + #define GDISP_NEED_IMAGE_PNG_GRAYSCALE_8 GFXON #endif /** * @brief Is 16 bit PNG grayscale image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_GRAYSCALE_16 - #define GDISP_NEED_IMAGE_PNG_GRAYSCALE_16 TRUE + #define GDISP_NEED_IMAGE_PNG_GRAYSCALE_16 GFXON #endif /** * @brief Is 8 bit PNG grayscale with 8 bit alpha image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_GRAYALPHA_8 - #define GDISP_NEED_IMAGE_PNG_GRAYALPHA_8 TRUE + #define GDISP_NEED_IMAGE_PNG_GRAYALPHA_8 GFXON #endif /** * @brief Is 16 bit PNG grayscale with 16 bit alpha image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_GRAYALPHA_16 - #define GDISP_NEED_IMAGE_PNG_GRAYALPHA_16 TRUE + #define GDISP_NEED_IMAGE_PNG_GRAYALPHA_16 GFXON #endif /** * @brief Is 8/8/8 bit PNG RGB image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_RGB_8 - #define GDISP_NEED_IMAGE_PNG_RGB_8 TRUE + #define GDISP_NEED_IMAGE_PNG_RGB_8 GFXON #endif /** * @brief Is 16/16/16 bit PNG RGB image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_RGB_16 - #define GDISP_NEED_IMAGE_PNG_RGB_16 TRUE + #define GDISP_NEED_IMAGE_PNG_RGB_16 GFXON #endif /** * @brief Is 8/8/8 bit PNG RGB with 8 bit alpha image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_RGBALPHA_8 - #define GDISP_NEED_IMAGE_PNG_RGBALPHA_8 TRUE + #define GDISP_NEED_IMAGE_PNG_RGBALPHA_8 GFXON #endif /** * @brief Is 16/16/16 bit PNG RGB with 16 bit alpha image decoding required. - * @details Defaults to TRUE + * @details Defaults to GFXON */ #ifndef GDISP_NEED_IMAGE_PNG_RGBALPHA_16 - #define GDISP_NEED_IMAGE_PNG_RGBALPHA_16 TRUE + #define GDISP_NEED_IMAGE_PNG_RGBALPHA_16 GFXON #endif /** * @brief The PNG blit buffer size in pixels. @@ -569,10 +569,10 @@ /** * @brief Enable advanced word-wrapping. * @details Only has an effect with @p gdispGDrawStringBox() and @p gdispGFillStringBox() - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_TEXT_WORDWRAP - #define GDISP_NEED_TEXT_WORDWRAP FALSE + #define GDISP_NEED_TEXT_WORDWRAP GFXOFF #endif /** * @brief Adding pixels to the left and right side of the box to pad text. @@ -594,24 +594,24 @@ #endif /** * @brief Enable UTF-8 support for text rendering. - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_UTF8 - #define GDISP_NEED_UTF8 FALSE + #define GDISP_NEED_UTF8 GFXOFF #endif /** * @brief Enable kerning for font rendering (improves character placement). - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_TEXT_KERNING - #define GDISP_NEED_TEXT_KERNING FALSE + #define GDISP_NEED_TEXT_KERNING GFXOFF #endif /** * @brief Enable antialiased font support - * @details Defaults to FALSE + * @details Defaults to GFXOFF */ #ifndef GDISP_NEED_ANTIALIAS - #define GDISP_NEED_ANTIALIAS FALSE + #define GDISP_NEED_ANTIALIAS GFXOFF #endif /** * @} @@ -620,7 +620,7 @@ * @{ */ #ifndef GDISP_NEED_PIXMAP_IMAGE - #define GDISP_NEED_PIXMAP_IMAGE FALSE + #define GDISP_NEED_PIXMAP_IMAGE GFXOFF #endif /** * @} |