modules/cldc-compact/src/main/java/cc/squirreljme/jvm/Framebuffer.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.jvm;
  11
  12 /**
  13  * This is used to get/set the property of the framebuffer.
  14  *
  15  * @since 2019/06/20
  16  */
  17 public interface Framebuffer
  18 {
  19         /**
  20          * Returns the address of the framebuffer.
  21          *
  22          * @squirreljme.syscallreturn The framebuffer address.
  23          */
  24         byte CONTROL_ADDRESS =
  25                 1;
  26
  27         /**
  28          * Returns the width of the framebuffer.
  29          *
  30          * @squirreljme.syscallreturn The framebuffer width.
  31          */
  32         byte CONTROL_WIDTH =
  33                 2;
  34
  35         /**
  36          * Returns the height of the framebuffer.
  37          *
  38          * @squirreljme.syscallreturn The framebuffer height.
  39          */
  40         byte CONTROL_HEIGHT =
  41                 3;
  42
  43         /**
  44          * Returns the scanline length.
  45          *
  46          * @squirreljme.syscallreturn The framebuffer scanline length.
  47          */
  48         byte CONTROL_SCANLEN =
  49                 4;
  50
  51         /**
  52          * Flush the display because it has been drawn.
  53          */
  54         byte CONTROL_FLUSH =
  55                 5;
  56
  57         /**
  58          * Returns the pixel format of the screen.
  59          *
  60          * @squirreljme.syscallreturn The pixel format of the screen.
  61          */
  62         byte CONTROL_FORMAT =
  63                 6;
  64
  65         /**
  66          * Returns the scanline length in bytes.
  67          *
  68          * @squirreljme.syscallreturn The scanline length in bytes.
  69          */
  70         byte CONTROL_SCANLEN_BYTES =
  71                 7;
  72
  73         /**
  74          * Returns the number of bytes per pixel.
  75          *
  76          * @squirreljme.syscallreturn The bytes per pixel.
  77          */
  78         byte CONTROL_BYTES_PER_PIXEL =
  79                 8;
  80
  81         /**
  82          * Returns the number of available pixels.
  83          *
  84          * @squirreljme.syscallreturn The number of pixels.
  85          */
  86         byte CONTROL_NUM_PIXELS =
  87                 9;
  88
  89         /**
  90          * Bits per pixel.
  91          *
  92          * @squirreljme.syscallreturn The bits per pixel.
  93          */
  94         byte CONTROL_BITS_PER_PIXEL =
  95                 10;
  96
  97         /**
  98          * Get backlight level.
  99          *
 100          * @squirreljme.syscallreturn The current backlight level.
 101          */
 102         byte CONTROL_BACKLIGHT_LEVEL_GET =
 103                 11;
 104
 105         /**
 106          * Set backlight level.
 107          *
 108          * @squirreljme.syscallparam 1 The level to set.
 109          */
 110         byte CONTROL_BACKLIGHT_LEVEL_SET =
 111                 12;
 112
 113         /**
 114          * Maximum backlight level.
 115          *
 116          * @squirreljme.syscallreturn The maximum backlight level.
 117          */
 118         byte CONTROL_BACKLIGHT_LEVEL_MAX =
 119                 13;
 120
 121         /**
 122          * Uploads an integer array of pixel data to the framebuffer.
 123          *
 124          * @squirreljme.syscallparam 1 The address of the array to upload.
 125          * @since 2019/12/21
 126          */
 127         byte CONTROL_UPLOAD_ARRAY_INT =
 128                 14;
 129
 130         /**
 131          * The array which backs the framebuffer, if there is one.
 132          *
 133          * @squirreljme.syscallreturn The backing array object, if there is one.
 134          * @since 2019/12/28
 135          */
 136         byte CONTROL_BACKING_ARRAY_OBJECT =
 137                 15;
 138
 139         /**
 140          * Returns the capabilities of the display.
 141          *
 142          * @squirreljme.syscallreturn The display capabilities.
 143          * @since 2020/01/10
 144          */
 145         byte CONTROL_GET_CAPABILITIES =
 146                 16;
 147
 148         /**
 149          * Query acceleration function.
 150          *
 151          * @squirreljme.syscallparam 1 The graphics function.
 152          * @squirreljme.syscallreturn A non-zero value if this is supported.
 153          * @since 2020/01/10
 154          */
 155         byte CONTROL_ACCEL_FUNC_QUERY =
 156                 17;
 157
 158         /**
 159          * Perform acceleration function.
 160          *
 161          * @squirreljme.syscallparam 1 The graphics function.
 162          * @squirreljme.syscallparam ... Parameters to the function.
 163          * @squirreljme.syscallreturn A value that is according to the invoked
 164          * function, if it is supported or possible.
 165          * @since 2020/01/10
 166          */
 167         byte CONTROL_ACCEL_FUNC_INVOKE =
 168                 18;
 169
 170         /**
 171          * Requests that the framebuffer be repainted.
 172          *
 173          * @squirreljme.syscallparam 1 The X coordinate.
 174          * @squirreljme.syscallparam 2 The Y coordinate.
 175          * @squirreljme.syscallparam 3 The width.
 176          * @squirreljme.syscallparam 4 The height.
 177          * @squirreljme.syscallreturn Returns {@code 0} if the repaint was not
 178          * queued and it must be handled by the code running the application,
 179          * @since 2020/01/15
 180          */
 181         byte CONTROL_REPAINT_REQUEST =
 182                 19;
 183
 184         /**
 185          * Sets the title of the framebuffer if applicable.
 186          *
 187          * @squirreljme.syscallparam 1 Char buffer pointer (high).
 188          * @squirreljme.syscallparam 2 Char buffer pointer (low).
 189          * @since 2020/01/15
 190          */
 191         byte CONTROL_SET_TITLE =
 192                 20;
 193
 194         /** The number of framebuffer controls. */
 195         byte NUM_CONTROLS =
 196                 21;
 197
 198         /** Screen is RGB 32-bit. */
 199         byte FORMAT_INTEGER_RGB888 =
 200                 0;
 201
 202         /** Screen is 8-bit indexed. */
 203         byte FORMAT_BYTE_INDEXED =
 204                 1;
 205
 206         /** Screen is 16-bit RGB565. */
 207         byte FORMAT_SHORT_RGB565 =
 208                 2;
 209
 210         /** Screen is packed 1 bit values. */
 211         byte FORMAT_PACKED_ONE =
 212                 3;
 213
 214         /** Screen is packed 2 bit values. */
 215         byte FORMAT_PACKED_TWO =
 216                 4;
 217
 218         /** Screen is packed 4 bit values. */
 219         byte FORMAT_PACKED_FOUR =
 220                 5;
 221
 222         /** Has touch-screen. */
 223         byte CAPABILITY_TOUCH =
 224                 0x01;
 225
 226         /** Has keyboard. */
 227         byte CAPABILITY_KEYBOARD =
 228                 0x02;
 229
 230         /** The JVM pushes to the IPC handler when events happen. */
 231         byte CAPABILITY_IPC_EVENTS =
 232                 0x04;
 233
 234         /** Has screen flipping? */
 235         byte CAPABILITY_SCREEN_FLIP =
 236                 0x08;
 237
 238         /** Screen has color that is not just a single shade. */
 239         byte CAPABILITY_COLOR =
 240                 0x10;
 241
 242         /** Set color. */
 243         byte ACCEL_FUNC_SET_COLOR =
 244                 0;
 245
 246         /** Draw line. */
 247         byte ACCEL_FUNC_DRAW_LINE =
 248                 1;
 249
 250         /** Get the X clip. */
 251         byte ACCEL_FUNC_GET_CLIP_X =
 252                 2;
 253
 254         /** Get the Y clip. */
 255         byte ACCEL_FUNC_GET_CLIP_Y =
 256                 3;
 257
 258         /** Get the width clip. */
 259         byte ACCEL_FUNC_GET_CLIP_WIDTH =
 260                 4;
 261
 262         /** Get the height clip. */
 263         byte ACCEL_FUNC_GET_CLIP_HEIGHT =
 264                 5;
 265
 266         /** Set the clip. */
 267         byte ACCEL_FUNC_SET_CLIP =
 268                 6;
 269
 270         /** Draw rectangle. */
 271         byte ACCEL_FUNC_DRAW_RECT =
 272                 7;
 273
 274         /** Get the alpha color. */
 275         byte ACCEL_FUNC_GET_ALPHA_COLOR =
 276                 8;
 277
 278         /** Set the alpha color. */
 279         byte ACCEL_FUNC_SET_ALPHA_COLOR =
 280                 9;
 281
 282         /** Fill rectangle. */
 283         byte ACCEL_FUNC_FILL_RECT =
 284                 10;
 285
 286         /** Sets the fonts for the graphics. */
 287         byte ACCEL_FUNC_SET_FONT =
 288                 11;
 289
 290         /** Gets the font to use for drawing. */
 291         byte ACCEL_FUNC_GET_FONT =
 292                 12;
 293
 294         /** Draw sub-characters. */
 295         byte ACCEL_FUNC_DRAW_SUB_CHARS =
 296                 13;
 297
 298         /** Draw text. */
 299         byte ACCEL_FUNC_DRAW_TEXT =
 300                 14;
 301
 302         /** Get stroke style. */
 303         byte ACCEL_FUNC_GET_STROKE_STYLE =
 304                 15;
 305
 306         /** Set stroke style. */
 307         byte ACCEL_FUNC_SET_STROKE_STYLE =
 308                 16;
 309
 310         /** Copy area. */
 311         byte ACCEL_FUNC_COPY_AREA =
 312                 17;
 313
 314         /** Draw arc. */
 315         byte ACCEL_FUNC_DRAW_ARC =
 316                 18;
 317
 318         /** Draw ARGB16. */
 319         byte ACCEL_FUNC_DRAW_ARGB16 =
 320                 19;
 321
 322         /** Draw character. */
 323         byte ACCEL_FUNC_DRAW_CHAR =
 324                 20;
 325
 326         /** Draw characters. */
 327         byte ACCEL_FUNC_DRAW_CHARS =
 328                 21;
 329
 330         /** Draw RGB. */
 331         byte ACCEL_FUNC_DRAW_RGB =
 332                 22;
 333
 334         /** Draw RGB16. */
 335         byte ACCEL_FUNC_DRAW_RGB16 =
 336                 23;
 337
 338         /** Draw round rectangle. */
 339         byte ACCEL_FUNC_DRAW_ROUND_RECT =
 340                 24;
 341
 342         /** Fill arc. */
 343         byte ACCEL_FUNC_FILL_ARC =
 344                 25;
 345
 346         /** Fill round rectangle. */
 347         byte ACCEL_FUNC_FILL_ROUND_RECT =
 348                 26;
 349
 350         /** Fill triangle. */
 351         byte ACCEL_FUNC_FILL_TRIANGLE =
 352                 27;
 353
 354         /** Get blending mode. */
 355         byte ACCEL_FUNC_GET_BLENDING_MODE =
 356                 28;
 357
 358         /** Get display color. */
 359         byte ACCEL_FUNC_GET_DISPLAY_COLOR =
 360                 29;
 361
 362         /** Set blending mode. */
 363         byte ACCEL_FUNC_SET_BLENDING_MODE =
 364                 30;
 365
 366         /** Draw region. */
 367         byte ACCEL_FUNC_DRAW_REGION =
 368                 31;
 369
 370         /** Number of acceleration functions. */
 371         byte NUM_ACCEL_FUNC =
 372                 32;
 373
 374         /** The IPC ID for the graphics callbacks. */
 375         int IPC_ID =
 376                 0x47665821;
 377 }
 378