@draco-rust/decoder 0.1.0 → 0.1.2

package/legacy/index.d.ts

@@ -1,6 +1,76 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/** The name of a typed array `decode_draco` can convert an attribute to. */
+export type DracoArrayType =
+| "Int8Array" | "Uint8Array" | "Int16Array" | "Uint16Array"
+| "Int32Array" | "Uint32Array" | "Float32Array";
+
+/** A Draco attribute type, as `semantic` names it. */
+export type DracoSemantic = "POSITION" | "NORMAL" | "COLOR" | "TEX_COORD" | "GENERIC";
+
+/**
+ * One attribute to decode: by `id`, its unique id, or by `semantic`, the first
+ * attribute of that type. `name` is handed back unchanged.
+ */
+export interface DracoAttributeRequest {
+    name?: string;
+    id?: number;
+    semantic?: DracoSemantic;
+    type?: DracoArrayType;
+}
+
+/** The typed arrays an attribute can come back in. */
+export type DracoArray =
+| Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array
+| Float32Array | Float64Array | BigInt64Array | BigUint64Array;
+
+export interface DracoAttribute {
+    /** The request's `name`, or else the name the stream's metadata gives it. */
+    name?: string;
+    uniqueId: number;
+    semantic: DracoSemantic;
+    array: DracoArray;
+    itemSize: number;
+    normalized: boolean;
+}
+
+export interface DracoDecodeResult {
+    success: boolean;
+    error?: string;
+    warnings: string[];
+    geometry?: "mesh" | "point_cloud";
+    /** Triangle corners for a mesh, `null` for a point cloud. */
+    index: Uint32Array | null;
+    attributes: DracoAttribute[];
+}
+
+
+
+/**
+ * Decodes a Draco stream and returns its attributes as typed arrays.
+ *
+ * `attributes` is `undefined` for every attribute in its own component type,
+ * or an array of requests `{ name, id, semantic, type }`:
+ *
+ * - `id`, a unique id, finds that attribute, as glTF's
+ *   `KHR_draco_mesh_compression` names them; a missing one is an error.
+ * - `semantic` (`"POSITION"`, `"NORMAL"`, `"COLOR"`, `"TEX_COORD"` or
+ *   `"GENERIC"`) finds the first attribute of that type instead, as a `.drc`
+ *   file is read; a missing one is left out.
+ * - `type`, a typed array's name such as `"Float32Array"` or
+ *   `"Uint16Array"`, converts the values the way upstream's
+ *   `GetAttributeDataArrayForAllPoints` does; without it the values keep
+ *   their own type. A value the type cannot hold is an error.
+ *
+ * The result is `{ success, error, warnings, geometry, index, attributes }`,
+ * where `geometry` is `"mesh"` or `"point_cloud"` as the stream's header says,
+ * `index` a `Uint32Array` of triangle corners for a mesh and `null` for a
+ * point cloud, and each attribute `{ name, uniqueId, semantic, array,
+ * itemSize, normalized }`.
+ */
+export function decode_draco(data: Uint8Array, attributes: DracoAttributeRequest[] | undefined): DracoDecodeResult;
+
 /**
  * Install the panic hook, so a panic reads as a message rather than a trap.
  */
@@ -24,36 +94,38 @@ export function version(): string;
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly parse_drc_bytes: (a: number, b: number) => number;
-  readonly supported_extensions: (a: number) => void;
-  readonly version: (a: number) => void;
-  readonly init: () => void;
-  readonly __wbindgen_export: (a: number) => void;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly __wbindgen_export2: (a: number, b: number, c: number) => void;
-  readonly __wbindgen_export3: (a: number, b: number) => number;
-  readonly __wbindgen_start: () => void;
+    readonly memory: WebAssembly.Memory;
+    readonly decode_draco: (a: number, b: number, c: number) => number;
+    readonly init: () => void;
+    readonly parse_drc_bytes: (a: number, b: number) => number;
+    readonly supported_extensions: (a: number) => void;
+    readonly version: (a: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
 
 /**
-* Instantiates the given `module`, which can either be bytes or
-* a precompiled `WebAssembly.Module`.
-*
-* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
-*
-* @returns {InitOutput}
-*/
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
 export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
 
 /**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
-*
-* @returns {Promise<InitOutput>}
-*/
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
 export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;