Class Rect

A #VipsRect is a rectangular area of pixels. This is a struct for performing simple rectangle algebra.

record

Hierarchy

Rect

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Rect(): Vips.Rect

Returns Vips.Rect

Properties

height

height: number

height of rectangle

field

left

left: number

left edge of rectangle

field

top

top: number

top edge of rectangle

field

width

width: number

width of rectangle

field

Static name

name: string

Methods

equalsrect

equalsrect(r2: Vips.Rect): boolean

- Defined in Vips-8.0.d.ts:5411
Is r1 equal to r2?

Parameters
- r2: Vips.Rect
  
  second rectangle
Returns boolean

includespoint

includespoint(x: number, y: number): boolean

- Defined in Vips-8.0.d.ts:5417
Does r contain point (x, y)?

Parameters
- x: number
  
  position to test for
- y: number
  
  position to test for
Returns boolean

includesrect

includesrect(r2: Vips.Rect): boolean

- Defined in Vips-8.0.d.ts:5422
Is r2 a subset of r1?

Parameters
- r2: Vips.Rect
  
  inner rectangle
Returns boolean

intersectrect

intersectrect(r2: Vips.Rect): Vips.Rect

- Defined in Vips-8.0.d.ts:5427
Fill out with the intersection of r1 and r2. out can equal r1 or r2.

Parameters
- r2: Vips.Rect
  
  input rectangle 2
Returns Vips.Rect

isempty

isempty(): boolean

- Defined in Vips-8.0.d.ts:5431
Is r empty? ie. zero width or height.

Returns boolean

marginadjust

marginadjust(n: number): void

- Defined in Vips-8.0.d.ts:5436
Enlarge r by n. +1 means out one pixel.

Parameters
- n: number
  
  enlarge by
Returns void

normalise

normalise(): void

- Defined in Vips-8.0.d.ts:5441
Make sure width and height are >0 by moving the origin and flipping the rect.

Returns void

overlapsrect

overlapsrect(r2: Vips.Rect): boolean

- Defined in Vips-8.0.d.ts:5446
Do r1 and r2 have a non-empty intersection?

Parameters
- r2: Vips.Rect
  
  second rectangle
Returns boolean

unionrect

unionrect(r2: Vips.Rect): Vips.Rect

- Defined in Vips-8.0.d.ts:5451
Fill out with the bounding box of r1 and r2. out can equal r1 or r2.

Parameters
- r2: Vips.Rect
  
  input rectangle 2
Returns Vips.Rect