tecs.gfx.models

function newMaterial(options: MaterialOptions): MaterialInput

function newMesh(options: MeshOptions): MeshInput, BoundsInput

record Animation
    name: string
    duration: number
    channels: {Channel}
end

record BoundsInput<T, C>
    componentType: C
    value: T
end

record Instance
    primitives: {Primitive}
    transform: mesh.Transform3D?
    animation: integer
    time: number
    speed: number
    loop: boolean
    playing: boolean
    bind: function(exclusive self: Instance, world: World, primitive: integer, entity: integer): nil
    unbind: function(exclusive self: Instance, primitive: integer): nil
    play: function(exclusive self: Instance, animation: string | integer, options: PlayOptions?): nil
    sample: function(exclusive self: Instance, animation: string | integer, time: number, loop: boolean?): nil
    update: function(exclusive self: Instance, dt: number): nil
end

type LoadOptions = {
    --- Caller-writable. Tunes each decoded material before its upload is queued.
    --- @param value The callback receives the material's authored values in place.
    --- @return The callback returns no value.
    material: function(exclusive value: MaterialInfo): nil
}

type MaterialInfo = {
    --- Caller-writable. Names the authored material.
    name: string,

    --- Caller-writable. Selects metallic-roughness (0), unlit (1), or Lambert (2).
    model: integer,

    --- Caller-writable. Sets the metallic factor from zero to one.
    metallic: number,

    --- Caller-writable. Sets the perceptual roughness from zero to one.
    roughness: number
}

record MaterialInput<T, C>
    componentType: C
    value: T
end

type MaterialOptions = {
    --- Caller-writable. Names the shared material with a stable, non-empty identity.
    name: string,

    --- Caller-writable. Selects a MATERIAL_* model; metallic-roughness is the default.
    model: integer?,

    --- Caller-writable. Sets linear red reflectance and defaults to one.
    baseR: number?,

    --- Caller-writable. Sets linear green reflectance and defaults to one.
    baseG: number?,

    --- Caller-writable. Sets linear blue reflectance and defaults to one.
    baseB: number?,

    --- Caller-writable. Sets opacity from zero to one and defaults to one.
    baseA: number?,

    --- Caller-writable. Sets linear red emission and defaults to zero.
    emissiveR: number?,

    --- Caller-writable. Sets linear green emission and defaults to zero.
    emissiveG: number?,

    --- Caller-writable. Sets linear blue emission and defaults to zero.
    emissiveB: number?,

    --- Caller-writable. Sets the metallic factor from zero to one and defaults to zero.
    metallic: number?,

    --- Caller-writable. Sets perceptual roughness from zero to one and defaults to one.
    roughness: number?,

    --- Caller-writable. Scales the normal map XY channels and defaults to one.
    normalScale: number?,

    --- Caller-writable. Sets occlusion strength from zero to one and defaults to one.
    occlusionStrength: number?,

    --- Caller-writable. Selects opaque, mask, or blend and defaults to opaque.
    alphaMode: string?,

    --- Caller-writable. Sets the mask threshold from zero to one and defaults to 0.5.
    alphaCutoff: number?,

    --- Caller-writable. Disables back-face culling when true and defaults to false.
    doubleSided: boolean?,

    --- Caller-writable. Names the optional base-color texture, sampled as sRGB.
    baseMap: string?,

    --- Caller-writable. Names the optional tangent-space normal texture, sampled as
    --- linear data.
    normalMap: string?,

    --- Caller-writable. Names the optional linear texture with roughness in green and
    --- metallic in blue.
    metallicRoughnessMap: string?,

    --- Caller-writable. Names the optional linear texture with occlusion in red.
    occlusionMap: string?,

    --- Caller-writable. Names the optional emission texture, sampled as sRGB.
    emissionMap: string?
}

record MeshInput<T, C>
    componentType: C
    value: T
end

type MeshOptions = {
    --- Caller-writable. Names shared geometry with a stable, non-empty identity.
    name: string,

    --- Caller-writable. Supplies twelve floats per vertex: position XYZ, normal XYZ,
    --- tangent XYZW and texture UV.
    vertices: {number},

    --- Caller-writable. Supplies zero-based triangle indices, three per triangle.
    indices: {integer},

    --- Caller-writable. Optionally supplies four linear RGBA values per vertex.
    colors: {number}?,

    --- Caller-writable. Optionally supplies four zero-based joint indices per vertex.
    joints: {integer}?,

    --- Caller-writable. Supplies four nonnegative weights with each joint quartet.
    --- Each quartet must have positive total; the constructor normalizes it.
    weights: {number}?
}

record Model
    path: string
    id: integer
    animations: {Animation}
    animationCount: integer
    newInstance: function(self: Model): Instance
    animationIndex: function(borrows self: Model, name: string): integer?
end

type PlayOptions = {
    --- Caller-writable. Multiplies elapsed time. Negative values raise on
    --- `update`.
    speed: number?,

    --- Caller-writable. Controls whether playback wraps at the duration.
    loop: boolean?,

    --- Caller-writable. Controls whether `update` advances playback.
    playing: boolean?
}

record Primitive
    transform: TransformInput
    mesh: MeshInput
    bounds: BoundsInput
    material: MaterialInput
    skin: SkinInput
    morph: MorphInput
    materialName: string = ""
end

function load(path: string, options: LoadOptions?): Model?, string?

function loadEnvironment(name: string, faces: {string}): string?, string?

function nextUpload(): integer, string

const MATERIAL_LAMBERT: integer

const MATERIAL_METALLIC_ROUGHNESS: integer

const MATERIAL_UNLIT: integer