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

    Interface RetroScreenMaterialOptions

    Configuration options for RetroScreenMaterial.

    interface RetroScreenMaterialOptions {
        diffuseMap?: Texture;
        intensity?: number;
        mode?: RetroScreenMode;
        param1?: number;
        param2?: number;
        param3?: number;
        param4?: number;
        speed?: number;
    }
    Index

    Properties

    diffuseMap? intensity? mode? param1? param2? param3? param4? speed?

    Properties

    diffuseMap?: Texture

    The diffuse texture containing screen contents.

    intensity?: number

    Overall intensity of the retro effects (0.0 to 1.0). Defaults to 1.0.

    mode?: RetroScreenMode

    Active retro screen mode. Defaults to "tv50s".

    param1?: number

    TV: snow density, Film: scratch count scale.

    param2?: number

    TV: scanline count/scale, Film: flicker speed multiplier.

    param3?: number

    TV: tearing freq/strength, Film: dirt density.

    param4?: number

    TV: roll speed multiplier, Film: sepia strength multiplier.

    speed?: number

    Custom speed multiplier for animations. Defaults to 1.0.

    Settings

    Member Visibility

    On This Page

    Properties