Painter

Painter

Namespace

A global namespace containing various functionality for Blockbench's 2D and 3D paint tools and texture editor

Property	Type	Description
currentPixel	ArrayVector2
brushChanges	boolean
current	any
selection	any
mirror_painting	boolean
lock_alpha	boolean
erase_mode	boolean
default_brush_presets	Array of any

edit( texture, callback, options )

Arguments:

• texture: Texture
• callback: See types
• options: TextureEditOptions
  • method: "canvas" or "jimp" (Optional) - Edit method. 'canvas' is default
  • edit_name: string (Optional) - Name of the undo entry that is created
  • use_cache: boolean (Optional) - Whether to use the cached canvas/jimp instance
  • no_undo: boolean (Optional) - If true, no undo point is created. Default is false
  • no_update: boolean (Optional) - If true, the texture is not updated visually
  • no_undo_init: boolean (Optional)
  • no_undo_finish: boolean (Optional)

setAlphaMatrix( texture, x, y, val )

Arguments:

• texture: Texture
• x: number
• y: number
• val: number

getAlphaMatrix( texture, x, y )

Arguments:

• texture: Texture
• x: number
• y: number

Returns: number

combineColors( base, added, opacity )

Arguments:

• base: RGBAColor
• added: RGBAColor
• opacity: number

Returns: RGBAColor

blendColors( base, added, opacity, blend_mode )

Arguments:

• base: RGBAColor
• added: RGBAColor
• opacity: number
• blend_mode: string

Returns: RGBAColor

getMirrorElement( element, symmetry_axes )

Arguments:

• element: OutlinerElement
• symmetry_axes: Array of number

updateNslideValues()

getBlendModeCompositeOperation()

Returns: string

getCanvas( texture )

Arguments:

• texture: Texture

Returns: HTMLCanvasElement

scanCanvas( ctx, x, y, w, h, cb )

Arguments:

• ctx: CanvasRenderingContext2D
• x: number
• y: number
• w: number
• h: number
• cb: See types

getPixelColor( ctx, x, y )

Arguments:

• ctx: CanvasRenderingContext2D
• x: number
• y: number

modifyCanvasSection( ctx, x, y, w, h, cb )

Arguments:

• ctx: CanvasRenderingContext2D
• x: number
• y: number
• w: number
• h: number
• cb: See types

editCircle( ctx, x, y, r, softness, editPx )

Arguments:

• ctx: CanvasRenderingContext2D
• x: number
• y: number
• r: number
• softness: number
• editPx: See types

editSquare( ctx, x, y, r, softness, editPx )

Arguments:

• ctx: CanvasRenderingContext2D
• x: number
• y: number
• r: number
• softness: number
• editPx: See types

openBrushOptions()

loadBrushPreset( preset )

Arguments:

• preset: any