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

    Class CustomShaderMaterial

    A highly flexible material that allows developers to write entirely custom shader code (WGSL and GLSL) without modifying the core engine chunks. Perfect for very specific visual effects.

    Hierarchy (View Summary)

    Index
    constructor
    _renderManifest color cullMode depthTest depthWrite layout properties sources textures transparent type uuid inspector
    _createBaseManifest _syncBaseManifestState _syncTexOffsetRepeat clone getRenderManifest getShaderDefinition setProperty setTexture

    Protected_renderManifest

    _renderManifest: RenderManifest | undefined = undefined

    Cached render manifest to avoid frequent allocations.

    color: Color = ...

    The base color of the material.

    cullMode: CullMode = CullMode.DEFAULT

    The culling mode for this material. Defaults to BACK.

    depthTest: boolean = true

    Whether the material performs depth testing. Defaults to true.

    depthWrite: boolean = true

    Whether the material writes to the depth buffer. Defaults to true.

    layout: ShaderLayout
    properties: Record<string, unknown>
    sources: {
        glsl100?: { fs: string; vs: string };
        glsl300?: { fs: string; vs: string };
        wgsl?: string;
    }
    textures: Record<string, Texture | CubeTexture | undefined>
    transparent: boolean = false

    Whether the material is transparent. Defaults to false.

    type: string

    The type of the material.

    uuid: string = ...

    The unique identifier of the material.

    inspector: Record<string, InspectorField> = ...

    Fields common to every material, merged with a concrete subclass's own inspector map (e.g. StandardMaterial's metallic/roughness) via collectInspectorSchema().

    Protected_createBaseManifest

    Protected_syncBaseManifestState

    Protected_syncTexOffsetRepeat

    • _syncTexOffsetRepeat(
          tex:
              | {
                  offset: { x: number; y: number };
                  repeat: { x: number; y: number };
              }
              | undefined,
      ): void

      Helper to synchronize texture offset and repeat from a given texture.

      Parameters

      • tex:
            | { offset: { x: number; y: number }; repeat: { x: number; y: number } }
            | undefined

      Returns void

    • Returns an independent copy of this material (own uuid, own color/other value-type fields) -- geometry-adjacent references like texture maps stay shared, since texture data is immutable. Used by Object3D.clone() (Maker's Duplicate command) so a duplicated object's material edits don't leak back onto the original.

      Returns AbstractMaterial

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods