API Reference / @gtkx/cairo / MeshPattern

Class: MeshPattern

Defined in: packages/cairo/src/pattern.ts:381

A mesh gradient pattern, created with Pattern.createMesh: a set of Coons patches, each described between beginPatch and endPatch by a path of up to four sides and the colors of its corners.

Extends

• Pattern

Constructors

Constructor

new MeshPattern(): MeshPattern

Returns

MeshPattern

Inherited from

Pattern.constructor

Properties

__type__

__type__: bigint

Defined in: packages/cairo/src/pattern.ts:256

GType of CairoPattern, the boxed type this class is registered under.

Inherited from

Pattern.__type__

Methods

addColorStopRgb()

addColorStopRgb(offset, red, green, blue): void

Defined in: packages/cairo/src/pattern.ts:259

Adds an opaque color stop at offset (0 to 1) to a gradient pattern.

Parameters

offset

number

red

number

green

number

blue

number

Returns

void

Inherited from

Pattern.addColorStopRgb

---

addColorStopRgba()

addColorStopRgba(offset, red, green, blue, alpha): void

Defined in: packages/cairo/src/pattern.ts:264

Adds a translucent color stop at offset (0 to 1) to a gradient pattern.

Parameters

offset

number

red

number

green

number

blue

number

alpha

number

Returns

void

Inherited from

Pattern.addColorStopRgba

---

beginPatch()

beginPatch(): void

Defined in: packages/cairo/src/pattern.ts:383

Starts describing a new patch.

Returns

void

---

curveTo()

curveTo(x1, y1, x2, y2, x3, y3): void

Defined in: packages/cairo/src/pattern.ts:403

Adds a curved side from the previous corner through two control points to (x3, y3).

Parameters

x1

number

y1

number

x2

number

y2

number

x3

number

y3

number

Returns

void

---

endPatch()

endPatch(): void

Defined in: packages/cairo/src/pattern.ts:388

Finishes the patch being described.

Returns

void

---

getColorStopCount()

getColorStopCount(): number

Defined in: packages/cairo/src/pattern.ts:269

Returns how many color stops a gradient pattern has.

Returns

number

Inherited from

Pattern.getColorStopCount

---

getColorStopRgba()

getColorStopRgba(index): ColorStop

Defined in: packages/cairo/src/pattern.ts:274

Returns the color stop at index of a gradient pattern.

Parameters

index

number

Returns

ColorStop

Inherited from

Pattern.getColorStopRgba

---

getControlPoint()

getControlPoint(patchNum, pointNum): Point

Defined in: packages/cairo/src/pattern.ts:433

Returns control point pointNum of patch patchNum.

Parameters

patchNum

number

pointNum

number

Returns

Point

---

getCornerColorRgba()

getCornerColorRgba(patchNum, cornerNum): RgbaColor

Defined in: packages/cairo/src/pattern.ts:442

Returns the color of corner cornerNum of patch patchNum.

Parameters

patchNum

number

cornerNum

number

Returns

RgbaColor

---

getExtend()

getExtend(): Extend

Defined in: packages/cairo/src/pattern.ts:297

Returns how the pattern is extended outside its natural area.

Returns

Extend

Inherited from

Pattern.getExtend

---

getFilter()

getFilter(): Filter

Defined in: packages/cairo/src/pattern.ts:307

Returns the filter used when the pattern is resampled.

Returns

Filter

Inherited from

Pattern.getFilter

---

getMatrix()

getMatrix(): Matrix

Defined in: packages/cairo/src/pattern.ts:317

Returns the transformation from user space to pattern space.

Returns

Matrix

Inherited from

Pattern.getMatrix

---

getPatchCount()

getPatchCount(): number

Defined in: packages/cairo/src/pattern.ts:423

Returns how many patches have been finished.

Returns

number

---

getPath()

getPath(patchNum): PathData[]

Defined in: packages/cairo/src/pattern.ts:428

Returns the path around patch patchNum.

Parameters

patchNum

number

Returns

PathData[]

---

getReferenceCount()

getReferenceCount(): number

Defined in: packages/cairo/src/pattern.ts:330

Returns the reference count of the pattern.

Returns

number

Inherited from

Pattern.getReferenceCount

---

getRgba()

getRgba(): RgbaColor

Defined in: packages/cairo/src/pattern.ts:282

Returns the color of a solid pattern.

Returns

RgbaColor

Inherited from

Pattern.getRgba

---

getSurface()

getSurface(): Surface

