Class Vec2

A structure capable of holding a vector with two dimensions, x and y.

The contents of the #graphene_vec2_t structure are private and should never be accessed directly.

record

Hierarchy

Vec2

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Vec2(): Vec2

Returns Vec2

Properties

Static name

name: string

Methods

add

add(b: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2737
Adds each component of the two passed vectors and places each result into the components of res.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns Vec2

divide

divide(b: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2744
Divides each component of the first operand a by the corresponding component of the second operand b, and places the results into the vector res.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns Vec2

dot

dot(b: Vec2): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2749
Computes the dot product of the two given vectors.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns number

equal

equal(v2: Vec2): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:2754
Checks whether the two given #graphene_vec2_t are equal.

Parameters
- v2: Vec2
  
  a #graphene_vec2_t
Returns boolean

free

free(): void

- Defined in @types/Gjs/Graphene-1.0.d.ts:2758
Frees the resources allocated by v

Returns void

get_x

get_x(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2762
Retrieves the X component of the #graphene_vec2_t.

Returns number

get_y

get_y(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2766
Retrieves the Y component of the #graphene_vec2_t.

Returns number

init

init(x: number, y: number): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2774
Initializes a #graphene_vec2_t using the given values.

This function can be called multiple times.

Parameters
- x: number
  
  the X field of the vector
- y: number
  
  the Y field of the vector
Returns Vec2

init_from_float

init_from_float(src: number[]): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2779
Initializes v with the contents of the given array.

Parameters
- src: number[]
  
  an array of floating point values with at least two elements
Returns Vec2

init_from_vec2

init_from_vec2(src: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2784
Copies the contents of src into v.

Parameters
- src: Vec2
  
  a #graphene_vec2_t
Returns Vec2

interpolate

interpolate(v2: Vec2, factor: number): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2790
Linearly interpolates v1 and v2 using the given factor.

Parameters
- v2: Vec2
  
  a #graphene_vec2_t
- factor: number
  
  the interpolation factor
Returns Vec2

length

length(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2794
Computes the length of the given vector.

Returns number

max

max(b: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2800
Compares the two given vectors and places the maximum values of each component into res.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns Vec2

min

min(b: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2806
Compares the two given vectors and places the minimum values of each component into res.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns Vec2

multiply

multiply(b: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2812
Multiplies each component of the two passed vectors and places each result into the components of res.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns Vec2

near

near(v2: Vec2, epsilon: number): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:2819
Compares the two given #graphene_vec2_t vectors and checks whether their values are within the given epsilon.

Parameters
- v2: Vec2
  
  a #graphene_vec2_t
- epsilon: number
  
  the threshold between the two vectors
Returns boolean

negate

negate(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2823
Negates the given #graphene_vec2_t.

Returns Vec2

normalize

normalize(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2827
Computes the normalized vector for the given vector v.

Returns Vec2

scale

scale(factor: number): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2832
Multiplies all components of the given vector with the given scalar factor.

Parameters
- factor: number
  
  the scalar factor
Returns Vec2

subtract

subtract(b: Vec2): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2839
Subtracts from each component of the first operand a the corresponding component of the second operand b and places each result into the components of res.

Parameters
- b: Vec2
  
  a #graphene_vec2_t
Returns Vec2

to_float

to_float(): number[]

- Defined in @types/Gjs/Graphene-1.0.d.ts:2843
Stores the components of v into an array.

Returns number[]

Static alloc

alloc(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2869
Allocates a new #graphene_vec2_t structure.

The contents of the returned structure are undefined.

Use graphene_vec2_init() to initialize the vector.

Returns Vec2

Static one

one(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2873
Retrieves a constant vector with (1, 1) components.

Returns Vec2

Static x_axis

x_axis(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2877
Retrieves a constant vector with (1, 0) components.

Returns Vec2

Static y_axis

y_axis(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2881
Retrieves a constant vector with (0, 1) components.

Returns Vec2

Static zero

zero(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2885
Retrieves a constant vector with (0, 0) components.

Returns Vec2