v2u

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

Extends

Tuple2<number>.Swizzle2<v2u, v3u, v4u>.vecInfixNotation<v2u>

Indexable

[n: number]: number

Properties

[$internal]

readonly [$internal]: true

Defined in

packages/typegpu/src/data/wgslTypes.ts:494

[unscopables]

readonly [unscopables]: object

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]

Defined in

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

0

0: number

Inherited from

Tuple2.0

1

1: number

Inherited from

Tuple2.1

kind

readonly kind: "vec2u"

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

Defined in

packages/typegpu/src/data/wgslTypes.ts:496

length

length: 2

Inherited from

Tuple2.length

x

x: number

Defined in

packages/typegpu/src/data/wgslTypes.ts:497

xx

readonly xx: v2u

Inherited from

Swizzle2.xx

Defined in

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

xxx

readonly xxx: v3u

Inherited from

Swizzle2.xxx

Defined in

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

xxxx

readonly xxxx: v4u

Inherited from

Swizzle2.xxxx

Defined in

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

xxxy

readonly xxxy: v4u

Inherited from

Swizzle2.xxxy

Defined in

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

xxy

readonly xxy: v3u

Inherited from

Swizzle2.xxy

Defined in

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

xxyx

readonly xxyx: v4u

Inherited from

Swizzle2.xxyx

Defined in

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

xxyy

readonly xxyy: v4u

Inherited from

Swizzle2.xxyy

Defined in

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

xy

readonly xy: v2u

Inherited from

Swizzle2.xy

Defined in

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

xyx

readonly xyx: v3u

Inherited from

Swizzle2.xyx

Defined in

packages/typegpu/src/data/wgslTypes.ts:139

xyxx

readonly xyxx: v4u

Inherited from

Swizzle2.xyxx

Defined in

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

xyxy

readonly xyxy: v4u

Inherited from

Swizzle2.xyxy

Defined in

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

xyy

readonly xyy: v3u

Inherited from

Swizzle2.xyy

Defined in

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

xyyx

readonly xyyx: v4u

Inherited from

Swizzle2.xyyx

Defined in

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

xyyy

readonly xyyy: v4u

Inherited from

Swizzle2.xyyy

Defined in

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

y

y: number

Defined in

packages/typegpu/src/data/wgslTypes.ts:498

yx

readonly yx: v2u

Inherited from

Swizzle2.yx

Defined in

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

yxx

readonly yxx: v3u

Inherited from

Swizzle2.yxx

Defined in

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

yxxx

readonly yxxx: v4u

Inherited from

Swizzle2.yxxx

Defined in

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

yxxy

readonly yxxy: v4u

Inherited from

Swizzle2.yxxy

Defined in

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

yxy

readonly yxy: v3u

Inherited from

Swizzle2.yxy

Defined in

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

yxyx

readonly yxyx: v4u

Inherited from

Swizzle2.yxyx

Defined in

packages/typegpu/src/data/wgslTypes.ts:156

yxyy

readonly yxyy: v4u

Inherited from

Swizzle2.yxyy

Defined in

packages/typegpu/src/data/wgslTypes.ts:157

yy

readonly yy: v2u

Inherited from

Swizzle2.yy

Defined in

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

yyx

readonly yyx: v3u

Inherited from

Swizzle2.yyx

Defined in

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

yyxx

readonly yyxx: v4u

Inherited from

Swizzle2.yyxx

Defined in

packages/typegpu/src/data/wgslTypes.ts:158

yyxy

readonly yyxy: v4u

Inherited from

Swizzle2.yyxy

Defined in

packages/typegpu/src/data/wgslTypes.ts:159

yyy

readonly yyy: v3u

Inherited from

Swizzle2.yyy

Defined in

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

yyyx

readonly yyyx: v4u

Inherited from

Swizzle2.yyyx

Defined in

packages/typegpu/src/data/wgslTypes.ts:160

yyyy

readonly yyyy: v4u

Inherited from

Swizzle2.yyyy

Defined in

packages/typegpu/src/data/wgslTypes.ts:161

Methods

[iterator]()

[iterator](): ArrayIterator<number>

Iterator

Returns

ArrayIterator<number>

Inherited from

Tuple2.[iterator]

Defined in

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

add()

Call Signature

add(other): v2u

Parameters

other

number

Returns

v2u

Inherited from

vecInfixNotation.add

Defined in

packages/typegpu/src/data/wgslTypes.ts:60

Call Signature

add(other): v2u

Parameters

other

v2u

Returns

v2u

Inherited from

vecInfixNotation.add

Defined in

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

at()

at(index): undefined | number

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

Defined in

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

concat()

Call Signature

concat(…items): number[]

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

Defined in

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

Call Signature

concat(…items): number[]

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

Defined in

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

copyWithin()

copyWithin(target, start, end?): this

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

Defined in

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

div()

Call Signature

div(other): v2u

Parameters

other

number

Returns

v2u

Inherited from

vecInfixNotation.div

Defined in

packages/typegpu/src/data/wgslTypes.ts:70

