Taos API Reference
    Preparing search index...

    Interface ProjectorOptions

    Construction options for Projector. Every field is optional and maps to the like-named property; omitted fields keep the property default. Vec/object fields are adopted by reference.

    interface ProjectorOptions {
        source?: ProjectorSource | null;
        shape?: ProjectorShape;
        fovY?: number;
        focalLength?: number | null;
        sensorHeight?: number;
        aspect?: number;
        orthoWidth?: number;
        orthoHeight?: number;
        near?: number;
        far?: number;
        tint?: Vec3;
        opacity?: number;
        blend?: ProjectorBlend;
        lit?: boolean;
        crop?: UvRect;
        edgeFalloff?: number;
        programId?: string | null;
    }
    Index

    Properties

    source? shape? fovY? focalLength? sensorHeight? aspect? orthoWidth? orthoHeight? near? far? tint? opacity? blend? lit? crop? edgeFalloff? programId?

    Properties

    source?: ProjectorSource | null

    Texture/video the projector samples (Projector.source).

    shape?: ProjectorShape

    Frustum shape (Projector.shape).

    fovY?: number

    Vertical field of view in degrees (Projector.fovY).

    focalLength?: number | null

    Physical focal length in mm (Projector.focalLength).

    sensorHeight?: number

    Sensor height in mm (Projector.sensorHeight).

    aspect?: number

    Image aspect ratio (Projector.aspect).

    orthoWidth?: number

    Ortho frustum width (Projector.orthoWidth).

    orthoHeight?: number

    Ortho frustum height (Projector.orthoHeight).

    near?: number

    Near plane (Projector.near).

    far?: number

    Far plane (Projector.far).

    tint?: Vec3

    Linear RGB tint (Projector.tint). Adopted by reference.

    opacity?: number

    Overall strength in [0,1] (Projector.opacity).

    blend?: ProjectorBlend

    Blend mode (Projector.blend).

    lit?: boolean

    Composite before lighting as a lit surface (Projector.lit).

    crop?: UvRect

    Source crop sub-rectangle (Projector.crop). Adopted by reference.

    edgeFalloff?: number

    Frustum-edge falloff fraction (Projector.edgeFalloff).

    programId?: string | null

    Custom projection program id (Projector.programId).

    Settings

    Member Visibility

    On This Page

    Properties