zeux / meshoptimizer

Mesh optimization library that makes meshes smaller and faster to render
MIT License
5.49k stars 473 forks source link

Documentation direction Encoder User Guide #666

Closed RyugaRyuzaki closed 5 months ago

RyugaRyuzaki commented 5 months ago

This library is amazing. However, it would help everyone if the author could create user manuals for each feature. for an example:

zeux commented 5 months ago

js APIs are documented here: https://github.com/zeux/meshoptimizer/blob/master/js/README.md

MeshoptEncoder in particular is designed for use by projects like gltf-transform; Decoder is already integrated into three’s gltf loader.

zeux commented 5 months ago

So just to clarify, the expected flow is that you use gltfpack or glTF-Transform to encode (the latter uses JS version of meshoptimizer), and if you use THREE's glTF loader to load the file (which has meshopt decoder integrated with examples available in THREE's repository), things will just work. The JS library is meant for processing tools and loaders, as the README linked above indicates.

If further questions arsie I would recommend using Discussions instead of Issues.

RyugaRyuzaki commented 5 months ago

So just to clarify, the expected flow is that you use gltfpack or glTF-Transform to encode (the latter uses JS version of meshoptimizer), and if you use THREE's glTF loader to load the file (which has meshopt decoder integrated with examples available in THREE's repository), things will just work. The JS library is meant for processing tools and loaders, as the README linked above indicates.

If further questions arsie I would recommend using Discussions instead of Issues.

I'm really sorry, i will move it to Discussion