qml-raub/index.d.ts

QML interoperation for Node.js

declare module "qml-raub" {
	type TSize = Readonly<{ width: number; height: number }>;
	
	type TEvent = {
		type: string;
		[key: string]: unknown;
	};
	
	type TMouseEventCommon = TEvent & Readonly<{
		buttons: number[],
		x: number,
		y: number,
	}>;
	
	type TMouseEventPress = TMouseEventCommon & Readonly<{
		button: number,
	}>;
	
	type TMouseEventWheel = TMouseEventCommon & Readonly<{
		wheelDelta: number,
	}>;
	
	type TKeyEvent = TEvent & Readonly<{
		which: number,
		charCode: number,
	}>;
	
	type EventEmitter = import('node:events').EventEmitter;
	
	export type TOptsView = Readonly<Partial<{
		/** Texture width. Default is 512. */
		width: number;
		/** Texture height. Default is 512. */
		height: number;
		/** Suppress error messages from QML runtime. */
		silent: boolean;
		/** If passed, this QML file starts loading immediately. */
		file: string;
	}>>;
	
	export type TOptsLoad = Readonly<{ file: string }> | Readonly<{ source: string }>;
	
	/**
	 * View
	 * 
	 * Loads and manages a QML file.
	 * 
	 * @note Make sure to always switch back to your own OpenGL context before drawing.
	*/
	export class View implements EventEmitter {
		constructor(opts?: TOptsView);
		
		/**
		 * Width in pixels.
		 */
		width: number;
		
		/**
		 * Height in pixels.
		 */
		height: number;
		
		/** Alias for width. */
		w: number;
		
		/** Alias for height. */
		h: number;
		
		/** An Array, containing width and height. */
		wh: [number, number];
		
		/** An Object, containing width and height. */
		size: TSize;
		
		/** Is the requested QML file loaded? */
		readonly isLoaded: boolean;
		
		/** OpenGL texture ID for QML scene RTT resource. */
		readonly textureId: number;
		
		/** Stringification helper. */
		toString(): string;
		
		/** Send "mousedown" event into the QML scene. */
		mousedown(e: TMouseEventPress): void;
		
		/** Send "mouseup" event into the QML scene. */
		mouseup(e: TMouseEventPress): void;
		
		/** Send "mousemove" event into the QML scene. */
		mousemove(e: TMouseEventCommon): void;
		
		/** Send "wheel" event into the QML scene. */
		wheel(e: TMouseEventWheel): void;
		
		/** Send "keydown" event into the QML scene. */
		keydown(e: TKeyEvent): void;
		
		/** Send "keyup" event into the QML scene. */
		keyup(e: TKeyEvent): void;
		
		/**
		 * Load a new QML scene from file or source text.
		 * 
		 * @param opts either `{ file: string }` or `{ source: string }`.
		 * 
		 * @description
		 * 
		 * Can load QML from `file` (by path), or directly from `source` string.
		 * The old scene will be discarded, if any. A new texture will be created.
		 */
		load(opts: TOptsLoad): void;
		
		/** Unload the current QML scene. */
		destroy(): void;
		
		/** Invoke a method in QML scene. */
		invoke(name: string, key: string, args: unknown[]): unknown;
		
		/** Set property value of an object in QML scene. */
		set(name: string, key: string, value: unknown): void;
		
		/** Get property value from an object in QML scene. */
		get(name: string, key: string): unknown;
		
		/**
		 * Initialize the QML engine.
		 * 
		 * @param cwd base directory for QML file resolution. Usually, `process.cwd()`.
		 * @param wnd platform window handle (e.g. HWND on Windows).
		 * @param ctx the OpenGL context to which the QML render texture will be made available.
		 * @param device optional system display device, used only on Linux.
		 * 
		 * @see [OpenGL context](https://www.khronos.org/opengl/wiki/OpenGL_Context).
		 * 
		 * @description
		 * QML has a dedicated OpenGL context because of the renderer-specific requirements.
		 * The QML render textures are available to the main application's OpenGL context as well.
		 *
		 * With [glfw-raub](https://github.com/node-3d/glfw-raub), `hwnd` and `ctx` can
		 * be obtained with helpers:
		 * 
		 * ```
		 * // window - is returned by glfw.createWindow(...) call
		 * const hwnd = glfw.platformWindow(window);
		 * const ctx = glfw.platformContext(window);
		 * const device = glfw.platformDevice();
		 * ```
		 * 
		 * or
		 * 
		 * ```
		 * // window - is an instance of glfw.Window
		 * const hwnd = window.platformWindow;
		 * const ctx = window.platformContext;
		 * const device = window.platformDevice;
		 * ```
		 */
		static init(cwd: string, wnd: number, ctx: number, device?: number): void;
		
		/**
		 * Register a QML "library" directory.
		 * 
		 * Where to look for `*.qml` files for `import` resolution.
		 */
		static libs(l: string): void;
		
		/**
		 * Register a QML "plugin" directory.
		 * 
		 * Where to look for low-level Qt stuff, such as `platforms, iconengines, imageformats`.
		 */
		static plugins(p: string): void;
		
		/**
		 * Assign
		 * [QML style](https://doc.qt.io/qt-5/qtquickcontrols2-styles.html#using-styles-in-qt-quick-controls)
		 * value.
		 */
		static style(name: string, fallback: string): void;
		
		/**
		 * Update the QML scene (similar to "pollEvents" for a window).
		 * 
		 * Required for async operations, such as signal/slot interaction.
		 * If this method is not called at all, the QML scene won't ever load. It is preferred
		 * to call it regularly, e.g. every frame.
		 */
		static update(): void;
		
		// ------ implements EventEmitter
		
		addListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
		on(eventName: string | symbol, listener: (...args: any[]) => void): this;
		once(eventName: string | symbol, listener: (...args: any[]) => void): this;
		removeListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
		off(eventName: string | symbol, listener: (...args: any[]) => void): this;
		removeAllListeners(event?: string | symbol): this;
		setMaxListeners(n: number): this;
		getMaxListeners(): number;
		listeners(eventName: string | symbol): Function[];
		rawListeners(eventName: string | symbol): Function[];
		emit(eventName: string | symbol, ...args: any[]): boolean;
		listenerCount(eventName: string | symbol, listener?: Function): number;
		prependListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
		prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
		eventNames(): Array<string | symbol>;
	}
	
	export type TOptsProperty<T> = Readonly<{
		/** QML View instance */
		view: View;
		/** Target object name. */
		name: string;
		/** Property key. */
		key: string;
		/** Optional initial value - will be sent to QML scene ASAP. */
		value?: T;
	}>;
	
	/**
	 * QML Property interoperation helper.
	 *
	 * Automates reading and writing QML objects. A QML object should
	 * have `objectName` and the target property. The value must be serializable.
	 */
	export class Property<T = any> {
		constructor(opts: TOptsProperty<T>);
		
		get value(): T | null;
		set value(v: T | null);
	}
	
	export type TOptsMethod = Readonly<{
		/** QML View instance */
		view: View;
		/** Target object name. */
		name: string;
		/** Property key. */
		key: string;
	}>;
	
	type TUnknownFn = (
		a0?: any, a1?: any, a2?: any, a3?: any, a4?: any,
		a5?: any, a6?: any, a7?: any, a8?: any, a9?: any,
	) => unknown;
	interface TNewableMethod {
		new(opts: TOptsMethod): TUnknownFn;
	}
	
	/**
	 * QML Method interoperation helper.
	 *
	 * Automates reading and writing QML objects. A QML object should
	 * have `objectName` and the target property. The value must be serializable.
	 */
	export const Method: TNewableMethod;
}