Defined in: packages/cairo/src/pattern.ts:335

Returns the surface of a surface pattern; throws for a pattern that has no surface.

Returns

Surface

Inherited from

Pattern.getSurface

---

getType()

getType(): PatternType

Defined in: packages/cairo/src/pattern.ts:325

Returns the kind of pattern this is.

Returns

PatternType

Inherited from

Pattern.getType

---

lineTo()

lineTo(x, y): void

Defined in: packages/cairo/src/pattern.ts:398

Adds a straight side from the previous corner to (x, y).

Parameters

x

number

y

number

Returns

void

---

moveTo()

moveTo(x, y): void

Defined in: packages/cairo/src/pattern.ts:393

Sets the first corner of the patch being described.

Parameters

x

number

y

number

Returns

void

---

setControlPoint()

setControlPoint(pointNum, x, y): void

Defined in: packages/cairo/src/pattern.ts:408

Sets an interior control point (0 to 3) of the patch being described.

Parameters

pointNum

number

x

number

y

number

Returns

void

---

setCornerColorRgb()

setCornerColorRgb(cornerNum, red, green, blue): void

Defined in: packages/cairo/src/pattern.ts:413

Sets the opaque color of a corner (0 to 3) of the patch being described.

Parameters

cornerNum

number

red

number

green

number

blue

number

Returns

void

---

setCornerColorRgba()

setCornerColorRgba(cornerNum, red, green, blue, alpha): void

Defined in: packages/cairo/src/pattern.ts:418

Sets the translucent color of a corner (0 to 3) of the patch being described.

Parameters

cornerNum

number

red

number

green

number

blue

number

alpha

number

Returns

void

---

setExtend()

setExtend(extend): void

Defined in: packages/cairo/src/pattern.ts:292

Sets how the pattern is extended outside its natural area.

Parameters

extend

Extend

Returns

void

Inherited from

Pattern.setExtend

---

setFilter()

setFilter(filter): void

Defined in: packages/cairo/src/pattern.ts:302

Sets the filter used when the pattern is resampled.

Parameters

filter

Filter

Returns

void

Inherited from

Pattern.setFilter

---

setMatrix()

setMatrix(matrix): void

Defined in: packages/cairo/src/pattern.ts:312

Sets the transformation from user space to pattern space.

Parameters

matrix

Matrix

Returns

void

Inherited from

Pattern.setMatrix

---

status()

status(): Status

Defined in: packages/cairo/src/pattern.ts:287

Returns the error status of the pattern, Status.SUCCESS when it is usable.

Returns

Status

Inherited from

Pattern.status

---

createForSurface()

static createForSurface(surface): Pattern

Defined in: packages/cairo/src/pattern.ts:249

Creates a pattern that paints with the content of surface.

Parameters

surface

Surface

Returns

Pattern

Inherited from

Pattern.createForSurface

---

createLinear()

static createLinear(x0, y0, x1, y1): LinearPattern

Defined in: packages/cairo/src/pattern.ts:223

Creates a linear gradient between (x0, y0) and (x1, y1); add stops with addColorStopRgba.

Parameters

x0

number

y0

number

x1

number

y1

number

Returns

LinearPattern

Inherited from

Pattern.createLinear

---

createMesh()

static createMesh(): MeshPattern

Defined in: packages/cairo/src/pattern.ts:244

Creates an empty mesh gradient; describe its patches with the MeshPattern methods.

Returns

MeshPattern

Inherited from

Pattern.createMesh

---

createRadial()

static createRadial(cx0, cy0, radius0, cx1, cy1, radius1): RadialPattern

Defined in: packages/cairo/src/pattern.ts:230

Creates a radial gradient between two circles; add stops with addColorStopRgba.

Parameters

cx0

number

cy0

number

radius0

number

cx1

number

cy1

number

radius1

number

Returns

RadialPattern

Inherited from

Pattern.createRadial

---

createRgb()

static createRgb(red, green, blue): Pattern

Defined in: packages/cairo/src/pattern.ts:213

Creates an opaque solid-color pattern.

Parameters

red

number

green

number

blue

number

Returns

Pattern

Inherited from

Pattern.createRgb

---

createRgba()

static createRgba(red, green, blue, alpha): Pattern

Defined in: packages/cairo/src/pattern.ts:218

Creates a translucent solid-color pattern.

Parameters

red

number

green

number

blue

number

alpha

number

Returns

Pattern

Inherited from

Pattern.createRgba