@tongue-core/raster-linux-x64 0.0.0-stage → 0.1.0-rc.1

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @tongue-core/raster-linux-x64
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Prebuilt rasterizers for Linux x64, installed as an optional dependency of `@tongue-core/sdk` (the way
+esbuild ships its binaries). Other platforms fall back to the WebAssembly raster embedded in
+`@tongue-core/engine`.
+
+| Library | What it is |
+|---|---|
+| `lib/libtongue_raster.so` | `crates/raster` compiled for x86-64-v3 (AVX2). Byte-identical to the WebAssembly raster. |
+| `lib/libtongue_gpu_raster.so` | `crates/gpu-raster`: headless EGL + OpenGL ES 3.1 on a DRM render node. Within a few levels of the CPU raster; opt-in. Needs libEGL, libGLESv2 and a GPU. |
+
+```ts
+import { nativeRaster, gpuRaster } from "@tongue-core/raster-linux-x64";
+nativeRaster(); // { path: "/…/lib/libtongue_raster.so", exists: true }
+```
+
+Build them with `bun scripts/build-rasters.ts` from the repo root (`--no-wasm`, `--no-native`,
+`--no-gpu` to skip parts). The SDK can also be pointed at other builds with `TONGUE_NATIVE_RASTER`
+and `TONGUE_GPU_RASTER`.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export interface RasterLibrary {
+    /** Absolute path of the shared library. */
+    readonly path: string;
+    /** Whether it has been built (or installed). */
+    readonly exists: boolean;
+}
+/** The CPU raster, compiled for x86-64-v3 (AVX2): byte-identical to the WebAssembly raster. */
+export declare const nativeRaster: () => RasterLibrary;
+/** The GPU raster (headless EGL + GLES 3.1): within a few levels of the CPU raster. */
+export declare const gpuRaster: () => RasterLibrary;

package/dist/index.js

@@ -0,0 +1,13 @@
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+// Where this package's prebuilt rasterizers are. The libraries are built by
+// scripts/build-rasters.ts (repo root) and loaded by @tongue-core/sdk through bun:ffi.
+const lib = join(import.meta.dir, "../lib");
+const libraryAt = (file) => {
+    const path = join(lib, file);
+    return { path, exists: existsSync(path) };
+};
+/** The CPU raster, compiled for x86-64-v3 (AVX2): byte-identical to the WebAssembly raster. */
+export const nativeRaster = () => libraryAt("libtongue_raster.so");
+/** The GPU raster (headless EGL + GLES 3.1): within a few levels of the CPU raster. */
+export const gpuRaster = () => libraryAt("libtongue_gpu_raster.so");

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@tongue-core/raster-linux-x64",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-rc.1",
+  "description": "Prebuilt native (x86-64-v3) and GPU (EGL + GLES 3.1) rasterizers for Tongue on Linux x64.",
+  "type": "module",
+  "license": "UNLICENSED",
+  "author": "Backpine",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/backpine/tongue-core.git",
+    "directory": "packages/raster-linux-x64"
+  },
+  "engines": {
+    "bun": ">=1.3.0"
+  },
+  "os": [
+    "linux"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "lib",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}