Class ControlIcon

constructor

• new ControlIcon(
      options?: {
          borderColor?: ColorSource;
          elevation?: number;
          size?: number;
          texture?: string | Texture<Resource>;
          tint?: ColorSource;
      },
  ): ControlIcon

  Parameters

  • Optionaloptions: {
        borderColor?: ColorSource;
        elevation?: number;
        size?: number;
        texture?: string | Texture<Resource>;
        tint?: ColorSource;
    } = {}

    • OptionalborderColor?: ColorSource

      The border color

    • Optionalelevation?: number

      The elevation

    • Optionalsize?: number

      The size of the icon

    • Optionaltexture?: string | Texture<Resource>

      The (URL of the) icon texture

    • Optionaltint?: ColorSource

      The icon tint

  Returns ControlIcon

bg

border

icon

tooltip

StaticRENDER_FLAG_PRIORITY

StaticRENDER_FLAGS

elevation

• get elevation(): number

  The elevation of the control icon, which is displayed in its tooltip text.

  Returns number

size

• get size(): number

  The size of the control icon.

  Returns number

texture

• get texture(): string | Texture<Resource>

  The (URL of the) icon texture used by this control icon.

  Returns string | Texture<Resource>

applyRenderFlags

• applyRenderFlags(): void

  Returns void

destroy

• destroy(options: any): void

  Parameters

  • options: any

  Returns void

  Inherit Doc

draw

• draw(): Promise<ControlIcon>

  Draw the visualization of this control icon.

  Returns Promise<ControlIcon>

refresh

• refresh(): any

  Refresh the visualization of this control icon.

  Returns any