blecsd 0.1.0

package/dist/doubleBuffer-CKQFmlPN.d.ts

@@ -0,0 +1,95 @@
+import { S as ScreenBufferData, C as Cell } from './cell-DwIu2ryP.js';
+
+/**
+ * Double Buffering System
+ *
+ * Provides efficient rendering through double buffering. The system maintains
+ * two buffers (front and back), tracks dirty regions, and computes minimal
+ * update sets for efficient terminal output.
+ *
+ * @module terminal/screen/doubleBuffer
+ * @internal This module is internal and used by the rendering system.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   createDoubleBuffer,
+ *   getBackBuffer,
+ *   markDirtyRegion,
+ *   swapBuffers,
+ *   getMinimalUpdates,
+ * } from 'blecsd';
+ *
+ * // Create a double buffer
+ * const db = createDoubleBuffer(80, 24);
+ *
+ * // Write to back buffer
+ * const back = getBackBuffer(db);
+ * setCell(back, 10, 5, createCell('X'));
+ *
+ * // Mark the region as dirty
+ * markDirtyRegion(db, 10, 5, 1, 1);
+ *
+ * // Get minimal updates and swap
+ * const updates = getMinimalUpdates(db);
+ * swapBuffers(db);
+ *
+ * // Output only the changed cells
+ * for (const { x, y, cell } of updates) {
+ *   outputCell(x, y, cell);
+ * }
+ * ```
+ */
+
+/**
+ * A rectangular region of the screen.
+ */
+interface Rect {
+    /** Left edge X coordinate */
+    readonly x: number;
+    /** Top edge Y coordinate */
+    readonly y: number;
+    /** Width of region */
+    readonly w: number;
+    /** Height of region */
+    readonly h: number;
+}
+/**
+ * Double buffer data structure.
+ *
+ * Maintains front and back buffers for efficient rendering,
+ * along with dirty region tracking.
+ */
+interface DoubleBufferData {
+    /** Width of buffers */
+    readonly width: number;
+    /** Height of buffers */
+    readonly height: number;
+    /** Front buffer (currently displayed) */
+    frontBuffer: ScreenBufferData;
+    /** Back buffer (being rendered to) */
+    backBuffer: ScreenBufferData;
+    /** Dirty regions that need updating */
+    readonly dirtyRegions: Rect[];
+    /** Full redraw flag */
+    fullRedraw: boolean;
+}
+/**
+ * Creates a new double buffer system.
+ *
+ * @param width - Buffer width in cells
+ * @param height - Buffer height in cells
+ * @param defaultCell - Optional default cell for initialization
+ * @returns A new DoubleBufferData
+ * @throws {Error} If dimensions are not positive
+ *
+ * @example
+ * ```typescript
+ * import { createDoubleBuffer } from 'blecsd';
+ *
+ * const db = createDoubleBuffer(80, 24);
+ * ```
+ */
+declare function createDoubleBuffer(width: number, height: number, defaultCell?: Cell): DoubleBufferData;
+
+export { type DoubleBufferData as D, createDoubleBuffer as c };