gfx_draw.h

Go to the documentation of this file.

 
#ifndef __GFX_DRAW_H__
#define __GFX_DRAW_H__
#include "EmulatorConfig.h"
 
#ifndef WINDOW_TITLE
#define WINDOW_TITLE "FreeRTOS Emulator"
#endif //WINDOW_TITLE
 
#ifndef SCREEN_WIDTH
#define SCREEN_WIDTH 640
#endif //SCREEN_WIDTH
 
#ifndef SCREEN_HEIGHT
#define SCREEN_HEIGHT 480
#endif //SCREEN_HEIGHT
 
#define TUMBlue (unsigned int)(0x0065bd)
#define Red (unsigned int)(0xFF0000)
#define Green (unsigned int)(0x00FF00)
#define Blue (unsigned int)(0x0000FF)
#define Yellow (unsigned int)(0xFFFF00)
#define Aqua (unsigned int)(0x00FFFF)
#define Fuchsia (unsigned int)(0xFF00FF)
#define White (unsigned int)(0xFFFFFF)
#define Black (unsigned int)(0x000000)
#define Gray (unsigned int)(0x808080)
#define Grey Gray
#define Magenta Fuchsia
#define Cyan Aqua
#define Lime (unsigned int)(0x00FF00)
#define Maroon (unsigned int)(0x800000)
#define Navy (unsigned int)(0x000080)
#define Olive (unsigned int)(0x808000)
#define Purple (unsigned int)(0x800080)
#define Silver (unsigned int)(0xC0C0C0)
#define Teal (unsigned int)(0x008080)
#define Orange (unsigned int)(0xFFA500)
#define Pink (unsigned int)(0xFFC0CB)
#define Skyblue (unsigned int)(0x87CEEB)
enum sprite_sequence_direction {
    SPRITE_SEQUENCE_HORIZONTAL_POS,
    SPRITE_SEQUENCE_HORIZONTAL_NEG,
    SPRITE_SEQUENCE_VERTICAL_POS,
    SPRITE_SEQUENCE_VERTICAL_NEG,
};
 
typedef struct coord {
    signed short x; 
    signed short y; 
} coord_t;
 
typedef void *gfx_image_handle_t;
 
typedef void *gfx_animation_handle_t;
 
typedef void *gfx_sequence_handle_t;
 
typedef void *gfx_spritesheet_handle_t;
 
char *gfxGetErrorMessage(void);
 
int gfxDrawInit(char *path);
 
int gfxDrawBindThread(void);
 
void gfxDrawExit(void);
 
int gfxDrawUpdateScreen(void);
 
int gfxDrawClear(unsigned int colour);
 
/*
 * @brief Copies a screenshot of the current frame to the next frame
 *
 * Experimental, performance can not be guarenteed.
 */
void gfxDrawDuplicateBuffer(void);
 
int gfxDrawEllipse(signed short x, signed short y, signed short rx,
                   signed short ry, unsigned int colour);
 
int gfxDrawArc(signed short x, signed short y, signed short radius,
               signed short start, signed short end, unsigned int colour);
 
int gfxDrawText(char *str, signed short x, signed short y, unsigned int colour);
 
int gfxGetTextSize(char *str, int *width, int *height);
 
int gfxDrawCenteredText(char *str, signed short x, signed short y,
                        unsigned int colour);
 
int gfxDrawBox(signed short x, signed short y, signed short w, signed short h,
               unsigned int colour);
 
int gfxDrawFilledBox(signed short x, signed short y, signed short w,
                     signed short h, unsigned int colour);
 
int gfxDrawCircle(signed short x, signed short y, signed short radius,
                  unsigned int colour);
 
int gfxDrawLine(signed short x1, signed short y1, signed short x2,
                signed short y2, unsigned char thickness, unsigned int colour);
 
int gfxDrawPoly(coord_t *points, int n, unsigned int colour);
 
int gfxDrawTriangle(coord_t *points, unsigned int colour);
 
gfx_image_handle_t gfxDrawLoadImage(char *filename);
 
gfx_image_handle_t gfxDrawLoadScaledImage(char *filename, float scale);
 
int gfxDrawFreeLoadedImage(gfx_image_handle_t *img);
 
int gfxDrawSetLoadedImageScale(gfx_image_handle_t img, float scale);
 
float gfxDrawGetLoadedImageScale(gfx_image_handle_t img);
 
int gfxDrawGetLoadedImageWidth(gfx_image_handle_t img);
 
int gfxDrawGetLoadedImageHeight(gfx_image_handle_t img);
 
int gfxDrawGetLoadedImageSize(gfx_image_handle_t img, int *w, int *h);
 
int gfxDrawLoadedImage(gfx_image_handle_t img, signed short x, signed short y);
 
int gfxDrawImage(char *filename, signed short x, signed short y);
 
gfx_spritesheet_handle_t gfxDrawLoadSpritesheetFromEntireImageUnpadded(
    gfx_image_handle_t img, unsigned sprite_cols, unsigned sprite_rows);
 
gfx_spritesheet_handle_t gfxDrawLoadSpritesheetFromEntireImagePadded(
    gfx_image_handle_t img, unsigned sprite_cols, unsigned sprite_rows,
    unsigned sprite_padding_x, unsigned sprite_padding_y);
 
gfx_spritesheet_handle_t gfxDrawLoadSpritesheetFromEntireImagePaddedSpacing(
    gfx_image_handle_t img, unsigned sprite_cols, unsigned sprite_rows,
    unsigned sprite_spacing_x, unsigned sprite_spacing_y);
 
gfx_spritesheet_handle_t gfxDrawLoadSpritesheetFromPortionOfImageUnpadded(
    gfx_image_handle_t img, unsigned sprite_cols, unsigned sprite_rows,
    unsigned sprite_width, unsigned sprite_height,
    unsigned bounding_box_left_x_pixel, unsigned bounding_box_top_y_pixel);
 
gfx_spritesheet_handle_t gfxDrawLoadSpritesheetFromPortionOfImagePadded(
    gfx_image_handle_t img, unsigned sprite_cols, unsigned sprite_rows,
    unsigned sprite_width, unsigned sprite_height,
    unsigned sprite_padding_x, unsigned sprite_padding_y,
    unsigned bounding_box_left_x_pixel, unsigned bounding_box_top_y_pixel);
 
gfx_spritesheet_handle_t gfxDrawLoadSpritesheetFromPortionOfImagePaddedSpacing(
    gfx_image_handle_t img, unsigned sprite_cols, unsigned sprite_rows,
    unsigned sprite_width, unsigned sprite_height,
    unsigned sprite_spacing_x, unsigned sprite_spacing_y,
    unsigned bounding_box_left_x_pixel, unsigned bounding_box_top_y_pixel);
 
int gfxDrawSprite(gfx_spritesheet_handle_t spritesheet, char column, char row,
                  signed short x, signed short y);
 
int gfxGetImageSize(char *filename, int *w, int *h);
 
int gfxDrawScaledImage(char *filename, signed short x, signed short y,
                       float scale);
 
int gfxDrawArrow(signed short x1, signed short y1, signed short x2,
                 signed short y2, signed short head_length,
                 unsigned char thickness, unsigned int colour);
 
gfx_animation_handle_t
gfxDrawAnimationCreate(gfx_spritesheet_handle_t spritesheet);
 
int gfxDrawAnimationAddSequence(
    gfx_animation_handle_t animation, char *name, unsigned start_row,
    unsigned start_col,
    enum sprite_sequence_direction sprite_step_direction, unsigned frames);
 
gfx_sequence_handle_t
gfxDrawAnimationSequenceInstantiate(gfx_animation_handle_t animation,
                                    char *sequence_name,
                                    unsigned frame_period_ms);
 
void gfxDrawAnimationReset(gfx_sequence_handle_t sequence);
 
int gfxDrawAnimationDrawFrame(gfx_sequence_handle_t sequence,
                              unsigned ms_timestep, int x, int y);
 
int gfxDrawSetGlobalXOffset(int offset);
 
int gfxDrawSetGlobalYOffset(int offset);
 
int gfxDrawGetGlobalXOffset(int *offset);
 
int gfxDrawGetGlobalYOffset(int *offset);
 
#endif