Call Signature

div(other): v2u

Parameters

other

v2u

Returns

v2u

Inherited from

vecInfixNotation.div

Defined in

packages/typegpu/src/data/wgslTypes.ts:71

entries()

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

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

Returns

ArrayIterator<[number, number]>

Inherited from

Tuple2.entries

Defined in

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

every()

Call Signature

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

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

Defined in

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

Call Signature

every(predicate, thisArg?): boolean

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

Defined in

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

fill()

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

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

Defined in

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

filter()

Call Signature

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

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

Defined in

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

Call Signature

filter(predicate, thisArg?): number[]

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

Defined in

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

find()

Call Signature

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

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

Defined in

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

Call Signature

find(predicate, thisArg?): undefined | number

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

undefined | number

Inherited from

Tuple2.find

Defined in

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

findIndex()

findIndex(predicate, thisArg?): number

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

Defined in

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

findLast()

Call Signature

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

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

Defined in

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

Call Signature

findLast(predicate, thisArg?): undefined | number

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

undefined | number

Inherited from

Tuple2.findLast

Defined in

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

findLastIndex()

findLastIndex(predicate, thisArg?): number

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

Defined in

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

flat()

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

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

Defined in

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

flatMap()

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

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

Defined in

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

forEach()

forEach(callbackfn, thisArg?): void

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

Defined in

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

includes()

includes(searchElement, fromIndex?): boolean

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

Defined in

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

indexOf()

indexOf(searchElement, fromIndex?): number

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

Defined in

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

join()

join(separator?): string

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

Defined in

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

keys()

keys(): ArrayIterator<number>

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Tuple2.keys

Defined in

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

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

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

Defined in

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

map()

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

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

Defined in

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

mul()

Call Signature

mul(other): v2u

Parameters

other

number

Returns

v2u

Inherited from

vecInfixNotation.mul

Defined in

packages/typegpu/src/data/wgslTypes.ts:66

Call Signature

mul(other): v2u

Parameters

other

v2u

Returns

v2u

Inherited from

vecInfixNotation.mul

Defined in

packages/typegpu/src/data/wgslTypes.ts:67

Call Signature

mul(other): v2u

Parameters

other

never

Returns

v2u

Inherited from

vecInfixNotation.mul

Defined in

packages/typegpu/src/data/wgslTypes.ts:68

pop()

pop(): undefined | number

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

Defined in

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

push()

push(…items): number

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

Defined in

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

reduce()

Call Signature

reduce(callbackfn): number

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

Defined in

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

Call Signature

reduce(callbackfn, initialValue): number

Parameters

callbackfn

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

initialValue

number

Returns

number

Inherited from

Tuple2.reduce

Defined in

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

Call Signature

reduce<U>(callbackfn, initialValue): U

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

Defined in

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

reduceRight()

Call Signature

reduceRight(callbackfn): number

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

Defined in

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

Call Signature

reduceRight(callbackfn, initialValue): number

Parameters

callbackfn

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

initialValue

number

Returns

number

Inherited from

Tuple2.reduceRight

Defined in

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

Call Signature

reduceRight<U>(callbackfn, initialValue): U

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

Defined in

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

reverse()

reverse(): number[]

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

Defined in

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

shift()

shift(): undefined | number

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

Defined in

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

slice()

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

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

Defined in

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

some()

some(predicate, thisArg?): boolean

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

Defined in

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

sort()

sort(compareFn?): this

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

Defined in

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

splice()

Call Signature

splice(start, deleteCount?): number[]

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

Defined in

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

Call Signature

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

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

Defined in

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

sub()

Call Signature

sub(other): v2u

Parameters

other

number

Returns

v2u

Inherited from

vecInfixNotation.sub

Defined in

packages/typegpu/src/data/wgslTypes.ts:63

Call Signature

sub(other): v2u

Parameters

other

v2u

Returns

v2u

Inherited from

vecInfixNotation.sub

Defined in

packages/typegpu/src/data/wgslTypes.ts:64

toLocaleString()

Call Signature

toLocaleString(): string

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

Returns

string

Inherited from

Tuple2.toLocaleString

Defined in

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

Call Signature

toLocaleString(locales, options?): string

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Tuple2.toLocaleString

Defined in

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

toReversed()

toReversed(): number[]

Returns a copy of an array with its elements reversed.

Returns

number[]

Inherited from

Tuple2.toReversed

Defined in

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

toSorted()

toSorted(compareFn?): number[]

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

Defined in

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

toSpliced()

Call Signature

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

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

Defined in

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

Call Signature

toSpliced(start, deleteCount?): number[]

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

Defined in

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

toString()

toString(): string

Returns a string representation of an array.

Returns

string

Inherited from

Tuple2.toString

Defined in

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

unshift()

unshift(…items): number

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

Defined in

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

values()

values(): ArrayIterator<number>

Returns an iterable of values in the array

Returns

ArrayIterator<number>

Inherited from

Tuple2.values

Defined in

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

with()

with(index, value): number[]

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

Defined in

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