1 /* 2 * Common image-related functions. 3 * 4 * Copyright (C) 2018 Paul Boddie <paul@boddie.org.uk> 5 * 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation, either version 3 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program. If not, see <http://www.gnu.org/licenses/>. 18 */ 19 20 #ifndef __IMAGE_H__ 21 #define __IMAGE_H__ 22 23 #include <stdint.h> 24 25 26 27 /* Image data type. */ 28 29 typedef struct 30 { 31 /* Image width and height. */ 32 33 uint32_t width, height; 34 35 /* Image data. */ 36 37 uint8_t image[]; 38 39 } image_t; 40 41 42 43 /* Stored display regions. */ 44 45 typedef struct 46 { 47 /* Position of the stored region on the screen. */ 48 49 int x, y; 50 51 } position_t; 52 53 typedef struct 54 { 55 /* Stored region overplotted by the sprite. */ 56 57 uint8_t *image; 58 uint32_t size; 59 60 /* Number of stored frames. */ 61 62 int stored; 63 64 } stored_regions_t; 65 66 67 68 /* A simple sprite abstraction. */ 69 70 typedef struct 71 { 72 /* The sprite image. */ 73 74 image_t *image; 75 76 /* The stored regions to be used to unplot the sprite. */ 77 78 stored_regions_t *regions; 79 80 /* Sprite frame positions. */ 81 82 position_t *pos; 83 84 /* The vertical scaling factor translating display rows to image 85 coordinates. */ 86 87 int yscale; 88 89 /* The display associated with the sprite. */ 90 91 display_config_t *cfg; 92 93 } sprite_t; 94 95 96 97 /* Initialise stored regions, allocating memory and a structure to access it. 98 99 Stored_Regions(<name>, int frames, int size) 100 */ 101 102 #define Stored_Regions(NAME, FRAMES, SIZE) \ 103 uint8_t __##NAME##_image[(FRAMES) * (SIZE)]; \ 104 stored_regions_t NAME = { \ 105 .image=__##NAME##_image, \ 106 .size=SIZE, \ 107 .stored=0}; 108 109 /* Access functions. */ 110 111 position_t *image_get_stored_position(sprite_t *s, int frame); 112 113 uint8_t *image_get_stored_region(stored_regions_t *r, int frame); 114 115 116 117 /* Initialise a sprite object using an existing image without the capability of 118 storing regions of the screen. 119 120 SpriteOverwriting(<name>, image_t *image, display_config_t *cfg, int frames, int yscale) 121 */ 122 123 #define SpriteOverwriting(NAME, IMAGE, CFG, FRAMES, YSCALE) \ 124 position_t __##NAME##_pos[FRAMES]; \ 125 sprite_t NAME = { \ 126 .image=IMAGE, \ 127 .regions=0, \ 128 .yscale=YSCALE, \ 129 .cfg=CFG, \ 130 .pos=__##NAME##_pos}; 131 132 /* Initialise a sprite object using an existing image, creating stored regions 133 for the animation of the sprite. 134 135 Sprite(<name>, image_t *image, display_config_t *cfg, int frames, int yscale) 136 */ 137 138 #define Sprite(NAME, IMAGE, CFG, FRAMES, YSCALE) \ 139 Stored_Regions(__##NAME##_regions, FRAMES, \ 140 (IMAGE)->width * (IMAGE)->height * (YSCALE)); \ 141 position_t __##NAME##_pos[FRAMES]; \ 142 sprite_t NAME = { \ 143 .image=IMAGE, \ 144 .regions=&(__##NAME##_regions), \ 145 .yscale=YSCALE, \ 146 .cfg=CFG, \ 147 .pos=__##NAME##_pos}; 148 149 /* Sprite plotting operations. */ 150 151 void image_plot_sprite(sprite_t *s, int x, int y, int key); 152 153 void image_unplot_sprite(sprite_t *s); 154 155 /* Convenience operations. */ 156 157 void image_plot_sprite_section(sprite_t *s, 158 int xstart, int ystart, int xsize, int ysize, 159 int x, int y, int key); 160 161 void image_tile_sprite(sprite_t *s, int xsource, int ysource, 162 int width, int height, 163 int xdisplay, int ydisplay); 164 165 void image_update_scrolled_tiled_image(sprite_t *s, int xorigin, int yorigin, 166 int xstep, int ystep); 167 168 #endif /* __IMAGE_H__ */