TextureBlock

Block used to read a texture from a sampler

Hierarchy

Index

Constructors

constructor

Find examples in Playground

Properties

autoConnectTextureMatrix

Find examples in Playground
autoConnectTextureMatrix: boolean

Gets or sets a boolean indicating that the block can automatically fetch the texture matrix

autoSelectUV

Find examples in Playground
autoSelectUV: boolean

Gets or sets a boolean indicating that the block can automatically select the uv channel based on texture

buildId

Find examples in Playground
buildId: number

Gets or sets the build Id

inputs

Find examples in Playground

Gets the list of input points

isFinalMerger

Find examples in Playground
isFinalMerger: boolean

Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)

name

Find examples in Playground
name: string

Gets or sets the name of the block

outputs

Find examples in Playground

Gets the list of output points

target

Find examples in Playground

Gets or sets the target of the block

texture

Find examples in Playground

Gets the texture input component

textureInfo

Find examples in Playground

Gets the texture information input component

textureTransform

Find examples in Playground
textureTransform: NodeMaterialConnectionPoint

Gets the texture transform input component

transformedUV

Find examples in Playground

Gets the transformed uv input component

uv

Find examples in Playground

Gets the uv input component

Methods

autoConfigure

Find examples in Playground
  • autoConfigure(): void

bind

Find examples in Playground
  • Bind data to effect. Will only be called for blocks with isBindable === true

    Parameters

    • effect: Effect

      defines the effect to bind data to

    • nodeMaterial: NodeMaterial

      defines the hosting NodeMaterial

    • Optional mesh: Mesh

      defines the mesh that will be rendered

    Returns void

build

Find examples in Playground
  • Compile the current node and generate the shader code

    Parameters

    Returns this | undefined

    the current block

connectTo

Find examples in Playground
  • Connect current block with another block

    Parameters

    • other: NodeMaterialBlock

      defines the block to connect with

    • Optional options: object

      define the various options to help pick the right connections

      • Optional input?: string
      • Optional output?: string
      • Optional outputSwizzle?: string

    Returns this | undefined

    the current block

getClassName

Find examples in Playground
  • getClassName(): string

getFirstAvailableInput

Find examples in Playground

getFirstAvailableOutput

Find examples in Playground

getInputByName

Find examples in Playground

getOutputByName

Find examples in Playground

initialize

Find examples in Playground

isReady

Find examples in Playground
  • isReady(): boolean

prepareDefines

Find examples in Playground

provideFallbacks

Find examples in Playground

registerInput

Find examples in Playground
  • Register a new input. Must be called inside a block constructor

    Parameters

    • name: string

      defines the connection point name

    • type: NodeMaterialBlockConnectionPointTypes

      defines the connection point type

    • Optional isOptional: boolean

      defines a boolean indicating that this input can be omitted

    • Optional target: NodeMaterialBlockTargets

      defines the target to use to limit the connection point (will be VetexAndFragment by default)

    Returns this

    the current block

registerOutput

Find examples in Playground

replaceRepeatableContent

Find examples in Playground

Generated using TypeDoc