@vulfram/engine 0.5.6-alpha

package/src/types/cmds/texture.ts

@@ -0,0 +1,63 @@
+import type { TextureCreateMode } from '../kinds';
+
+/** Options for forward atlas texture packing. */
+export interface ForwardAtlasOptions {
+  tilePx: number;
+  layers: number;
+}
+
+/** Command payload for creating a texture from an uploaded buffer. */
+export interface CmdTextureCreateFromBufferArgs {
+  windowId: number;
+  textureId: number;
+  label?: string;
+  bufferId: number;
+  srgb?: boolean;
+  mode?: TextureCreateMode;
+  atlasOptions?: ForwardAtlasOptions;
+}
+
+/** Result payload for texture create from buffer. */
+export interface CmdResultTextureCreateFromBuffer {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for creating a solid color texture. */
+export interface CmdTextureCreateSolidColorArgs {
+  windowId: number;
+  textureId: number;
+  label?: string;
+  color: [number, number, number, number];
+  srgb?: boolean;
+  mode?: TextureCreateMode;
+  atlasOptions?: ForwardAtlasOptions;
+}
+
+/** Result payload for solid color texture create. */
+export interface CmdResultTextureCreateSolidColor {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for disposing a texture. */
+export interface CmdTextureDisposeArgs {
+  windowId: number;
+  textureId: number;
+}
+
+/** Result payload for texture dispose. */
+export interface CmdResultTextureDispose {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for listing textures. */
+export interface CmdTextureListArgs {}
+
+/** Result payload for texture list. */
+export interface CmdResultTextureList {
+  success: boolean;
+  message: string;
+  content: number[]; // List of texture IDs
+}

package/src/types/cmds/window.ts

@@ -0,0 +1,263 @@
+import type {
+  WindowState,
+  CursorGrabMode,
+  CursorIcon,
+  UserAttentionType,
+} from '../kinds';
+
+/** Command payload for creating a window. */
+export interface CmdWindowCreateArgs {
+  windowId: number;
+  title?: string;
+  size?: [number, number]; // UVec2
+  position?: [number, number]; // IVec2
+  canvasId?: string;
+  borderless?: boolean;
+  resizable?: boolean;
+  transparent?: boolean;
+  initialState?: WindowState;
+}
+
+/** Result payload for window create. */
+export interface CmdResultWindowCreate {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for closing a window. */
+export interface CmdWindowCloseArgs {
+  windowId: number;
+}
+
+/** Result payload for window close. */
+export interface CmdResultWindowClose {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for setting window title. */
+export interface CmdWindowSetTitleArgs {
+  windowId: number;
+  title: string;
+}
+
+/** Result payload for window title update. */
+export interface CmdResultWindowSetTitle {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for setting window position. */
+export interface CmdWindowSetPositionArgs {
+  windowId: number;
+  position: [number, number];
+}
+
+/** Result payload for window position update. */
+export interface CmdResultWindowSetPosition {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for querying window position. */
+export interface CmdWindowGetPositionArgs {
+  windowId: number;
+}
+
+/** Result payload for window position query. */
+export interface CmdResultWindowGetPosition {
+  success: boolean;
+  message: string;
+  content: [number, number];
+}
+
+/** Command payload for setting window size. */
+export interface CmdWindowSetSizeArgs {
+  windowId: number;
+  size: [number, number];
+}
+
+/** Result payload for window size update. */
+export interface CmdResultWindowSetSize {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for querying window size. */
+export interface CmdWindowGetSizeArgs {
+  windowId: number;
+}
+
+/** Result payload for window size query. */
+export interface CmdResultWindowGetSize {
+  success: boolean;
+  message: string;
+  content: [number, number];
+}
+
+/** Command payload for querying outer window size. */
+export interface CmdWindowGetOuterSizeArgs {
+  windowId: number;
+}
+
+/** Result payload for outer window size query. */
+export interface CmdResultWindowGetOuterSize {
+  success: boolean;
+  message: string;
+  content: [number, number];
+}
+
+/** Command payload for querying surface size. */
+export interface CmdWindowGetSurfaceSizeArgs {
+  windowId: number;
+}
+
+/** Result payload for surface size query. */
+export interface CmdResultWindowGetSurfaceSize {
+  success: boolean;
+  message: string;
+  content: [number, number];
+}
+
+/** Command payload for setting window state. */
+export interface CmdWindowSetStateArgs {
+  windowId: number;
+  state: WindowState;
+}
+
+/** Result payload for window state update. */
+export interface CmdResultWindowSetState {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for querying window state. */
+export interface CmdWindowGetStateArgs {
+  windowId: number;
+}
+
+/** Result payload for window state query. */
+export interface CmdResultWindowGetState {
+  success: boolean;
+  message: string;
+  content: WindowState;
+}
+
+/** Command payload for setting window icon. */
+export interface CmdWindowSetIconArgs {
+  windowId: number;
+  icon: string; // Buffer ID pointing to an image
+}
+
+/** Result payload for window icon update. */
+export interface CmdResultWindowSetIcon {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for toggling window decorations. */
+export interface CmdWindowSetDecorationsArgs {
+  windowId: number;
+  decorations: boolean;
+}
+
+/** Result payload for window decoration update. */
+export interface CmdResultWindowSetDecorations {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for querying window decorations. */
+export interface CmdWindowHasDecorationsArgs {
+  windowId: number;
+}
+
+/** Result payload for window decoration query. */
+export interface CmdResultWindowHasDecorations {
+  success: boolean;
+  message: string;
+  content: boolean;
+}
+
+/** Command payload for toggling window resizable state. */
+export interface CmdWindowSetResizableArgs {
+  windowId: number;
+  resizable: boolean;
+}
+
+/** Result payload for window resizable update. */
+export interface CmdResultWindowSetResizable {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for querying resizable state. */
+export interface CmdWindowIsResizableArgs {
+  windowId: number;
+}
+
+/** Result payload for resizable query. */
+export interface CmdResultWindowIsResizable {
+  success: boolean;
+  message: string;
+  content: boolean;
+}
+
+/** Command payload for requesting user attention. */
+export interface CmdWindowRequestAttentionArgs {
+  windowId: number;
+  attentionType?: UserAttentionType;
+}
+
+/** Result payload for attention request. */
+export interface CmdResultWindowRequestAttention {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for focusing a window. */
+export interface CmdWindowFocusArgs {
+  windowId: number;
+}
+
+/** Result payload for window focus. */
+export interface CmdResultWindowFocus {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for toggling cursor visibility. */
+export interface CmdWindowSetCursorVisibleArgs {
+  windowId: number;
+  visible: boolean;
+}
+
+/** Result payload for cursor visibility update. */
+export interface CmdResultWindowSetCursorVisible {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for setting cursor grab mode. */
+export interface CmdWindowSetCursorGrabArgs {
+  windowId: number;
+  mode: CursorGrabMode;
+}
+
+/** Result payload for cursor grab update. */
+export interface CmdResultWindowSetCursorGrab {
+  success: boolean;
+  message: string;
+}
+
+/** Command payload for setting cursor icon. */
+export interface CmdWindowSetCursorIconArgs {
+  windowId: number;
+  icon: CursorIcon;
+}
+
+/** Result payload for cursor icon update. */
+export interface CmdResultWindowSetCursorIcon {
+  success: boolean;
+  message: string;
+}

package/src/types/events/gamepad.ts

@@ -0,0 +1,34 @@
+import type { ElementState } from '../kinds';
+
+/** Payload for gamepad connect event. */
+export interface GamepadEventOnConnectData {
+  gamepadId: number;
+  name: string;
+}
+
+/** Payload for gamepad disconnect event. */
+export interface GamepadEventOnDisconnectData {
+  gamepadId: number;
+}
+
+/** Payload for gamepad button event. */
+export interface GamepadEventOnButtonData {
+  gamepadId: number;
+  button: number;
+  state: ElementState;
+  value: number;
+}
+
+/** Payload for gamepad axis event. */
+export interface GamepadEventOnAxisData {
+  gamepadId: number;
+  axis: number;
+  value: number;
+}
+
+/** Discriminated union of gamepad events. */
+export type GamepadEvent =
+  | { event: 'on-connect'; data: GamepadEventOnConnectData }
+  | { event: 'on-disconnect'; data: GamepadEventOnDisconnectData }
+  | { event: 'on-button'; data: GamepadEventOnButtonData }
+  | { event: 'on-axis'; data: GamepadEventOnAxisData };

package/src/types/events/index.ts

@@ -0,0 +1,19 @@
+import type { WindowEvent } from './window';
+import type { PointerEvent } from './pointer';
+import type { KeyboardEvent } from './keyboard';
+import type { GamepadEvent } from './gamepad';
+import type { SystemEvent } from './system';
+
+export * from './window';
+export * from './pointer';
+export * from './keyboard';
+export * from './gamepad';
+export * from './system';
+
+/** Discriminated union of all engine events. */
+export type EngineEvent =
+  | { type: 'window'; content: WindowEvent }
+  | { type: 'pointer'; content: PointerEvent }
+  | { type: 'keyboard'; content: KeyboardEvent }
+  | { type: 'gamepad'; content: GamepadEvent }
+  | { type: 'system'; content: SystemEvent };

package/src/types/events/keyboard.ts

@@ -0,0 +1,225 @@
+import type { ElementState } from '../kinds';
+
+/** Modifier key state for keyboard events. */
+export interface ModifiersState {
+  shift: boolean;
+  ctrl: boolean;
+  alt: boolean;
+  meta: boolean;
+}
+
+/** Payload for keyboard input event. */
+export interface KeyboardEventOnInputData {
+  windowId: number;
+  keyCode: KeyCode;
+  state: ElementState;
+  location: number;
+  repeat: boolean;
+  text?: string;
+  modifiers: ModifiersState;
+}
+
+/** Payload for modifier change event. */
+export interface KeyboardEventOnModifiersChangeData {
+  windowId: number;
+  modifiers: ModifiersState;
+}
+
+/** Payload for IME enable event. */
+export interface KeyboardEventOnImeEnableData {
+  windowId: number;
+}
+
+/** Payload for IME preedit event. */
+export interface KeyboardEventOnImePreeditData {
+  windowId: number;
+  text: string;
+  cursorRange?: [number, number];
+}
+
+/** Payload for IME commit event. */
+export interface KeyboardEventOnImeCommitData {
+  windowId: number;
+  text: string;
+}
+
+/** Payload for IME disable event. */
+export interface KeyboardEventOnImeDisableData {
+  windowId: number;
+}
+
+/** Discriminated union of keyboard events. */
+export type KeyboardEvent =
+  | { event: 'on-input'; data: KeyboardEventOnInputData }
+  | { event: 'on-modifiers-change'; data: KeyboardEventOnModifiersChangeData }
+  | { event: 'on-ime-enable'; data: KeyboardEventOnImeEnableData }
+  | { event: 'on-ime-preedit'; data: KeyboardEventOnImePreeditData }
+  | { event: 'on-ime-commit'; data: KeyboardEventOnImeCommitData }
+  | { event: 'on-ime-disable'; data: KeyboardEventOnImeDisableData };
+
+/** Key code mapping used by the engine. */
+export enum KeyCode {
+  // Writing System Keys (0–49)
+  Backquote = 0,
+  Backslash = 1,
+  BracketLeft = 2,
+  BracketRight = 3,
+  Comma = 4,
+  Digit0 = 5,
+  Digit1 = 6,
+  Digit2 = 7,
+  Digit3 = 8,
+  Digit4 = 9,
+  Digit5 = 10,
+  Digit6 = 11,
+  Digit7 = 12,
+  Digit8 = 13,
+  Digit9 = 14,
+  Equal = 15,
+  IntlBackslash = 16,
+  IntlRo = 17,
+  IntlYen = 18,
+  KeyA = 19,
+  KeyB = 20,
+  KeyC = 21,
+  KeyD = 22,
+  KeyE = 23,
+  KeyF = 24,
+  KeyG = 25,
+  KeyH = 26,
+  KeyI = 27,
+  KeyJ = 28,
+  KeyK = 29,
+  KeyL = 30,
+  KeyM = 31,
+  KeyN = 32,
+  KeyO = 33,
+  KeyP = 34,
+  KeyQ = 35,
+  KeyR = 36,
+  KeyS = 37,
+  KeyT = 38,
+  KeyU = 39,
+  KeyV = 40,
+  KeyW = 41,
+  KeyX = 42,
+  KeyY = 43,
+  KeyZ = 44,
+  Minus = 45,
+  Period = 46,
+  Quote = 47,
+  Semicolon = 48,
+  Slash = 49,
+
+  // Functional Keys (50–63)
+  AltLeft = 50,
+  AltRight = 51,
+  Backspace = 52,
+  CapsLock = 53,
+  ContextMenu = 54,
+  ControlLeft = 55,
+  ControlRight = 56,
+  Enter = 57,
+  SuperLeft = 58,
+  SuperRight = 59,
+  ShiftLeft = 60,
+  ShiftRight = 61,
+  Space = 62,
+  Tab = 63,
+
+  // Control Keys (64–70)
+  Delete = 64,
+  End = 65,
+  Help = 66,
+  Home = 67,
+  Insert = 68,
+  PageDown = 69,
+  PageUp = 70,
+
+  // Arrow Keys (71–74)
+  ArrowDown = 71,
+  ArrowLeft = 72,
+  ArrowRight = 73,
+  ArrowUp = 74,
+
+  // Numpad Keys (75–105)
+  NumLock = 75,
+  Numpad0 = 76,
+  Numpad1 = 77,
+  Numpad2 = 78,
+  Numpad3 = 79,
+  Numpad4 = 80,
+  Numpad5 = 81,
+  Numpad6 = 82,
+  Numpad7 = 83,
+  Numpad8 = 84,
+  Numpad9 = 85,
+  NumpadAdd = 86,
+  NumpadBackspace = 87,
+  NumpadClear = 88,
+  NumpadClearEntry = 89,
+  NumpadComma = 90,
+  NumpadDecimal = 91,
+  NumpadDivide = 92,
+  NumpadEnter = 93,
+  NumpadEqual = 94,
+  NumpadHash = 95,
+  NumpadMemoryAdd = 96,
+  NumpadMemoryClear = 97,
+  NumpadMemoryRecall = 98,
+  NumpadMemoryStore = 99,
+  NumpadMemorySubtract = 100,
+  NumpadMultiply = 101,
+  NumpadParenLeft = 102,
+  NumpadParenRight = 103,
+  NumpadStar = 104,
+  NumpadSubtract = 105,
+
+  // Function Keys (106–130)
+  Escape = 106,
+  F1 = 107,
+  F2 = 108,
+  F3 = 109,
+  F4 = 110,
+  F5 = 111,
+  F6 = 112,
+  F7 = 113,
+  F8 = 114,
+  F9 = 115,
+  F10 = 116,
+  F11 = 117,
+  F12 = 118,
+  F13 = 119,
+  F14 = 120,
+  F15 = 121,
+  F16 = 122,
+  F17 = 123,
+  F18 = 124,
+  F19 = 125,
+  F20 = 126,
+  F21 = 127,
+  F22 = 128,
+  F23 = 129,
+  F24 = 130,
+
+  // Lock, Media, Browser & System Keys (131–147)
+  ScrollLock = 131,
+  AudioVolumeDown = 132,
+  AudioVolumeMute = 133,
+  AudioVolumeUp = 134,
+  MediaPlayPause = 135,
+  MediaStop = 136,
+  MediaTrackNext = 137,
+  MediaTrackPrevious = 138,
+  BrowserBack = 139,
+  BrowserFavorites = 140,
+  BrowserForward = 141,
+  BrowserHome = 142,
+  BrowserRefresh = 143,
+  BrowserSearch = 144,
+  BrowserStop = 145,
+  PrintScreen = 146,
+  Pause = 147,
+
+  Unidentified = 255,
+}

package/src/types/events/pointer.ts

@@ -0,0 +1,105 @@
+import type { ElementState, TouchPhase } from '../kinds';
+
+/** Scroll delta reported in line or pixel units. */
+export type ScrollDelta =
+  | { type: 'line'; value: [number, number] }
+  | { type: 'pixel'; value: [number, number] };
+
+/** Payload for pointer move event. */
+export interface PointerEventOnMoveData {
+  windowId: number;
+  pointerType: number;
+  pointerId: number;
+  position: [number, number];
+}
+
+/** Payload for pointer enter event. */
+export interface PointerEventOnEnterData {
+  windowId: number;
+  pointerType: number;
+  pointerId: number;
+}
+
+/** Payload for pointer leave event. */
+export interface PointerEventOnLeaveData {
+  windowId: number;
+  pointerType: number;
+  pointerId: number;
+}
+
+/** Payload for pointer button event. */
+export interface PointerEventOnButtonData {
+  windowId: number;
+  pointerType: number;
+  pointerId: number;
+  button: MouseButton;
+  state: ElementState;
+  position: [number, number];
+}
+
+/** Payload for pointer scroll event. */
+export interface PointerEventOnScrollData {
+  windowId: number;
+  delta: ScrollDelta;
+  phase: TouchPhase;
+}
+
+/** Payload for touch event. */
+export interface PointerEventOnTouchData {
+  windowId: number;
+  pointerId: number;
+  phase: TouchPhase;
+  position: [number, number];
+  pressure?: number;
+}
+
+/** Payload for pinch gesture event. */
+export interface PointerEventOnPinchGestureData {
+  windowId: number;
+  delta: number;
+  phase: TouchPhase;
+}
+
+/** Payload for pan gesture event. */
+export interface PointerEventOnPanGestureData {
+  windowId: number;
+  delta: [number, number];
+  phase: TouchPhase;
+}
+
+/** Payload for rotation gesture event. */
+export interface PointerEventOnRotationGestureData {
+  windowId: number;
+  delta: number;
+  phase: TouchPhase;
+}
+
+/** Payload for double tap gesture event. */
+export interface PointerEventOnDoubleTapGestureData {
+  windowId: number;
+}
+
+/** Discriminated union of pointer events. */
+export type PointerEvent =
+  | { event: 'on-move'; data: PointerEventOnMoveData }
+  | { event: 'on-enter'; data: PointerEventOnEnterData }
+  | { event: 'on-leave'; data: PointerEventOnLeaveData }
+  | { event: 'on-button'; data: PointerEventOnButtonData }
+  | { event: 'on-scroll'; data: PointerEventOnScrollData }
+  | { event: 'on-touch'; data: PointerEventOnTouchData }
+  | { event: 'on-pinch-gesture'; data: PointerEventOnPinchGestureData }
+  | { event: 'on-pan-gesture'; data: PointerEventOnPanGestureData }
+  | { event: 'on-rotation-gesture'; data: PointerEventOnRotationGestureData }
+  | {
+      event: 'on-double-tap-gesture';
+      data: PointerEventOnDoubleTapGestureData;
+    };
+
+/** Mouse button identifiers. */
+export enum MouseButton {
+  Left = 0,
+  Right = 1,
+  Middle = 2,
+  Back = 3,
+  Forward = 4,
+}