@gtkx/gl 0.21.0 → 1.0.0-rc.1

package/src/generated/types.ts

@@ -1,18 +1,14 @@
 /**
- * GENERATED FILE — do not edit.
- *
- * Emitted by the `@gtkx/codegen` Khronos generator from the vendored
- * `registry/gl.xml` (gl 4.6 core profile). Regenerate with
- * `pnpm --filter @gtkx/codegen codegen:gl`.
+ * GENERATED FILE: do not edit.
  */
 
-import type { Handle } from "@gtkx/native";
+import { type ExternalObject, type Handle } from "@gtkx/native";
 
 /** An opaque `GLsync` fence handle. */
-export type GLsync = Handle;
+export type GLsync = ExternalObject<Handle>;
 
 /** An opaque native pointer handle (e.g. a `glMapBufferRange` mapping). */
-export type GLpointer = Handle;
+export type GLpointer = ExternalObject<Handle>;
 
 /** The C `GLenum` scalar. */
 export type GLenum = number;
@@ -41,24 +37,12 @@ export type GLshort = number;
 /** The C `GLushort` scalar. */
 export type GLushort = number;
 
-/** The C `GLfixed` scalar. */
-export type GLfixed = number;
-
-/** The C `GLclampx` scalar. */
-export type GLclampx = number;
-
 /** The C `GLfloat` scalar. */
 export type GLfloat = number;
 
-/** The C `GLclampf` scalar. */
-export type GLclampf = number;
-
 /** The C `GLdouble` scalar. */
 export type GLdouble = number;
 
-/** The C `GLclampd` scalar. */
-export type GLclampd = number;
-
 /** The C `GLint64` scalar. */
 export type GLint64 = number;
 

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from "./companion.js";
 export * from "./generated/commands.js";
 export * from "./generated/enums.js";
 export type * from "./generated/types.js";
+export * from "./overrides.js";

package/src/{companion.ts → overrides.ts}

@@ -1,5 +1,5 @@
-import { t } from "@gtkx/ffi";
-import { clientWaitSync, enable, getProgramiv, getProgramPipelineiv, getShaderiv } from "./generated/commands.js";
+import { t } from "@gtkx/runtime";
+import { clientWaitSync, enable, getProgramiv, getProgramPipelineiv, getShaderiv, LIB } from "./generated/commands.js";
 import {
     ALREADY_SIGNALED,
     CONDITION_SATISFIED,
@@ -8,9 +8,17 @@ import {
     INFO_LOG_LENGTH,
     TIMEOUT_EXPIRED,
 } from "./generated/enums.js";
-import type { GLbitfield, GLenum, GLint, GLsync, GLuint } from "./generated/types.js";
-
-const LIB = "libGL.so.1";
+import type {
+    DebugSeverity,
+    DebugSource,
+    DebugType,
+    GLenum,
+    GLint,
+    GLsync,
+    GLuint,
+    SyncObjectMask,
+    SyncStatus,
+} from "./generated/types.js";
 
 type LengthQuery = (id: GLuint, pname: GLenum) => GLint;
 
@@ -28,23 +36,46 @@ const readInfoLog = (symbol: string, id: GLuint, query: LengthQuery): string =>
     return log.value;
 };
 
+/**
+ * Reads the info log for a shader object, containing compilation diagnostics.
+ * @param shader The name of the shader object to query.
+ * @returns The shader info log, or an empty string when none is available.
+ */
 export function getShaderInfoLog(shader: GLuint): string {
     return readInfoLog("glGetShaderInfoLog", shader, getShaderiv);
 }
 
+/**
+ * Reads the info log for a program object, containing linking diagnostics.
+ * @param program The name of the program object to query.
+ * @returns The program info log, or an empty string when none is available.
+ */
 export function getProgramInfoLog(program: GLuint): string {
     return readInfoLog("glGetProgramInfoLog", program, getProgramiv);
 }
 
+/**
+ * Reads the info log for a program pipeline object, containing validation diagnostics.
+ * @param pipeline The name of the program pipeline object to query.
+ * @returns The pipeline info log, or an empty string when none is available.
+ */
 export function getProgramPipelineInfoLog(pipeline: GLuint): string {
     return readInfoLog("glGetProgramPipelineInfoLog", pipeline, getProgramPipelineiv);
 }
 
+/**
+ * Callback invoked for each GL debug message reported by the driver.
+ * @param source The origin of the message (API, window system, shader compiler, and so on).
+ * @param type The category of the message (error, deprecated behavior, performance, and so on).
+ * @param id The driver-assigned identifier of the message.
+ * @param severity The severity level of the message.
+ * @param message The human-readable message text.
+ */
 export type DebugMessageCallback = (
-    source: GLenum,
-    type: GLenum,
+    source: DebugSource,
+    type: DebugType,
     id: GLuint,
-    severity: GLenum,
+    severity: DebugSeverity,
     message: string,
 ) => void;
 
@@ -60,6 +91,11 @@ const glDebugMessageCallbackBinding = t.bind(
     t.void,
 );
 
