v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:447

Interface representing its WGSL vector type counterpart: vec2f or vec2. A vector with 2 elements of type f32

Extends

Tuple2<number>.Swizzle2<v2f, v3f, v4f>.vecInfixNotation<v2f>

Indexable

[n: number]: number

Properties

[$internal]

readonly [$internal]: true

Defined in: packages/typegpu/src/data/wgslTypes.ts:449

[unscopables]

readonly [unscopables]: object

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

Is an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.

Index Signature

[key: number]: undefined | boolean

[iterator]?

optional [iterator]: boolean

[unscopables]?

readonly optional [unscopables]: boolean

Is an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.

at?

optional at: boolean

concat?

optional concat: boolean

copyWithin?

optional copyWithin: boolean

entries?

optional entries: boolean

every?

optional every: boolean

fill?

optional fill: boolean

filter?

optional filter: boolean

find?

optional find: boolean

findIndex?

optional findIndex: boolean

findLast?

optional findLast: boolean

findLastIndex?

optional findLastIndex: boolean

flat?

optional flat: boolean

flatMap?

optional flatMap: boolean

forEach?

optional forEach: boolean

includes?

optional includes: boolean

indexOf?

optional indexOf: boolean

join?

optional join: boolean

keys?

optional keys: boolean

lastIndexOf?

optional lastIndexOf: boolean

length?

optional length: boolean

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

map?

optional map: boolean

pop?

optional pop: boolean

push?

optional push: boolean

reduce?

optional reduce: boolean

reduceRight?

optional reduceRight: boolean

reverse?

optional reverse: boolean

shift?

optional shift: boolean

slice?

optional slice: boolean

some?

optional some: boolean

sort?

optional sort: boolean

splice?

optional splice: boolean

toLocaleString?

optional toLocaleString: boolean

toReversed?

optional toReversed: boolean

toSorted?

optional toSorted: boolean

toSpliced?

optional toSpliced: boolean

toString?

optional toString: boolean

unshift?

optional unshift: boolean

values?

optional values: boolean

with?

optional with: boolean

Inherited from

Tuple2.[unscopables]

0

0: number

Inherited from

Tuple2.0

1

1: number

Inherited from

Tuple2.1

kind

readonly kind: "vec2f"

Defined in: packages/typegpu/src/data/wgslTypes.ts:451

use to distinguish between vectors of the same size on the type level

length

length: 2

Inherited from

Tuple2.length

x

x: number

Defined in: packages/typegpu/src/data/wgslTypes.ts:452

xx

readonly xx: v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:126

Inherited from

Swizzle2.xx

xxx

readonly xxx: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:131

Inherited from

Swizzle2.xxx

xxxx

readonly xxxx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:140

Inherited from

Swizzle2.xxxx

xxxy

readonly xxxy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:141

Inherited from

Swizzle2.xxxy

xxy

readonly xxy: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:132

Inherited from

Swizzle2.xxy

xxyx

readonly xxyx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:142

Inherited from

Swizzle2.xxyx

xxyy

readonly xxyy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:143

Inherited from

Swizzle2.xxyy

xy

readonly xy: v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:127

Inherited from

Swizzle2.xy

xyx

readonly xyx: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:133

Inherited from

Swizzle2.xyx

xyxx

readonly xyxx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:144

Inherited from

Swizzle2.xyxx

xyxy

readonly xyxy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:145

Inherited from

Swizzle2.xyxy

xyy

readonly xyy: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:134

Inherited from

Swizzle2.xyy

xyyx

readonly xyyx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:146

Inherited from

Swizzle2.xyyx

xyyy

readonly xyyy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:147

Inherited from

Swizzle2.xyyy

y

y: number

Defined in: packages/typegpu/src/data/wgslTypes.ts:453

yx

readonly yx: v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:128

Inherited from

Swizzle2.yx

yxx

readonly yxx: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:135

Inherited from

Swizzle2.yxx

yxxx

readonly yxxx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:148

Inherited from

Swizzle2.yxxx

yxxy

readonly yxxy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:149

Inherited from

Swizzle2.yxxy

yxy

readonly yxy: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:136

Inherited from

Swizzle2.yxy

yxyx

readonly yxyx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:150

Inherited from

Swizzle2.yxyx

yxyy

readonly yxyy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:151

Inherited from

Swizzle2.yxyy

yy

readonly yy: v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:129

Inherited from

Swizzle2.yy

yyx

readonly yyx: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:137

Inherited from

Swizzle2.yyx

yyxx

readonly yyxx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:152

Inherited from

Swizzle2.yyxx

yyxy

readonly yyxy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:153

Inherited from

Swizzle2.yyxy

yyy

readonly yyy: v3f

Defined in: packages/typegpu/src/data/wgslTypes.ts:138

Inherited from

Swizzle2.yyy

yyyx

readonly yyyx: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:154

Inherited from

Swizzle2.yyyx

yyyy

readonly yyyy: v4f

Defined in: packages/typegpu/src/data/wgslTypes.ts:155

Inherited from

Swizzle2.yyyy

Methods

[iterator]()

[iterator](): ArrayIterator<number>

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator<number>

Inherited from

Tuple2.[iterator]

add()

Call Signature

add(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:51

Parameters

other

number

Returns

v2f

Inherited from

vecInfixNotation.add

Call Signature

add(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:52

Parameters

other

v2f

Returns

v2f

Inherited from

vecInfixNotation.add

at()

at(index): undefined | number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.array.d.ts:24

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

undefined | number

Inherited from

Tuple2.at

concat()

Call Signature

concat(…items): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1350

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

…ConcatArray<number>[]

Additional arrays and/or items to add to the end of the array.

Returns

number[]

Inherited from

Tuple2.concat

Call Signature

concat(…items): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1356

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

…(number | ConcatArray<number>)[]

Additional arrays and/or items to add to the end of the array.

Returns

number[]

Inherited from

Tuple2.concat

copyWithin()

copyWithin(target, start, end?): this

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:62

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

Tuple2.copyWithin

div()

Call Signature

div(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:61

Parameters

other

number

Returns

v2f

Inherited from

vecInfixNotation.div

Call Signature

div(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:62

Parameters

other

v2f

Returns

v2f

Inherited from

vecInfixNotation.div

entries()

entries(): ArrayIterator<[number, number]>

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, number]>

Inherited from

Tuple2.entries

every()

Call Signature

every<S>(predicate, thisArg?): this is S[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1433

Determines whether all the members of an array satisfy the specified test.

Type Parameters

• S extends number

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

Tuple2.every

Call Signature

every(predicate, thisArg?): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1442

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Tuple2.every

fill()

fill(value, start?, end?): this

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:51

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

value

number

value to fill array section with

start?

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end?

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

Tuple2.fill

filter()

Call Signature

filter<S>(predicate, thisArg?): S[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1469

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

• S extends number

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

Tuple2.filter

Call Signature

filter(predicate, thisArg?): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1475

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

number[]

Inherited from

Tuple2.filter

find()

Call Signature

find<S>(predicate, thisArg?): undefined | S

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:29

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

• S extends number

Parameters

predicate

(value, index, obj) => value is S

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Inherited from

Tuple2.find

Call Signature

find(predicate, thisArg?): undefined | number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:30

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

undefined | number

Inherited from

Tuple2.find

findIndex()

findIndex(predicate, thisArg?): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:41

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

Tuple2.findIndex

findLast()

Call Signature

findLast<S>(predicate, thisArg?): undefined | S

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:29

Returns the value of the last element in the array where predicate is true, and undefined otherwise.

Type Parameters

• S extends number

Parameters

predicate

(value, index, array) => value is S

findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Inherited from

Tuple2.findLast

Call Signature

findLast(predicate, thisArg?): undefined | number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:30

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

undefined | number

Inherited from

Tuple2.findLast

findLastIndex()

findLastIndex(predicate, thisArg?): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:41

Returns the index of the last element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, array) => unknown

findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

Tuple2.findLastIndex

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2019.array.d.ts:75

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

• A

• D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Tuple2.flat

flatMap()

flatMap<U, This>(callback, thisArg?): U[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2019.array.d.ts:64

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

• U

• This = undefined

Parameters

callback

(this, value, index, array) => U | readonly U[]

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg?

This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Tuple2.flatMap

forEach()

forEach(callbackfn, thisArg?): void

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1457

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

Tuple2.forEach

includes()

includes(searchElement, fromIndex?): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

number

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

Tuple2.includes

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1418

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

number

The value to locate in the array.

fromIndex?

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

Tuple2.indexOf

join()

join(separator?): string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1361

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Tuple2.join

keys()

keys(): ArrayIterator<number>

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Tuple2.keys

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1424

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

searchElement

number

The value to locate in the array.

fromIndex?

number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Tuple2.lastIndexOf

map()

map<U>(callbackfn, thisArg?): U[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1463

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

• U

Parameters

callbackfn

(value, index, array) => U

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Tuple2.map

mul()

Call Signature

mul(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:57

Parameters

other

number

Returns

v2f

Inherited from

vecInfixNotation.mul

Call Signature

mul(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:58

Parameters

other

v2f

Returns

v2f

Inherited from

vecInfixNotation.mul

Call Signature

mul(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:59

Parameters

other

m2x2f

Returns

v2f

Inherited from

vecInfixNotation.mul

pop()

pop(): undefined | number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1339

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

undefined | number

Inherited from

Tuple2.pop

push()

push(…items): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1344

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

items

…number[]

New elements to add to the array.

Returns

number

Inherited from

Tuple2.push

reduce()

Call Signature

reduce(callbackfn): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1481

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => number

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

number

Inherited from

Tuple2.reduce

Call Signature

reduce(callbackfn, initialValue): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1482

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => number

initialValue

number

Returns

number

Inherited from

Tuple2.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1488

Type Parameters

• U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Tuple2.reduce

reduceRight()

Call Signature

reduceRight(callbackfn): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1494

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => number

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

number

Inherited from

Tuple2.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1495

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => number

initialValue

number

Returns

number

Inherited from

Tuple2.reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1501

Type Parameters

• U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Tuple2.reduceRight

reverse()

reverse(): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1366

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

number[]

Inherited from

Tuple2.reverse

shift()

shift(): undefined | number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1371

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

undefined | number

Inherited from

Tuple2.shift

slice()

slice(start?, end?): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1381

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

start?

number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

end?

number

The end index of the specified portion of the array. This is exclusive of the element at the index ‘end’. If end is undefined, then the slice extends to the end of the array.

Returns

number[]

Inherited from

Tuple2.slice

some()

some(predicate, thisArg?): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1451

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Tuple2.some

sort()

sort(compareFn?): this

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1392

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they’re equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

Tuple2.sort

splice()

Call Signature

splice(start, deleteCount?): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1399

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove.

Returns

number[]

An array containing the elements that were deleted.

Inherited from

Tuple2.splice

Call Signature

splice(start, deleteCount, …items): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1407

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

items

…number[]

Elements to insert into the array in place of the deleted elements.

Returns

number[]

An array containing the elements that were deleted.

Inherited from

Tuple2.splice

sub()

Call Signature

sub(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:54

Parameters

other

number

Returns

v2f

Inherited from

vecInfixNotation.sub

Call Signature

sub(other): v2f

Defined in: packages/typegpu/src/data/wgslTypes.ts:55

Parameters

other

v2f

Returns

v2f

Inherited from

vecInfixNotation.sub

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1334

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

Tuple2.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Tuple2.toLocaleString

toReversed()

toReversed(): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:46

Returns a copy of an array with its elements reversed.

Returns

number[]

Inherited from

Tuple2.toReversed

toSorted()

toSorted(compareFn?): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:57

Returns a copy of an array with its elements sorted.

Parameters

compareFn?

(a, b) => number

[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]

Returns

number[]

Inherited from

Tuple2.toSorted

toSpliced()

Call Signature

toSpliced(start, deleteCount, …items): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:66

Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

items

…number[]

Elements to insert into the copied array in place of the deleted elements.

Returns

number[]

The copied array.

Inherited from

Tuple2.toSpliced

Call Signature

toSpliced(start, deleteCount?): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:74

Copies an array and removes elements while returning the remaining elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove.

Returns

number[]

A copy of the original array with the remaining elements.

Inherited from

Tuple2.toSpliced

toString()

toString(): string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1330

Returns a string representation of an array.

Returns

string

Inherited from

Tuple2.toString

unshift()

unshift(…items): number

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1412

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

items

…number[]

Elements to insert at the start of the array.

Returns

number

Inherited from

Tuple2.unshift

values()

values(): ArrayIterator<number>

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

Returns an iterable of values in the array

Returns

ArrayIterator<number>

Inherited from

Tuple2.values

with()

with(index, value): number[]

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:85

Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array.

Parameters

index

number

The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

value

number

The value to write into the copied array.

Returns

number[]

The copied array with the updated value.

Inherited from

Tuple2.with