gfx.h

Go to the documentation of this file.

#ifndef GFX_GFX_H
#define GFX_GFX_H

#include "cfg/cfg_gfx.h"    /* CONFIG_GFX_* */
#include <cfg/compiler.h>

#include <cpu/attr.h>       /* CPU_HARVARD */


#define CONFIG_CHART_TYPE_X uint8_t ///< Type for the chart dataset
#define CONFIG_CHART_TYPE_Y uint8_t ///< Type for the chart dataset

#define BITMAP_FMT_PLANAR_H_MSB  1  
#define BITMAP_FMT_PLANAR_V_LSB  2  
/* \} */

#if !defined(CONFIG_BITMAP_FMT) || (CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_H_MSB && CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_V_LSB)
    #error CONFIG_BITMAP_FMT must be defined to either BITMAP_FMT_PLANAR_H_LSB or BITMAP_FMT_PLANAR_V_LSB
#endif
#if !defined(CONFIG_GFX_CLIPPING) || (CONFIG_GFX_CLIPPING != 0 && CONFIG_GFX_CLIPPING != 1)
    #error CONFIG_GFX_CLIPPING must be defined to either 0 or 1
#endif
#if !defined(CONFIG_GFX_TEXT) || (CONFIG_GFX_TEXT != 0 && CONFIG_GFX_TEXT != 1)
    #error CONFIG_GFX_TEXT must be defined to either 0 or 1
#endif

EXTERN_C_BEGIN

typedef int coord_t;
typedef unsigned int ucoord_t;

#if CONFIG_GFX_VCOORDS

typedef float vcoord_t;
#endif /* CONFIG_GFX_VCOORDS */


typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;

#define RECT_WIDTH(r)   ((r)->xmax - (r)->xmin)

#define RECT_HEIGHT(r)  ((r)->ymax - (r)->ymin)

/* Fwd decl */
struct Font;

typedef struct Bitmap
{
    uint8_t *raster;        
    coord_t width, height;  
    coord_t stride;         
    coord_t penX, penY;     
#if CONFIG_GFX_CLIPPING || CONFIG_GFX_VCOORDS
    Rect cr;                
#endif

#if CONFIG_GFX_TEXT
    const struct Font *font;
    uint8_t styles;
#endif /* CONFIG_GFX_TEXT */

#if CONFIG_GFX_VCOORDS

    vcoord_t orgX, orgY;
    vcoord_t scaleX, scaleY;
    /*\}*/
#endif /* CONFIG_GFX_VCOORDS */

} Bitmap;

typedef struct Image
{
    const uint8_t *raster;   
    coord_t width;     
    coord_t height;    
    coord_t stride;    
} Image;

#if CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_H_MSB

    #define RAST_SIZE(width, height) ( (((width) + 7) / 8) * (height) )

#elif CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_V_LSB

    #define RAST_SIZE(width, height) ( (width) * (((height) + 7) / 8) )
#else
    #error Unknown value of CONFIG_BITMAP_FMT
#endif /* CONFIG_BITMAP_FMT */

/* Function prototypes */
void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
void gfx_bitmapClear(Bitmap *bm);
void gfx_blit       (Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy);
void gfx_blitRaster (Bitmap *dst, coord_t dx, coord_t dy, const uint8_t *raster, coord_t w, coord_t h, coord_t stride);
void gfx_blitImage  (Bitmap *dst, coord_t dx, coord_t dy, const Image *image);
void gfx_line       (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
void gfx_rectDraw   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
void gfx_rectFillC  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2, uint8_t color);
void gfx_rectFill   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
void gfx_rectClear  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
void gfx_moveTo     (Bitmap *bm, coord_t x,  coord_t y);
void gfx_lineTo     (Bitmap *bm, coord_t x,  coord_t y);
void gfx_setClipRect(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);

#if CPU_HARVARD
    #include <cpu/pgm.h>
    void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster);
#endif

#if CONFIG_GFX_TEXT
INLINE void gfx_setFont(Bitmap *bm, const struct Font *font)
{
    bm->font = font;
}
#endif

#if CONFIG_GFX_VCOORDS
void gfx_setViewRect(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
coord_t gfx_transformX(Bitmap *bm, vcoord_t x);
coord_t gfx_transformY(Bitmap *bm, vcoord_t y);
void gfx_vline(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
#endif /* CONFIG_GFX_VCOORDS */

EXTERN_C_END

#endif /* GFX_GFX_H */