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

    Class RetroScreenMaterial

    A highly specialized material for rendering retro screen effects (50s TV & 19th Century Film) locally on a mesh.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _renderManifest color cullMode depthTest depthWrite diffuseMap intensity mode param1 param2 param3 param4 speed time transparent type uuid

    Methods

    getRenderManifest getShaderDefinition

    Constructors

    Properties

    Protected_renderManifest

    _renderManifest: RenderManifest | undefined = undefined

    Cached render manifest to avoid frequent allocations.

    color: Color = Color.WHITE

    The base color of the material.

    cullMode: CullMode = CullMode.BACK

    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 screen's content texture.

    intensity: number

    Effect intensity.

    mode: RetroScreenMode

    Retro mode.

    param1: number
    param2: number
    param3: number
    param4: number
    speed: number

    Animation speed multiplier.

    time: number = 0.0

    Time parameter updated per frame.

    transparent: boolean = false

    Whether the material is transparent. Defaults to false.

    type: MaterialType

    The type of the material.

    uuid: string = ...

    The unique identifier of the material.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods