Class Vec4

A structure capable of holding a vector with four dimensions: x, y, z, and w.

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

record

Hierarchy

Vec4

Index

Constructors

constructor

Properties

name

Constructors

constructor

new Vec4(): Vec4

Returns Vec4

Properties

Static name

name: string

Methods

add

add(b: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3100
Adds each component of the two given vectors.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

divide

divide(b: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3107
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: Vec4
  
  a #graphene_vec4_t
Returns Vec4

dot

dot(b: Vec4): number

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

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns number

equal

equal(v2: Vec4): boolean

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

Parameters
- v2: Vec4
  
  a #graphene_vec4_t
Returns boolean

free

free(): void

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

Returns void

get_w

get_w(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:3125
Retrieves the value of the fourth component of the given #graphene_vec4_t.

Returns number

get_x

get_x(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:3129
Retrieves the value of the first component of the given #graphene_vec4_t.

Returns number

get_xy

get_xy(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:3134
Creates a #graphene_vec2_t that contains the first two components of the given #graphene_vec4_t.

Returns Vec2

get_xyz

get_xyz(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3139
Creates a #graphene_vec3_t that contains the first three components of the given #graphene_vec4_t.

Returns Graphene.Vec3

get_y

get_y(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:3143
Retrieves the value of the second component of the given #graphene_vec4_t.

Returns number

get_z

get_z(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:3147
Retrieves the value of the third component of the given #graphene_vec4_t.

Returns number

init

init(x: number, y: number, z: number, w: number): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3157
Initializes a #graphene_vec4_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
- z: number
  
  the Z field of the vector
- w: number
  
  the W field of the vector
Returns Vec4

init_from_float

init_from_float(src: number[]): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3162
Initializes a #graphene_vec4_t with the values inside the given array.

Parameters
- src: number[]
  
  an array of four floating point values
Returns Vec4

init_from_vec2

init_from_vec2(src: Vec2, z: number, w: number): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3170
Initializes a #graphene_vec4_t using the components of a #graphene_vec2_t and the values of z and w.

Parameters
- src: Vec2
  
  a #graphene_vec2_t
- z: number
  
  the value for the third component of v
- w: number
  
  the value for the fourth component of v
Returns Vec4

init_from_vec3

init_from_vec3(src: Graphene.Vec3, w: number): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3177
Initializes a #graphene_vec4_t using the components of a #graphene_vec3_t and the value of w.

Parameters
- src: Graphene.Vec3
  
  a #graphene_vec3_t
- w: number
  
  the value for the fourth component of v
Returns Vec4

init_from_vec4

init_from_vec4(src: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3183
Initializes a #graphene_vec4_t using the components of another #graphene_vec4_t.

Parameters
- src: Vec4
  
  a #graphene_vec4_t
Returns Vec4

interpolate

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

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

Parameters
- v2: Vec4
  
  a #graphene_vec4_t
- factor: number
  
  the interpolation factor
Returns Vec4

length

length(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:3193
Computes the length of the given #graphene_vec4_t.

Returns number

max

max(b: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3199
Compares each component of the two given vectors and creates a vector that contains the maximum values.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

min

min(b: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3205
Compares each component of the two given vectors and creates a vector that contains the minimum values.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

multiply

multiply(b: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3210
Multiplies each component of the two given vectors.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

near

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

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

Parameters
- v2: Vec4
  
  a #graphene_vec4_t
- epsilon: number
  
  the threshold between the two vectors
Returns boolean

negate

negate(): Vec4

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

Returns Vec4

normalize

normalize(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3225
Normalizes the given #graphene_vec4_t.

Returns Vec4

scale

scale(factor: number): Vec4

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

Parameters
- factor: number
  
  the scalar factor
Returns Vec4

subtract

subtract(b: Vec4): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3237
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: Vec4
  
  a #graphene_vec4_t
Returns Vec4

to_float

to_float(): number[]

- Defined in @types/Gjs/Graphene-1.0.d.ts:3242
Stores the components of the given #graphene_vec4_t into an array of floating point values.

Returns number[]

Static alloc

alloc(): Vec4

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

The contents of the returned structure are undefined.

Use graphene_vec4_init() to initialize the vector.

Returns Vec4

Static one

one(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3273
Retrieves a pointer to a #graphene_vec4_t with all its components set to 1.

Returns Vec4

Static w_axis

w_axis(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3278
Retrieves a pointer to a #graphene_vec4_t with its components set to (0, 0, 0, 1).

Returns Vec4

Static x_axis

x_axis(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3283
Retrieves a pointer to a #graphene_vec4_t with its components set to (1, 0, 0, 0).

Returns Vec4

Static y_axis

y_axis(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3288
Retrieves a pointer to a #graphene_vec4_t with its components set to (0, 1, 0, 0).

Returns Vec4

Static z_axis

z_axis(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3293
Retrieves a pointer to a #graphene_vec4_t with its components set to (0, 0, 1, 0).

Returns Vec4

Static zero

zero(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:3298
Retrieves a pointer to a #graphene_vec4_t with all its components set to 0.

Returns Vec4