Lens Scripting API
    Preparing search index...

    Class TextFill

    Fill settings used by several text related classes.

    Used in Text's textFill property, DropshadowSettings' fill property, and OutlineSettings' fill property.

    Used By: BackgroundSettings#fill, DropshadowSettings#fill, OutlineSettings#fill, Text#textFill

    // @input Component.Text textComponent

    script.textComponent.textFill.mode = TextFillMode.Solid;

    script.textComponent.textFill.color = new vec4(1, 0, 0, 1);

    Hierarchy (View Summary)

    Index

    Properties

    color colorTint mode texture textureStretch tileCount tileZone

    Methods

    getTypeName isOfType isSame

    Properties

    color: vec4

    If mode is set to TextFillMode.Solid, this will be used as the solid color used in drawing.

    colorTint: vec4

    If mode is set to TextFillMode.Texture, this will be used as the color tint over the texture.

    mode: TextFillMode

    Controls which drawing method is used. Can switch between Texture mode (for drawing using a tiled texture) or Solid mode (for drawing a solid color).

    texture: Texture

    If mode is set to TextFillMode.Texture, this will be used as the texture asset used in drawing.

    textureStretch: StretchMode

    If mode is set to TextFillMode.Texture, this defines what type of stretching is used when the Texture's aspect ratio doesn't match the drawing area's aspect ratio.

    tileCount: number

    If mode is set to TextFillMode.Texture, this defines how many times the texture will tile across its drawing zone.

    tileZone: TileZone

    If mode is set to TextFillMode.Texture, this defines what area should be used for tiling the texture.

    Methods

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods