nanocoat/include/lib/scritchui/framebuffer/fbIntern.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * Internal framebuffer functions.
  12  *
  13  * @since 2024/07/24
  14  */
  15
  16 #ifndef SQUIRRELJME_FBINTERN_H
  17 #define SQUIRRELJME_FBINTERN_H
  18
  19 #include "lib/scritchui/framebuffer/fb.h"
  20 #include "lib/scritchui/scritchui.h"
  21
  22 /* Anti-C++. */
  23 #ifdef __cplusplus
  24         #ifndef SJME_CXX_IS_EXTERNED
  25                 #define SJME_CXX_IS_EXTERNED
  26                 #define SJME_CXX_SQUIRRELJME_FBINTERN_H
  27 extern "C"
  28 {
  29         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  30 #endif /* #ifdef __cplusplus */
  31
  32 /*--------------------------------------------------------------------------*/
  33
  34 /**
  35  * Callback for when an item has been activated.
  36  *
  37  * @param inState The input state.
  38  * @param inComponent The input component.
  39  * @return On any resultant error, if any.
  40  * @since 2024/07/27
  41  */
  42 typedef sjme_errorCode (*sjme_scritchui_fb_lightActivateListenerFunc)(
  43         sjme_attrInNotNull sjme_scritchui inState,
  44         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent);
  45
  46 /**
  47  * Callback for when a lightweight component is clicked.
  48  *
  49  * @param inState The input state.
  50  * @param inComponent The input component.
  51  * @param selectionId The selection Id.
  52  * @param atX The X coordinate.
  53  * @param atY The Y coordinate.
  54  * @return On any resultant error, if any.
  55  * @since 2024/07/27
  56  */
  57 typedef sjme_errorCode (*sjme_scritchui_fb_lightClickListenerFunc)(
  58         sjme_attrInNotNull sjme_scritchui inState,
  59         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
  60         sjme_attrInValue sjme_jint selectionId,
  61         sjme_attrInValue sjme_jint atX,
  62         sjme_attrInValue sjme_jint atY);
  63
  64 /**
  65  * Callback for when there is cursor movement requested.
  66  *
  67  * @param inState The input state.
  68  * @param inComponent The input component.
  69  * @param moveX The X coordinate.
  70  * @param moveY The Y coordinate.
  71  * @return On any resultant error, if any.
  72  * @since 2024/07/27
  73  */
  74 typedef sjme_errorCode (*sjme_scritchui_fb_lightCursorListenerFunc)(
  75         sjme_attrInNotNull sjme_scritchui inState,
  76         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
  77         sjme_attrInValue sjme_jint moveX,
  78         sjme_attrInValue sjme_jint moveY);
  79
  80 /** Hover listener, same parameters as click. */
  81 typedef sjme_scritchui_fb_lightClickListenerFunc
  82         sjme_scritchui_fb_lightHoverListenerFunc;
  83
  84 /** Selection listener is the same as activate. */
  85 typedef sjme_scritchui_fb_lightActivateListenerFunc
  86         sjme_scritchui_fb_lightSelectListenerFunc;
  87
  88 /**
  89  * Widget state and interactions accordingly.
  90  *
  91  * @since 2024/07/26
  92  */
  93 typedef struct sjme_scritchui_fb_widgetState
  94 {
  95         /** The currently focused sub-item. */
  96         sjme_jint subFocusIndex;
  97
  98         /** Selection buffer, for pointer interaction. */
  99         sjme_jint* selBuf;
 100
 101         /** The length of the selection buffer. */
 102         sjme_jint selBufLen;
 103
 104         /** The selection buffer width. */
 105         sjme_jint selBufWidth;
 106
 107         /** The selection buffer height. */
 108         sjme_jint selBufHeight;
 109
 110         /** The selection buffer pencil. */
 111         sjme_scritchui_pencil selBufPencil;
 112
 113         /** Lightweight activation. */
 114         sjme_scritchui_fb_lightActivateListenerFunc lightActivateListener;
 115
 116         /** Lightweight click. */
 117         sjme_scritchui_fb_lightClickListenerFunc lightClickListener;
 118
 119         /** Lightweight cursor. */
 120         sjme_scritchui_fb_lightCursorListenerFunc lightCursorListener;
 121
 122         /** Lightweight hover. */
 123         sjme_scritchui_fb_lightHoverListenerFunc lightHoverListener;
 124
 125         /** Lightweight select. */
 126         sjme_scritchui_fb_lightSelectListenerFunc lightSelectListener;
 127 } sjme_scritchui_fb_widgetState;
 128
 129 /**
 130  * A type of entry within a display list.
 131  *
 132  * @since 2024/07/26
 133  */
 134 typedef enum sjme_scritchui_fb_displayListType
 135 {
 136         /** Nothing. */
 137         SJME_SCRITCHUI_FB_DL_TYPE_NOTHING,
 138
 139         /** Normal box. */
 140         SJME_SCRITCHUI_FB_DL_TYPE_BOX,
 141
 142         /** Text. */
 143         SJME_SCRITCHUI_FB_DL_TYPE_TEXT,
 144
 145         /** Another display list. */
 146         SJME_SCRITCHUI_FB_DL_TYPE_DL,
 147
 148         /** The number of display list types. */
 149         SJME_SCRITCHUI_FB_NUM_DL_TYPE
 150 } sjme_scritchui_fb_displayListType;
 151
 152 /**
 153  * Modifier for display list drawing.
 154  *
 155  * @since 2024/07/26
 156  */
 157 typedef enum sjme_scritchui_fb_displayListMod
 158 {
 159         /** No modifiers. */
 160         SJME_SCRITCHUI_FB_DL_TYPE_MOD_NONE = 0,
 161
 162         /** Focused. */
 163         SJME_SCRITCHUI_FB_DL_TYPE_MOD_FOCUS = 1,
 164
 165         /** Selected. */
 166         SJME_SCRITCHUI_FB_DL_TYPE_MOD_SELECTED = 2,
 167
 168         /** Disabled. */
 169         SJME_SCRITCHUI_FB_DL_TYPE_MOD_DISABLED = 4,
 170 } sjme_scritchui_fb_displayListMod;
 171
 172 /**
 173  * Text display list data.
 174  *
 175  * @since 2024/07/26
 176  */
 177 typedef struct sjme_scritchui_fb_displayListText
 178 {
 179         /** The string to render. */
 180         sjme_scritchui_pencilFont font;
 181
 182         /** The font used. */
 183         sjme_lpcstr string;
 184 } sjme_scritchui_fb_displayListText;
 185
 186 /**
 187  * Represents a single item within a display list.
 188  *
 189  * @since 2024/07/26
 190  */
 191 typedef struct sjme_scritchui_fb_displayList
 192 {
 193         /** The type of entry this is. */
 194         sjme_scritchui_fb_displayListType type;
 195
 196         /** Modifiers for this entry. */
 197         sjme_scritchui_fb_displayListMod mod;
 198
 199         /** The bounds to use for this item. */
 200         sjme_scritchui_rect bound;
 201
 202         /** The selection item, used for mouse actions. */
 203         sjme_jint selection;
 204
 205         /** The color to use. */
 206         sjme_scritchui_lafElementColorType color;
 207
 208         /** The display list entry data. */
 209         union
 210         {
 211                 /** Text data. */
 212                 sjme_scritchui_fb_displayListText text;
 213         } data;
 214 } sjme_scritchui_fb_displayList;
 215
 216 /**
 217  * Shaders used to modify how items are drawn.
 218  *
 219  * @since 2024/07/26
 220  */
 221 typedef struct sjme_scritchui_fb_displayShaders
 222 {
 223         sjme_jint todo;
 224 } sjme_scritchui_fb_displayShaders;
 225
 226 /**
 227  * Initializes the lightweight component.
 228  *
 229  * @param inState The input state.
 230  * @param inComponent The input component.
 231  * @param outWState The output widget state.
 232  * @param isInteractive Is this an interactive component?
 233  * @param paintListener The listener for paint operations.
 234  * @since 2024/07/26
 235  */
 236 typedef sjme_errorCode (*sjme_scritchui_fb_intern_lightweightInitFunc)(
 237         sjme_attrInNotNull sjme_scritchui inState,
 238         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 239         sjme_attrOutNotNull sjme_scritchui_fb_widgetState** outWState,
 240         sjme_attrInValue sjme_jboolean isInteractive,
 241         sjme_attrInNotNull sjme_scritchui_paintListenerFunc paintListener);
 242
 243 /**
 244  * Returns the logical button that was pressed.
 245  *
 246  * @param inState The input state.
 247  * @param inEvent The input event.
 248  * @return Any resultant error, if any.
 249  * @since 2024/07/27
 250  */
 251 typedef sjme_errorCode (*sjme_scritchui_fb_intern_logicalButtonFunc)(
 252         sjme_attrInNotNull sjme_scritchui inState,
 253         sjme_attrInNotNull const sjme_scritchinput_event* inEvent,
 254         sjme_attrOutNotNull sjme_scritchinput_key* outKey);
 255
 256 /**
 257  * Refreshes the specified component.
 258  *
 259  * @param inState The input state.
 260  * @param inComponent The component to refresh.
 261  * @return Any resultant error, if any.
 262  * @since 2024/07/27
 263  */
 264 typedef sjme_errorCode (*sjme_scritchui_fb_intern_refreshFunc)(
 265         sjme_attrInNotNull sjme_scritchui inState,
 266         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent);
 267
 268 /**
 269  * Renders the given display list.
 270  *
 271  * @param inState The input state.
 272  * @param inComponent Optional component being drawn, used for selections.
 273  * @param g The pencil to draw with.
 274  * @param dlFull The display list to draw.
 275  * @param dlCount The size of the display list.
 276  * @param focusRect The focus rectangle.
 277  * @param shaders Shaders that may modify rendering.
 278  * @param shaderData Any data to pass to shaders.
 279  * @return Any resultant error, if any.
 280  * @since 2024/07/26
 281  */
 282 typedef sjme_errorCode (*sjme_scritchui_fb_intern_renderFunc)(
 283         sjme_attrInNotNull sjme_scritchui inState,
 284         sjme_attrInNullable sjme_scritchui_uiComponent inComponent,
 285         sjme_attrInNotNull sjme_scritchui_pencil g,
 286         sjme_attrInNotNull const sjme_scritchui_fb_displayList* dlFull,
 287         sjme_attrInPositive sjme_jint dlCount,
 288         sjme_attrOutNullable sjme_scritchui_rect* focusRect,
 289         sjme_attrInNullable const sjme_scritchui_fb_displayShaders* shaders,
 290         sjme_attrInNullable sjme_pointer shaderData);
 291
 292 /**
 293  * Renders the given display list in a scroll window for the given component.
 294  *
 295  * @param inState The input state.
 296  * @param inComponent The component to render for within a scroll window.
 297  * @param g The pencil to draw with.
 298  * @param dlFull The display list to draw.
 299  * @param dlCount The size of the display list.
 300  * @param focusRect The focus rectangle.
 301  * @param shaders Shaders that may modify rendering.
 302  * @param shaderData Any data to pass to shaders.
 303  * @return Any resultant error, if any.
 304  * @since 2024/07/26
 305  */
 306 typedef sjme_errorCode (*sjme_scritchui_fb_intern_renderInScrollFunc)(
 307         sjme_attrInNotNull sjme_scritchui inState,
 308         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 309         sjme_attrInNotNull sjme_scritchui_pencil g,
 310         sjme_attrInNotNull const sjme_scritchui_fb_displayList* dlFull,
 311         sjme_attrInPositive sjme_jint dlCount,
 312         sjme_attrOutNullable sjme_scritchui_rect* focusRect,
 313         sjme_attrInNullable const sjme_scritchui_fb_displayShaders* shaders,
 314         sjme_attrInNullable sjme_pointer shaderData);
 315
 316 struct sjme_scritchui_implInternFunctions
 317 {
 318         /** Initialize lightweight component. */
 319         sjme_scritchui_fb_intern_lightweightInitFunc lightweightInit;
 320
 321         /** Get logical button. */
 322         sjme_scritchui_fb_intern_logicalButtonFunc logicalButton;
 323
 324         /** Refresh widget. */
 325         sjme_scritchui_fb_intern_refreshFunc refresh;
 326
 327         /** Render directly. */
 328         sjme_scritchui_fb_intern_renderFunc render;
 329
 330         /** Render in scroll window. */
 331         sjme_scritchui_fb_intern_renderInScrollFunc renderInScroll;
 332 };
 333
 334 sjme_errorCode sjme_scritchui_fb_intern_lightweightInit(
 335         sjme_attrInNotNull sjme_scritchui inState,
 336         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 337         sjme_attrOutNotNull sjme_scritchui_fb_widgetState** outWState,
 338         sjme_attrInValue sjme_jboolean isInteractive,
 339         sjme_attrInNotNull sjme_scritchui_paintListenerFunc paintListener);
 340
 341 sjme_errorCode sjme_scritchui_fb_intern_logicalButton(
 342         sjme_attrInNotNull sjme_scritchui inState,
 343         sjme_attrInNotNull const sjme_scritchinput_event* inEvent,
 344         sjme_attrOutNotNull sjme_scritchinput_key* outKey);
 345
 346 sjme_errorCode sjme_scritchui_fb_intern_refresh(
 347         sjme_attrInNotNull sjme_scritchui inState,
 348         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent);
 349
 350 sjme_errorCode sjme_scritchui_fb_intern_render(
 351         sjme_attrInNotNull sjme_scritchui inState,
 352         sjme_attrInNullable sjme_scritchui_uiComponent inComponent,
 353         sjme_attrInNotNull sjme_scritchui_pencil g,
 354         sjme_attrInNotNull const sjme_scritchui_fb_displayList* dlFull,
 355         sjme_attrInPositive sjme_jint dlCount,
 356         sjme_attrOutNullable sjme_scritchui_rect* focusRect,
 357         sjme_attrInNullable const sjme_scritchui_fb_displayShaders* shaders,
 358         sjme_attrInNullable sjme_pointer shaderData);
 359
 360 sjme_errorCode sjme_scritchui_fb_intern_renderInScroll(
 361         sjme_attrInNotNull sjme_scritchui inState,
 362         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 363         sjme_attrInNotNull sjme_scritchui_pencil g,
 364         sjme_attrInNotNull const sjme_scritchui_fb_displayList* dlFull,
 365         sjme_attrInPositive sjme_jint dlCount,
 366         sjme_attrOutNullable sjme_scritchui_rect* focusRect,
 367         sjme_attrInNullable const sjme_scritchui_fb_displayShaders* shaders,
 368         sjme_attrInNullable sjme_pointer shaderData);
 369
 370 /*--------------------------------------------------------------------------*/
 371
 372 /* Anti-C++. */
 373 #ifdef __cplusplus
 374         #ifdef SJME_CXX_SQUIRRELJME_FBINTERN_H
 375 }
 376                 #undef SJME_CXX_SQUIRRELJME_FBINTERN_H
 377                 #undef SJME_CXX_IS_EXTERNED
 378         #endif /* #ifdef SJME_CXX_SQUIRRELJME_FBINTERN_H */
 379 #endif /* #ifdef __cplusplus */
 380
 381 #endif /* SQUIRRELJME_FBINTERN_H */