+/**
+ * Installs a callback that receives GL debug messages, enabling synchronous debug output.
+ * Passing null removes any previously installed callback.
+ * @param callback The handler to invoke for each debug message, or null to clear it.
+ */
 export function debugMessageCallback(callback: DebugMessageCallback | null): void {
     if (callback === null) {
         glDebugMessageCallbackBinding(null);
@@ -75,7 +111,15 @@ export function debugMessageCallback(callback: DebugMessageCallback | null): voi
 
 const MAX_WAIT_CHUNK_NS = 1_000_000_000;
 
-export function clientWaitSyncLoop(sync: GLsync, flags: GLbitfield, timeoutNs: number): GLenum {
+/**
+ * Blocks until a sync object is signaled or the timeout elapses, looping over glClientWaitSync
+ * in bounded chunks so long waits are not truncated by the driver's per-call limit.
+ * @param sync The sync object (fence) to wait on.
+ * @param flags Flags controlling the wait, such as flushing pending commands on the first call.
+ * @param timeoutNs The total time to wait, in nanoseconds.
+ * @returns The status of the sync object: signaled, condition satisfied, or timeout expired.
+ */
+export function clientWaitSyncLoop(sync: GLsync, flags: SyncObjectMask, timeoutNs: number): SyncStatus {
     let remaining = timeoutNs;
     let currentFlags = flags;
     for (;;) {

package/dist/companion.d.ts

@@ -1,8 +0,0 @@
-import type { GLbitfield, GLenum, GLsync, GLuint } from "./generated/types.js";
-export declare function getShaderInfoLog(shader: GLuint): string;
-export declare function getProgramInfoLog(program: GLuint): string;
-export declare function getProgramPipelineInfoLog(pipeline: GLuint): string;
-export type DebugMessageCallback = (source: GLenum, type: GLenum, id: GLuint, severity: GLenum, message: string) => void;
-export declare function debugMessageCallback(callback: DebugMessageCallback | null): void;
-export declare function clientWaitSyncLoop(sync: GLsync, flags: GLbitfield, timeoutNs: number): GLenum;
-//# sourceMappingURL=companion.d.ts.map

package/dist/companion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"companion.d.ts","sourceRoot":"","sources":["../src/companion.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAS,MAAM,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAoBtF,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAElE;AAED,MAAM,MAAM,oBAAoB,GAAG,CAC/B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,KACd,IAAI,CAAC;AAcV,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI,GAAG,IAAI,CAWhF;AAID,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAY7F"}

package/dist/companion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"companion.js","sourceRoot":"","sources":["../src/companion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,WAAW,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAClH,OAAO,EACH,gBAAgB,EAChB,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,eAAe,GAClB,MAAM,sBAAsB,CAAC;AAG9B,MAAM,GAAG,GAAG,YAAY,CAAC;AAIzB,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,EAAU,EAAE,KAAkB,EAAU,EAAE;IAC3E,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;IAC1C,IAAI,MAAM,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;IAC7B,MAAM,GAAG,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IAC1B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CACjG,EAAE,EACF,MAAM,EACN,OAAO,EACP,GAAG,CACN,CAAC;IACF,OAAO,GAAG,CAAC,KAAK,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC3C,OAAO,WAAW,CAAC,oBAAoB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC7C,OAAO,WAAW,CAAC,qBAAqB,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,QAAgB;IACtD,OAAO,WAAW,CAAC,6BAA6B,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC;AACtF,CAAC;AAUD,MAAM,6BAA6B,GAAG,CAAC,CAAC,IAAI,CACxC,GAAG,EACH,wBAAwB,EACxB;IACI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE;QAClG,aAAa,EAAE,CAAC;QAChB,KAAK,EAAE,SAAS;KACnB,CAAC;CACL,EACD,CAAC,CAAC,IAAI,CACT,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAAC,QAAqC;IACtE,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACpB,6BAA6B,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO;IACX,CAAC;IACD,MAAM,CAAC,YAAY,CAAC,CAAC;IACrB,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACjC,6BAA6B,CACzB,CAAC,MAAc,EAAE,IAAY,EAAE,EAAU,EAAE,QAAgB,EAAE,OAAe,EAAE,OAAe,EAAE,EAAE,CAC7F,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CACpD,CAAC;AACN,CAAC;AAED,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAExC,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,KAAiB,EAAE,SAAiB;IACjF,IAAI,SAAS,GAAG,SAAS,CAAC;IAC1B,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,SAAS,CAAC;QACN,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QACzD,IAAI,MAAM,KAAK,gBAAgB,IAAI,MAAM,KAAK,mBAAmB;YAAE,OAAO,MAAM,CAAC;QACjF,IAAI,MAAM,KAAK,eAAe;YAAE,OAAO,MAAM,CAAC;QAC9C,SAAS,IAAI,KAAK,CAAC;QACnB,IAAI,SAAS,IAAI,CAAC;YAAE,OAAO,eAAe,CAAC;QAC3C,YAAY,GAAG,CAAC,CAAC;IACrB,CAAC;AACL,CAAC"}