Skip to content

README.md

Latest commit

 

History

History
104 lines (83 loc) · 2.99 KB

README.md

File metadata and controls

104 lines (83 loc) · 2.99 KB

NEEDLE Progressive Extensions Schema

This document describes the NEEDLE_progressive mesh and texture extensions that are used for progressive loading with gltf-progressive.

Extension Types

NEEDLE_progressive texture extension

Texture extension for progressive texture loading, inheriting from NEEDLE_progressive_base.

Property Type Required Description
guid string Yes Inherited from base type
lods Array<TextureLOD> Yes Array of texture LOD levels with dimensions

TextureLOD Properties:

Property Type Required Description
path string Yes Relative path to the texture LOD file
hash string No Optional hash for file verification
width number Yes Texture width in pixels
height number Yes Texture height in pixels

Example

{
  "guid": "texture-asset-123",
  "lods": [
    {
      "path": "./textures/image_diffuse_1024.glb",
      "hash": "abc123",
      "width": 1024,
      "height": 1024
    },
    {
      "path": "./textures/image_diffuse_512.glb",
      "width": 512,
      "height": 512
    }
  ]
}

NEEDLE_progressive mesh extension

Mesh extension for progressive mesh loading, inheriting from NEEDLE_progressive_base.

Property Type Required Description
guid string Yes Inherited from base type
lods Array<MeshLOD> Yes Array of mesh LOD levels with geometry data

MeshLOD Properties:

Property Type Required Description
path string Yes Relative path to the mesh LOD file
hash string No Optional hash for file verification
densities number[] Yes Density values per primitive
indexCount number No Number of indices in LOD0
vertexCount number No Number of vertices in LOD0
Example
{
  "guid": "mesh-asset-456",
  "lods": [
    {
      "path": "./meshes/mesh_0_high_detail.glb",
      "hash": "def456",
      "indexCount": 15000,
      "vertexCount": 8000,
      "densities": [100000, 50000]
    },
    {
      "path": "./meshes/mesh_1_low_detail.glb",
      "indexCount": 3000,
      "vertexCount": 1500,
      "densities": [100000, 50000]
    }
  ]
}

Base Types

LOD

Represents a single Level of Detail (LOD) file reference.

Property Type Required Description
path string Yes Relative path to the LOD file
hash string No Optional hash for file verification

NEEDLE_progressive_base

Base extension format for progressive assets.

Property Type Required Description
guid string Yes Unique identifier of the object (texture, mesh) the LODs belong to
lods Array<LOD> Yes Array of available LOD levels