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

    Class StandardMaterial

    A physically based rendering (PBR) material using the Metallic-Roughness workflow.

    Hierarchy (View Summary)

    Index
    constructor
    _renderManifest alphaMap alphaTest ao color cullMode depthTest depthWrite diffuseMap emissiveColor emissiveIntensity emissiveMap envMap metallic metallicMap normalMap normalScale reflectionMap reflectivity roughness roughnessMap time transparent type uuid
    _createBaseManifest _syncBaseManifestState _syncTexOffsetRepeat clone getRenderManifest getShaderDefinition

    Protected_renderManifest

    _renderManifest: RenderManifest | undefined = undefined

    Cached render manifest to avoid frequent allocations.

    alphaMap: Texture | undefined

    The alpha mask texture map.

    alphaTest: number

    Alpha cutoff threshold.

    ao: number

    Ambient occlusion factor (0 to 1).

    color: Color = Color.WHITE

    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.

    diffuseMap: Texture | undefined

    The diffuse texture map.

    emissiveColor: Color

    The emissive color.

    emissiveIntensity: number

    The intensity of the emissive glow.

    emissiveMap: Texture | undefined

    The emissive map texture.

    envMap: CubeTexture | undefined

    The environment map for reflections.

    metallic: number

    Metallic factor (0 to 1).

    metallicMap: Texture | undefined

    The metallic map texture.

    normalMap: Texture | undefined

    The normal map texture.

    normalScale: Vector2D

    Scale factor for the normal map to control strength and flip X/Y.

    reflectionMap: Texture | undefined

    The planar reflection map.

    reflectivity: number

    The intensity of the planar reflection.

    roughness: number

    Roughness factor (0 to 1).

    roughnessMap: Texture | undefined

    The roughness map texture.

    time: number

    Time parameter for shader animations.

    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.

    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

    • Creates an independent copy of this material. Useful before mutating per-instance properties (e.g. an emissive hover glow) on a material that might be shared across multiple objects, where a direct mutation would visibly affect all of them at once.

      Returns StandardMaterial

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods