Documentation/D2DBrush
class

D2DBrush

js/d2d.js:363
D2DBrush(arg)

Object used for drawing as alternative for simple colour.
Can also be used to reuse brushes for drawing instead of creating them every time for any primitive drawing operation (if just a color is specified in the Draw/Fill methods, a brush is always created).
Created by d2d.Brush

Parameters

NameTypeDescription
argD2DBrush

Example source

propertyreadonly

Type

js/d2d.js:374
Type: BrushType

Brush type.
See BrushType

propertyreadonly

WrapMode

js/d2d.js:382
WrapMode: BrushWrapMode

Wrap mode responsible for how the brush gradient or image is repeated when drawing
See BrushWrapMode

method

ApplyTransform

js/d2d.js:464
ApplyTransform(matrix)

Applies specified transformation matrix of 3x2 size to the current D2DBrush matrix.
Matrix3x2 helper class from the component/docs/Matrix.js will be useful

Parameters

NameTypeDescription
matrixFloat32Array

Array that presents 3x2 matrix for transformation (length = 6)

Example source

method

GetTransform

js/d2d.js:441
GetTransform()

Gets D2DBrush current transformation matrix of 3x2 size (Float32Array(6))
Matrix3x2 helper class from the component/docs/Matrix.js will be useful

Returns

Float32Array

Example source

method

PopTransform

js/d2d.js:436
PopTransform()

Restores D2DBrush matrix from internal stack pushed previously by PushTransform.

method

PushTransform

js/d2d.js:431
PushTransform()

Saves current D2DBrush matrix in internal stack. To restore the matrix use PopTransform.

method

ResetTransform

js/d2d.js:459
ResetTransform()

Resets current D2DBrush matrix to original identity matrix.

method

Rotate

js/d2d.js:399
Rotate(angle, cx, cy)

Applies rotation matrix to the current D2DBrush matrix.
For more information see https://learn.microsoft.com/en-us/windows/win32/api/d2d1helper/nf-d2d1helper-matrix3x2f-rotation

Parameters

NameTypeDescription
anglefloat

Angle of rotation in degrees

cx = 0optionalnumber

Rotation center point x coord

cy = 0optionalnumber

Rotation center point y coord

method

Scale

js/d2d.js:409
Scale(sz, sy, cx, cy)

Parameters

NameTypeDescription
sxfloat

The x-axis scale factor

sy = 0optionalfloat

The y-axis scale factor. If zero sx will be used as sy

cx = 0optionalnumber

Scale center point x coord

cy = 0optionalnumber

Scale center point y coord

method

SetTransform

js/d2d.js:450
SetTransform(matrix)

Replaces the current D2DBrush matrix with specified transformation matrix of 3x2 size.
Matrix3x2 helper class from the component/docs/Matrix.js will be useful

Parameters

NameTypeDescription
matrixFloat32Array

Array that presents 3x2 matrix for transformation (length = 6)

Example source

method

Skew

js/d2d.js:420
Skew(angleX, angleY, cx, cy)

Applies skew matrix to the current D2DBrush matrix.
For more information see https://learn.microsoft.com/en-us/windows/win32/api/d2d1helper/nf-d2d1helper-matrix3x2f-skew

Parameters

NameTypeDescription
angleXfloat

The x-axis skew angle, which is measured in degrees counterclockwise from the y-axis.

angleYfloat

The y-axis skew angle, which is measured in degrees clockwise from the x-axis.

cx = 0optionalnumber

Skew center point x coord

cy = 0optionalnumber

Skew center point y coord

method

Translate

js/d2d.js:390
Translate(dx, dy)

Applies translation matrix to the current D2DBrush matrix.
For more information see https://learn.microsoft.com/en-us/windows/win32/api/d2d1helper/nf-d2d1helper-matrix3x2f-translation(d2d1_size_f)

Parameters

NameTypeDescription
dxnumber
dynumber