Move unlit(), meshopt(), and draco() to /functions package (donmccurd…

…y#544) * [functions] Move unlit() to /functions * [functions] Move meshopt() to /functions * [functions] Move draco() to /functions
Scapic · Apr 7, 2022 · 1b32fe0 · 1b32fe0
1 parent 7ac7aa6
commit 1b32fe0
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 35 deletions.
diff --git a/packages/cli/src/cli.ts b/packages/cli/src/cli.ts
@@ -6,9 +6,9 @@ import { gzip } from 'node-gzip';
 import { program } from '@caporal/core';
 import { Logger, NodeIO, PropertyType, VertexLayout, vec2 } from '@gltf-transform/core';
 import { ALL_EXTENSIONS } from '@gltf-transform/extensions';
-import { CenterOptions, InstanceOptions, PartitionOptions, PruneOptions, QUANTIZE_DEFAULTS, ResampleOptions, SequenceOptions, TEXTURE_RESIZE_DEFAULTS, TextureResizeFilter, UnweldOptions, WeldOptions, center, dedup, instance, metalRough, partition, prune, quantize, resample, sequence, tangents, textureResize, unweld, weld, reorder, dequantize, oxipng, mozjpeg, webp } from '@gltf-transform/functions';
+import { CenterOptions, InstanceOptions, PartitionOptions, PruneOptions, QUANTIZE_DEFAULTS, ResampleOptions, SequenceOptions, TEXTURE_RESIZE_DEFAULTS, TextureResizeFilter, UnweldOptions, WeldOptions, center, dedup, instance, metalRough, partition, prune, quantize, resample, sequence, tangents, textureResize, unweld, weld, reorder, dequantize, oxipng, mozjpeg, webp, unlit, meshopt, MeshoptOptions, DRACO_DEFAULTS, draco, DracoOptions } from '@gltf-transform/functions';
 import { InspectFormat, inspect } from './inspect';
-import { DRACO_DEFAULTS, DracoCLIOptions, ETC1S_DEFAULTS, Filter, Mode, UASTC_DEFAULTS, draco, ktxfix, merge, toktx, unlit, meshopt, MeshoptCLIOptions, XMPOptions, xmp } from './transforms';
+import { ETC1S_DEFAULTS, Filter, Mode, UASTC_DEFAULTS, ktxfix, merge, toktx, XMPOptions, xmp } from './transforms';
 import { formatBytes, MICROMATCH_OPTIONS, underline } from './util';
 import { Session } from './session';
 import { ValidateOptions, validate } from './validate';
@@ -421,7 +421,7 @@ ${underline('References')}
 	.action(({args, options, logger}) =>
 		// Include a lossless weld — Draco requires indices.
 		Session.create(io, logger, args.input, args.output)
-			.transform(weld({tolerance: 0}), draco(options as unknown as DracoCLIOptions))
+			.transform(weld({tolerance: 0}), draco(options as unknown as DracoOptions))
 	);
 
 // MESHOPT
@@ -452,7 +452,7 @@ ${underline('References')}
 	})
 	.action(({args, options, logger}) =>
 		Session.create(io, logger, args.input, args.output)
-				.transform(meshopt(options as unknown as MeshoptCLIOptions))
+				.transform(meshopt(options as unknown as MeshoptOptions))
 	);
 
 // QUANTIZE

diff --git a/packages/cli/src/transforms/index.ts b/packages/cli/src/transforms/index.ts
@@ -1,7 +1,4 @@
-export * from './draco';
 export * from './ktxfix';
 export * from './merge';
-export * from './meshopt';
 export * from './toktx';
-export * from './unlit';
 export * from './xmp';
diff --git a/packages/cli/test/cli.test.ts b/packages/cli/test/cli.test.ts
@@ -4,7 +4,7 @@ import fs from 'fs';
 import test from 'tape';
 import tmp from 'tmp';
 import { Document, FileUtils, NodeIO } from '@gltf-transform/core';
-import { draco, program, programReady, unlit } from '../';
+import { program, programReady } from '../';
 
 tmp.setGracefulCleanup();
 
@@ -100,21 +100,3 @@ test('@gltf-transform/cli::merge', async (t) => {
 			})
 	);
 });
-
-test('@gltf-transform/cli::draco', async (t) => {
-	const doc = new Document();
-	await doc.transform(draco({ method: 'edgebreaker' }));
-	await doc.transform(draco({ method: 'sequential' }));
-	const dracoExtension = doc.getRoot().listExtensionsUsed()[0];
-	t.equals(dracoExtension.extensionName, 'KHR_draco_mesh_compression', 'adds extension');
-	t.end();
-});
-
-test('@gltf-transform/cli::unlit', async (t) => {
-	const doc = new Document();
-	doc.createMaterial();
-	await doc.transform(unlit());
-	const unlitExtension = doc.getRoot().listExtensionsUsed()[0];
-	t.equals(unlitExtension.extensionName, 'KHR_materials_unlit', 'adds extension');
-	t.end();
-});
diff --git a/packages/cli/src/transforms/draco.ts → packages/functions/src/draco.ts b/packages/cli/src/transforms/draco.ts → packages/functions/src/draco.ts
@@ -1,7 +1,7 @@
 import { Document, Transform } from '@gltf-transform/core';
 import { DracoMeshCompression } from '@gltf-transform/extensions';
 
