TSL Docs

TextureNode

Last modified: Jun 30, 2024

This type of uniform node represents a 2D texture.

Constructor

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

Parameter	Type	Default Value
value?	`Texture`	`EmptyTexture`
uvNode?	`any`	`null`
levelNode?	`any`	`null`
biasNode?	`any`	`null`

Constructs a new texture node.

Accessor Type

get type string

Modifiers

static

set value Texture

Parameter

Parameter	Type	Default Value
value	`Texture`	—

get value Texture

The texture value.

Properties

Property	Type
isTextureNode	`boolean`	—
uvNode	`any`	—
levelNode	`any`	—
biasNode	`any`	—
compareNode	`any`	—
depthNode	`any`	—
gradNode	`null \| Array<any>`	—
gatherNode	`any`	—
offsetNode	`any`	—
sampler	`boolean`	—
updateMatrix	`boolean`	—
referenceNode	`null \| Node`	—
_value	`Texture`	—
_matrixUniform	`any`	—
_flipYUniform	`any`	—
_samplerComparison	`boolean`	—

Method Type

getUniformHash () => string

Overwritten since the uniform hash is defined by the texture’s UUID.

Returns

string

generateNodeType () => string

Overwritten since the node type is inferred from the texture type.

Returns

string

getInputType () => string

Overwrites the default implementation to return a fixed value 'texture'.

Returns

string

getDefaultUV () => AttributeNode<…>

Returns a default uvs based on the current texture’s channel.

Returns

AttributeNode<vec2>

updateReference () => Texture

Overwritten to always return the texture reference of the node.

Returns

Texture

getTransformedUV (uvNode: Node) => Node

Transforms the given uv node with the texture transformation matrix.

Parameter	Type	Default Value
uvNode	`Node`	—

Returns

Node

setUpdateMatrix (value: boolean) => TextureNode

Defines whether the uv transformation matrix should automatically be updated or not.

Parameter	Type	Default Value
value	`boolean`	—

Returns

TextureNode

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

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

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

Returns

Node

setup (builder: NodeBuilder) => void

Setups texture node by preparing the internal nodes for code generation.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

void

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

Generates the uv code snippet.

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

Returns

string

generateOffset (builder: NodeBuilder, offsetNode: Node) => string

Generates the offset code snippet.

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

Returns

string

Generates the snippet for the texture sampling.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
textureProperty	`string`	—
uvSnippet	`string`	—
levelSnippet	`null \| string`	—
biasSnippet	`null \| string`	—
depthSnippet	`null \| string`	—
compareSnippet	`null \| string`	—
gradSnippet	`null \| Array<string>`	—
gatherSnippet	`null \| string`	—
offsetSnippet	`null \| string`	—
flipYSnippet	`null \| string`	—

Returns

string

generate (builder: NodeBuilder, output: string) => string

Generates the code snippet of the texture node.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
output	`string`	—

Returns

string

setSampler (value: boolean) => TextureNode

Sets the sampler value.

Parameter	Type	Default Value
value	`boolean`	—

Returns

TextureNode

getSampler () => boolean

Returns the sampler value.

Returns

boolean

sample (uvNode: Node) => TextureNode

Samples the texture with the given uv node.

Parameter	Type	Default Value
uvNode	`Node`	—

Returns

TextureNode

load (uvNode: Node<…>) => TextureNode

TSL function for creating a texture node that fetches/loads texels without interpolation.

Parameter	Type	Default Value
uvNode	`Node<uvec2>`	—

Returns

TextureNode

blur (amountNode: Node<…>) => TextureNode

Samples a blurred version of the texture by defining an internal bias.

Parameter	Type	Default Value
amountNode	`Node<float>`	—

Returns

TextureNode

level (levelNode: Node<…>) => TextureNode

Samples a specific mip of the texture.

Parameter	Type	Default Value
levelNode	`Node<int>`	—

Returns

TextureNode

size (levelNode: Node<…>) => TextureSizeNode

Returns the texture size of the requested level.

Parameter	Type	Default Value
levelNode	`Node<int>`	—

Returns

TextureSizeNode

bias (biasNode: Node<…>) => TextureNode

Samples the texture with the given bias.

Parameter	Type	Default Value
biasNode	`Node<float>`	—

Returns

TextureNode

getBase () => TextureNode

Returns the base texture of this node.

Returns

TextureNode

compare (compareNode: Node<…>) => TextureNode

Samples the texture by executing a compare operation.

Parameter	Type	Default Value
compareNode	`Node<float>`	—

Returns

TextureNode

grad (gradNodeX: Node<…>, gradNodeY: Node<…>) => TextureNode

Samples the texture using an explicit gradient.

Parameter	Type	Default Value
gradNodeX	`Node<vec2>`	—
gradNodeY	`Node<vec2>`	—

Returns

TextureNode

gather (gatherNode?: Node<…>) => TextureNode

Gathers four texels from the texture.

Parameter	Type	Default Value
gatherNode?	`Node<int>`	`0`

Returns

TextureNode

isSampleCompare () => boolean

Returns true if the texture is sampled with a depth comparison, meaning the node must be bound with a comparison sampler.

Returns

boolean

depth (depthNode: Node<…>) => TextureNode

Samples the texture by defining a depth node.

Parameter	Type	Default Value
depthNode	`Node<int>`	—

Returns

TextureNode

offset (offsetNode: Node<…>) => TextureNode

Samples the texture by defining an offset node.

Parameter	Type	Default Value
offsetNode	`Node<ivec2>`	—

Returns

TextureNode

serialize (data: any) => void

Parameter	Type	Default Value
data	`any`	—

Returns

void

deserialize (data: any) => void

Parameter	Type	Default Value
data	`any`	—

Returns

void

update () => void

The update is used to implement the update of the uv transformation matrix.

Returns

void

clone () => TextureNode

Clones the texture node.

Returns

TextureNode

Extends

UniformNode

texture

TSL function for creating a texture node or sample a texture node already existing.

Parameter	Type	Default Value
value?	`null \| TextureNode \| Texture`	`EmptyTexture`
uvNode?	`any`	`null`
levelNode?	`any`	`null`
biasNode?	`any`	`null`

Returns

TextureNode

uniformTexture

TSL function for creating a uniform texture node.

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

Returns

TextureNode

textureLoad

TSL function for creating a texture node that fetches/loads texels without interpolation.

Parameter	Type	Default Value
params	`...Array<any>`	—

Returns

TextureNode

textureLevel

Parameter	Type	Default Value
value	`any`	—
uv	`any`	—
level	`any`	—

Returns

TextureNode

sampler

Converts a texture or texture node to a sampler.

Parameter	Type	Default Value
value	`TextureNode \| Texture`	—

Returns

Node

samplerComparison

Converts a texture or texture node to a sampler comparison.

Parameter	Type	Default Value
value	`TextureNode \| Texture`	—

Returns

Node