TSL Docs

CubeTextureNode

Last modified: Jun 30, 2024

This type of uniform node represents a cube texture.

Constructor

new CubeTextureNode(value, uvNode?, levelNode?, biasNode?)

Parameter	Type	Default Value
value	`CubeTexture`	—
uvNode?	`any`	`null`
levelNode?	`any`	`null`
biasNode?	`any`	`null`

Constructs a new cube texture node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type	Default Value
isCubeTextureNode	`boolean`		—

Method Type

getInputType () => string

Overwrites the default implementation to return the appropriate cube texture type.

Returns

string

getDefaultUV () => any

Returns a default uvs based on the mapping type of the cube texture.

Returns

any

setUpdateMatrix () => void

Overwritten with an empty implementation since the updateMatrix flag is ignored for cube textures. The uv transformation matrix is not applied to cube textures.

Returns

void

setupUV (builder: NodeBuilder, uvNode: Node) => Node

Setups the uv node. Depending on the backend as well as the texture type, it might be necessary to modify the uv node for correct sampling.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
uvNode	`Node`	—

Returns

Node

generateUV (builder: NodeBuilder, cubeUV: Node) => string

Generates the uv code snippet.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
cubeUV	`Node`	—

Returns

string

Extends

TextureNode

cubeTextureBase

TSL function for creating a cube texture node.

Parameter	Type	Default Value
value	`CubeTexture`	—
uvNode?	`Node<vec3>`	—
levelNode?	`Node<int>`	—
biasNode?	`Node<float>`	—

Returns

CubeTextureNode

cubeTexture

TSL function for creating a cube texture uniform node.

Parameter	Type	Default Value
value?	`null \| CubeTextureNode \| CubeTexture`	`EmptyTexture`
uvNode?	`any`	`null`
levelNode?	`any`	`null`
biasNode?	`any`	`null`

Returns

CubeTextureNode

uniformCubeTexture

TSL function for creating a uniform cube texture node.

Parameter	Type	Default Value
value?	`null \| CubeTexture`	`EmptyTexture`

Returns

CubeTextureNode