Canvacord

ImageManipulator

extendsCanvasImage

Creates a new CanvasImage instance.

new ImageManipulator(source, [width], [height])
ParameterTypeDescriptionOptional
source
ImageSource

The image source

width
number

The width of the image

height
number

The height of the image

Properties

height

The height of the canvas

Type:number

source

The image source

Type:ImageSource

steps

The steps to apply to the canvas.

Type:Array<ContextManipulationStep>

width

The width of the canvas

Type:number

Methods

blur(value); 

Applies blur filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

brightness(value); 

Applies brightness filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

circle([width], [height]); 

Draws the image to the canvas with a circle clip.

ParameterTypeDescriptionOptional
width
number

The width of the image

height
number

The height of the image

Returns:ImageManipulator

circularize(width, height); 

Applies a circular clip to the image.

ParameterTypeDescriptionOptional
width
number

The width of the image

height
number

The height of the image

Returns:void

contrast(value); 

Applies contrast filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

draw(x, y, [width], [height]); 

Draws the image to the canvas.

ParameterTypeDescriptionOptional
x
number

The x position to draw the image

y
number

The y position to draw the image

width
number

The width of the image

height
number

The height of the image

Returns:ImageManipulator

drawImage(image, x, y, [width], [height]); 

Draws the image to the canvas.

ParameterTypeDescriptionOptional
image
ImageSource

The image to draw

x
number

The x position to draw the image

y
number

The y position to draw the image

width
number

The width of the image

height
number

The height of the image

Returns:ImageManipulator

dropShadow(config); 

Applies drop-shadow filter to the image.

ParameterTypeDescriptionOptional
config
DropShadowConfig

The drop-shadow config

Returns:ImageManipulator

encode(); 

Encodes the canvas to a buffer.

Returns:Promise<Buffer>

erase(x, y, width, height); 

Erases a part of the canvas.

ParameterTypeDescriptionOptional
x
number

The x position to erase

y
number

The y position to erase

width
number

The width of the area to erase

height
number

The height of the area to erase

Returns:void

flip(axis); 

Flips the canvas.

ParameterTypeDescriptionOptional
axis
'x''y'

The axis to flip, `x` or `y`.

Returns:void

getFinalCanvas(); 

Returns the canvas instance by applying the steps.

Returns:Promise<Canvas>

grayscale(value); 

Applies grayscale filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

hueRotate(value); 

Applies hue-rotate filter to the image.

ParameterTypeDescriptionOptional
value
number

The degrees to rotate

Returns:ImageManipulator

invert(value); 

Applies invert filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

opacity(value); 

Applies opacity filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

pixelate([pixels]); 

Draws pixelated image to the canvas.

ParameterTypeDescriptionOptional
pixels
number

The amount of pixels to use

Returns:ImageManipulator

process(canvas, ctx); 

Processes the steps and applies them to the canvas.

ParameterTypeDescriptionOptional
canvas
Canvas

The canvas to apply the steps to

ctx
SKRSContext2D

The canvas context to apply the steps to

Returns:Promise<void>

resetTransform(); 

Resets the transform of the canvas.

Returns:void

restore(); 

Restores the last saved canvas context state.

Returns:ImageManipulator

rotate(degrees); 

Rotates the canvas.

ParameterTypeOptional
degrees
number
Returns:ImageManipulator

saturate(value); 

Applies saturate filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

save(); 

Saves the canvas context state.

Returns:ImageManipulator

scale(x, y); 

Scales the canvas.

ParameterTypeDescriptionOptional
x
number

The x scale

y
number

The y scale

Returns:void

sepia(value); 

Applies sepia filter to the image.

ParameterTypeDescriptionOptional
value
number

The filter intensity

Returns:ImageManipulator

transform(a, b, c, d, e, f); 

Applies a transform to the canvas.

ParameterTypeOptional
a
number
b
number
c
number
d
number
e
number
f
number
Returns:void

translate(x, y); 

Translates the canvas.

ParameterTypeDescriptionOptional
x
number

The x position to translate

y
number

The y position to translate

Returns:void