-export interface DracoCLIOptions {
+export interface DracoOptions {
 	method?: 'edgebreaker' | 'sequential';
 	encodeSpeed?: number;
 	decodeSpeed?: number;
@@ -13,7 +13,7 @@ export interface DracoCLIOptions {
 	quantizationVolume?: 'mesh' | 'scene';
 }
 
-export const DRACO_DEFAULTS: DracoCLIOptions = {
+export const DRACO_DEFAULTS: DracoOptions = {
 	method: 'edgebreaker',
 	encodeSpeed: 5,
 	decodeSpeed: 5,
@@ -25,8 +25,14 @@ export const DRACO_DEFAULTS: DracoCLIOptions = {
 	quantizationVolume: 'mesh',
 };
 
-export const draco = (_options: DracoCLIOptions): Transform => {
-	const options = { ...DRACO_DEFAULTS, ..._options } as Required<DracoCLIOptions>;
+/**
+ * Applies Draco compression using {@link DracoMeshCompression KHR_draco_mesh_compression}.
+ * This type of compression can reduce the size of triangle geometry.
+ *
+ * This function is a thin wrapper around the {@link DracoMeshCompression} extension itself.
+ */
+export const draco = (_options: DracoOptions): Transform => {
+	const options = { ...DRACO_DEFAULTS, ..._options } as Required<DracoOptions>;
 	return (doc: Document): void => {
 		doc.createExtension(DracoMeshCompression)
 			.setRequired(true)

diff --git a/packages/functions/src/index.ts b/packages/functions/src/index.ts
@@ -42,8 +42,10 @@ export * from './center';
 export * from './colorspace';
 export * from './dedup';
 export * from './dequantize';
+export * from './draco';
 export * from './inspect';
 export * from './instance';
+export * from './meshopt';
 export * from './metal-rough';
 export * from './normals';
 export * from './partition';
@@ -55,6 +57,7 @@ export * from './sequence';
 export * from './squoosh';
 export * from './tangents';
 export * from './texture-resize';
+export * from './unlit';
 export * from './unweld';
 export * from './weld';
 export * from './list-texture-channels';

diff --git a/packages/cli/src/transforms/meshopt.ts → packages/functions/src/meshopt.ts b/packages/cli/src/transforms/meshopt.ts → packages/functions/src/meshopt.ts
@@ -3,13 +3,23 @@ import { MeshoptCompression } from '@gltf-transform/extensions';
 import { reorder, quantize } from '@gltf-transform/functions';
 import { MeshoptEncoder } from 'meshoptimizer';
 
-export interface MeshoptCLIOptions {
+export interface MeshoptOptions {
 	level?: 'medium' | 'high';
 }
-export const MESHOPT_DEFAULTS: Required<MeshoptCLIOptions> = { level: 'high' };
+export const MESHOPT_DEFAULTS: Required<MeshoptOptions> = { level: 'high' };
 
-export const meshopt = (_options: MeshoptCLIOptions): Transform => {
-	const options = { ...MESHOPT_DEFAULTS, ..._options } as Required<MeshoptCLIOptions>;
+/**
+ * Applies Meshopt compression using {@link MeshoptCompression EXT_meshopt_compression}.
+ * This type of compression can reduce the size of point, line, and triangle geometry,
+ * morph targets, and animation data.
+ *
+ * This function is a thin wrapper around {@link reorder}, {@link quantize}, and
+ * {@link MeshoptCompression}, and exposes relatively few configuration options.
+ * To access more options (like quantization bits) direct use of the underlying
+ * functions is recommended.
+ */
+export const meshopt = (_options: MeshoptOptions): Transform => {
+	const options = { ...MESHOPT_DEFAULTS, ..._options } as Required<MeshoptOptions>;
 	return async (document: Document): Promise<void> => {
 		await document.transform(
 			reorder({

diff --git a/packages/cli/src/transforms/unlit.ts → packages/functions/src/unlit.ts b/packages/cli/src/transforms/unlit.ts → packages/functions/src/unlit.ts
@@ -1,4 +1,4 @@
-import { Document, Transform } from '@gltf-transform/core';
+import type { Document, Transform } from '@gltf-transform/core';
 import { MaterialsUnlit } from '@gltf-transform/extensions';
 
 export const unlit = (): Transform => {

diff --git a/packages/functions/test/draco.test.ts b/packages/functions/test/draco.test.ts
@@ -0,0 +1,12 @@
+import test from 'tape';
+import { Document } from '@gltf-transform/core';
+import { draco } from '../';
+
+test('@gltf-transform/functions::draco', async (t) => {
+	const document = new Document();
+	await document.transform(draco({ method: 'edgebreaker' }));
+	await document.transform(draco({ method: 'sequential' }));
+	const dracoExtension = document.getRoot().listExtensionsUsed()[0];
+	t.equals(dracoExtension.extensionName, 'KHR_draco_mesh_compression', 'adds extension');
+	t.end();
+});
diff --git a/packages/functions/test/unlit.test.ts b/packages/functions/test/unlit.test.ts
@@ -0,0 +1,12 @@
+import test from 'tape';
+import { Document } from '@gltf-transform/core';
+import { unlit } from '../';
+
+test('@gltf-transform/functions::unlit', async (t) => {
+	const document = new Document();
+	document.createMaterial();
+	await document.transform(unlit());
+	const unlitExtension = document.getRoot().listExtensionsUsed()[0];
+	t.equals(unlitExtension.extensionName, 'KHR_materials_unlit', 'adds extension');
+	t.end();
+});