Interface BrushOptions

blend_modes

floor_coordinates

offset_even_radius

opacity

shapes

size

softness

changePixel

• changePixel(
      pixel_x: number,
      pixel_y: number,
      pixel_color: RGBAColor,
      local_opacity: number,
      PaintContext: PaintContext,
  ): RGBAColor

  Function that runs per pixel when the brush is used. Mutually exclusive with draw().

  Parameters

  • pixel_x: number

    Local X coordinate relative to the brush center

  • pixel_y: number

    Local Y coordinate relative to the brush center

  • pixel_color: RGBAColor

    Current color of the pixel on the texture

  • local_opacity: number

    Local opacity of the current pixel on the brush, between 0 and 1. Opacity falls of to the sides of the brush if the brush is set to smooth. Opacity from the Opacity slider is not factored in yet.

  • PaintContext: PaintContext

    Additional context to the paint stroke

  Returns RGBAColor

draw

• draw(
      context: {
          ctx: CanvasRenderingContext2D;
          event: PointerEvent;
          size: number;
          softness: number;
          texture: Texture;
          x: number;
          y: number;
      },
  ): void

  Alternative way to create a custom brush, mutually exclusive with the changePixel() function. Draw runs once every time the brush starts or moves, and also along the bath on lines.

  Parameters

  • context: {
        ctx: CanvasRenderingContext2D;
        event: PointerEvent;
        size: number;
        softness: number;
        texture: Texture;
        x: number;
        y: number;
    }

  Returns void

onStrokeEnd

• onStrokeEnd(
      context: {
          raycast_data: RaycastResult;
          texture: Texture;
          uv?: any;
          x: number;
          y: number;
      },
  ): void

  Function that runs when a new brush stroke starts.

  Parameters

  • context: {
        raycast_data: RaycastResult;
        texture: Texture;
        uv?: any;
        x: number;
        y: number;
    }

  Returns void

onStrokeMove

• onStrokeMove(
      context: {
          event: PointerEvent;
          raycast_data: RaycastResult;
          texture: Texture;
          uv?: any;
          x: number;
          y: number;
      },
  ): boolean

  Function that runs when a new brush stroke starts. Return false to cancel the brush stroke

  Parameters

  • context: {
        event: PointerEvent;
        raycast_data: RaycastResult;
        texture: Texture;
        uv?: any;
        x: number;
        y: number;
    }

  Returns boolean

onStrokeStart

• onStrokeStart(
      context: {
          event: PointerEvent;
          raycast_data: RaycastResult;
          texture: Texture;
          uv?: any;
          x: number;
          y: number;
      },
  ): boolean

  Function that runs when a new brush stroke starts. Return false to cancel the brush stroke

  Parameters

  • context: {
        event: PointerEvent;
        raycast_data: RaycastResult;
        texture: Texture;
        uv?: any;
        x: number;
        y: number;
    }

  Returns boolean