Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface RenderManifest

    The RenderManifest is the "order sheet" that a material passes to the renderer to describe its requirements.

    interface RenderManifest {
        flags?: string[];
        properties: Record<string, unknown>;
        shaderId: string;
        state?: {
            blending?: BlendingMode;
            culling?: CullMode;
            depthTest?: boolean;
            depthWrite?: boolean;
            isSprite?: boolean;
            skipDepthPrePass?: boolean;
            topology?: Topology;
            transparent?: boolean;
            wireframeMode?: "structural" | "triangles";
        };
        textures: Record<string, Texture | CubeTexture | undefined>;
    }
    Index
    flags? properties shaderId state? textures
    flags?: string[]

    Optional shader flags to compile variants (e.g. USE_TEXTURE_ARRAY)

    properties: Record<string, unknown>

    The properties (uniforms) for the material. Key: Property name as defined in ShaderDefinition layout.

    shaderId: string

    The ID of the shader to use.

    state?: {
        blending?: BlendingMode;
        culling?: CullMode;
        depthTest?: boolean;
        depthWrite?: boolean;
        isSprite?: boolean;
        skipDepthPrePass?: boolean;
        topology?: Topology;
        transparent?: boolean;
        wireframeMode?: "structural" | "triangles";
    }

    Optional GPU state overrides for this specific draw call.

    Type Declaration

    • Optionalblending?: BlendingMode
    • Optionalculling?: CullMode
    • OptionaldepthTest?: boolean
    • OptionaldepthWrite?: boolean
    • OptionalisSprite?: boolean

      Whether this object should be treated as a camera-facing sprite (billboarding).

    • OptionalskipDepthPrePass?: boolean

      Opt-out of the GPU depth pre-pass (see DepthPrePassGPU). Materials whose custom shading the shared depth pipeline cannot faithfully reproduce (custom shaders with world-space vertex deformation) or geometries that must never occlude (wireframes, sprites) set this to true so the pre-pass skips them WITHOUT having to maintain a growing list of shaderIds/prefixes in the pass itself. Note this is independent of depthWrite/transparent -- a material may still legitimately want to write depth in its OWN pass while staying out of the pre-pass.

    • Optionaltopology?: Topology

      The primitive topology (e.g., TRIANGLE_LIST or LINE_LIST). Defaults to TRIANGLE_LIST.

    • Optionaltransparent?: boolean
    • OptionalwireframeMode?: "structural" | "triangles"

      The wireframe mode. Defaults to "structural".

    textures: Record<string, Texture | CubeTexture | undefined>

    The textures for the material. Key: Texture name as defined in ShaderDefinition layout.

    Settings
    Member Visibility

    On This Page
    Properties