Class

Gjs ▶ gjs/cairo ▶ default ▶ Region

A region object used for representing a set of pixels.

Constructor takes no arguments — Cairo regions start empty and grow via unionRectangle / union. Source: gjs/modules/cairo-region.cpp constructor_impl.

Hierarchy (View Summary)

default.Status
- Region

Index

Constructors

Methods

getRectangle intersect intersectRectangle numRectangles subtract subtractRectangle union unionRectangle xor xorRectangle

Constructors

constructor

new Region(): default.Region
Returns default.Region
Overrides Cairo.Region.constructor
- Defined in gjs/cairo.d.ts:971

Methods

getRectangle

getRectangle(i: number): default.RectangleInt
Return the i-th rectangle in the region's decomposition. Throws if i is out of range. Source: cairo-region.cpp get_rectangle_func.
Parameters
- i: number
Returns default.RectangleInt
- Defined in gjs/cairo.d.ts:984

intersect

intersect(other: default.Region): void
Intersect this region with other in place (this ← this ∩ other). Source: cairo-region.cpp REGION_DEFINE_REGION_FUNC(intersect).
Parameters
- other: default.Region
Returns void
- Defined in gjs/cairo.d.ts:1002

intersectRectangle

intersectRectangle(rect: default.RectangleInt): void
Intersect this region with a rectangle. Source: cairo-region.cpp REGION_DEFINE_RECT_FUNC(intersect).
Parameters
- rect: default.RectangleInt
Returns void
- Defined in gjs/cairo.d.ts:1026

numRectangles

numRectangles(): number
Number of disjoint rectangles in the region's decomposition. Source: cairo-region.cpp num_rectangles_func.

Returns number
- Defined in gjs/cairo.d.ts:977

subtract

subtract(other: default.Region): void
Subtract other from this region in place (this ← this ∖ other). Source: cairo-region.cpp REGION_DEFINE_REGION_FUNC(subtract).
Parameters
- other: default.Region
Returns void
- Defined in gjs/cairo.d.ts:996

subtractRectangle

subtractRectangle(rect: default.RectangleInt): void
Subtract a single rectangle from this region. Source: cairo-region.cpp REGION_DEFINE_RECT_FUNC(subtract).
Parameters
- rect: default.RectangleInt
Returns void
- Defined in gjs/cairo.d.ts:1020

union

union(other: default.Region): void
Union this region with other in place (this ← this ∪ other). Source: cairo-region.cpp REGION_DEFINE_REGION_FUNC(union).
Parameters
- other: default.Region
Returns void
- Defined in gjs/cairo.d.ts:990

unionRectangle

unionRectangle(rect: default.RectangleInt): void
Union a single rectangle into this region. Source: cairo-region.cpp REGION_DEFINE_RECT_FUNC(union).
Parameters
- rect: default.RectangleInt
Returns void
- Defined in gjs/cairo.d.ts:1014

xor

xor(other: default.Region): void
Replace this region with the symmetric difference (this ⊕ other). Source: cairo-region.cpp REGION_DEFINE_REGION_FUNC(xor).
Parameters
- other: default.Region
Returns void
- Defined in gjs/cairo.d.ts:1008

xorRectangle

xorRectangle(rect: default.RectangleInt): void
Symmetric-difference this region with a rectangle. Source: cairo-region.cpp REGION_DEFINE_RECT_FUNC(xor).
Parameters
- rect: default.RectangleInt
Returns void
- Defined in gjs/cairo.d.ts:1032