Babylon.js Documentation

Hierarchy

ProceduralTexture
- CustomProceduralTexture

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CustomProceduralTexture(name: string, texturePath: any, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean): CustomProceduralTexture

Overrides ProceduralTexture.constructor

Parameters
- name: string
- texturePath: any
- size: number
- scene: Scene
- Optional fallbackTexture: Texture
- Optional generateMipMaps: boolean
Returns CustomProceduralTexture

Properties

animate

animate: boolean

animations

animations: Animation[]

anisotropicFilteringLevel

anisotropicFilteringLevel: number

canRescale

canRescale: boolean

coordinatesIndex

coordinatesIndex: number

coordinatesMode

coordinatesMode: number

How a texture is mapped.

Value	Type	Description
0	EXPLICIT_MODE
1	SPHERICAL_MODE
2	PLANAR_MODE
3	CUBIC_MODE
4	PROJECTION_MODE
5	SKYBOX_MODE
6	INVCUBIC_MODE
7	EQUIRECTANGULAR_MODE
8	FIXED_EQUIRECTANGULAR_MODE
9	FIXED_EQUIRECTANGULAR_MIRRORED_MODE

delayLoadState

delayLoadState: number

gammaSpace

gammaSpace: boolean

getAlphaFromRGB

getAlphaFromRGB: boolean

hasAlpha

hasAlpha: boolean

invertZ

invertZ: boolean

is3D

is3D: boolean

isBlocking

isBlocking: boolean

isCube

isCube: boolean

isEnabled

isEnabled: boolean

isRenderTarget

isRenderTarget: boolean

level

level: number

lodGenerationOffset

lodGenerationOffset: number

lodGenerationScale

lodGenerationScale: number

lodLevelInAlpha

lodLevelInAlpha: boolean

name

name: string

noMipmap

noMipmap: boolean

onDispose

onDispose: function

Type declaration

- (): void
- Returns void

onDisposeObservable

onDisposeObservable: Observable<BaseTexture>

An event triggered when the texture is disposed.

onGenerated

onGenerated: function

Type declaration

- (): void
- Returns void

onLoadObservable

onLoadObservable: Observable<Texture>

refreshRate

refreshRate: number

samplingMode

samplingMode: number

sphericalPolynomial

sphericalPolynomial: Nullable<SphericalPolynomial>

textureFormat

textureFormat: number

textureType

textureType: number

uAng

uAng: number

uOffset

uOffset: number

uScale

uScale: number

uid

uid: string

url

url: Nullable<string>

vAng

vAng: number

vOffset

vOffset: number

vScale

vScale: number

wAng

wAng: number

wrapR

wrapR: number

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

wrapU

wrapU: number

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

wrapV

wrapV: number

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

Static BILINEAR_SAMPLINGMODE

BILINEAR_SAMPLINGMODE: number

Static CLAMP_ADDRESSMODE

CLAMP_ADDRESSMODE: number

Static CUBIC_MODE

CUBIC_MODE: number

Static DEFAULT_ANISOTROPIC_FILTERING_LEVEL

DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number

Static EQUIRECTANGULAR_MODE

EQUIRECTANGULAR_MODE: number

Static EXPLICIT_MODE

EXPLICIT_MODE: number

Static FIXED_EQUIRECTANGULAR_MIRRORED_MODE

FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number

Static FIXED_EQUIRECTANGULAR_MODE

FIXED_EQUIRECTANGULAR_MODE: number

Static INVCUBIC_MODE

INVCUBIC_MODE: number

Static LINEAR_LINEAR

LINEAR_LINEAR: number

Static LINEAR_LINEAR_MIPLINEAR

LINEAR_LINEAR_MIPLINEAR: number

Static LINEAR_LINEAR_MIPNEAREST

LINEAR_LINEAR_MIPNEAREST: number

Static LINEAR_NEAREST

LINEAR_NEAREST: number

Static LINEAR_NEAREST_MIPLINEAR

LINEAR_NEAREST_MIPLINEAR: number

Static LINEAR_NEAREST_MIPNEAREST

LINEAR_NEAREST_MIPNEAREST: number

Static MIRROR_ADDRESSMODE

MIRROR_ADDRESSMODE: number

Static NEAREST_LINEAR

NEAREST_LINEAR: number

Static NEAREST_LINEAR_MIPLINEAR

NEAREST_LINEAR_MIPLINEAR: number

Static NEAREST_LINEAR_MIPNEAREST

NEAREST_LINEAR_MIPNEAREST: number

Static NEAREST_NEAREST

NEAREST_NEAREST: number

Static NEAREST_NEAREST_MIPLINEAR

NEAREST_NEAREST_MIPLINEAR: number

Static NEAREST_NEAREST_MIPNEAREST

NEAREST_NEAREST_MIPNEAREST: number

Static NEAREST_SAMPLINGMODE

NEAREST_SAMPLINGMODE: number

Static PLANAR_MODE

PLANAR_MODE: number

Static PROJECTION_MODE

PROJECTION_MODE: number

Static SKYBOX_MODE

SKYBOX_MODE: number

Static SPHERICAL_MODE

SPHERICAL_MODE: number

Static TRILINEAR_SAMPLINGMODE

TRILINEAR_SAMPLINGMODE: number

Static UseSerializedUrlIfAny

UseSerializedUrlIfAny: boolean

Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file

Static WRAP_ADDRESSMODE

WRAP_ADDRESSMODE: number

Methods

clone

clone(): ProceduralTexture

Inherited from ProceduralTexture.clone

Overrides Texture.clone

Returns ProceduralTexture

delayLoad

delayLoad(): void

Inherited from Texture.delayLoad

Overrides BaseTexture.delayLoad

Returns void

dispose

dispose(): void

Inherited from ProceduralTexture.dispose

Overrides Texture.dispose

Returns void

getBaseSize

getBaseSize(): ISize

Inherited from BaseTexture.getBaseSize

Returns ISize

getClassName

getClassName(): string

Inherited from Texture.getClassName

Overrides BaseTexture.getClassName

Returns string

getInternalTexture

getInternalTexture(): Nullable<InternalTexture>

Inherited from BaseTexture.getInternalTexture

Returns Nullable<InternalTexture>

getReflectionTextureMatrix

getReflectionTextureMatrix(): Matrix

Inherited from Texture.getReflectionTextureMatrix

Overrides BaseTexture.getReflectionTextureMatrix

Returns Matrix

getRenderSize

getRenderSize(): number

Inherited from ProceduralTexture.getRenderSize

Returns number

getScene

getScene(): Nullable<Scene>

Inherited from BaseTexture.getScene

Returns Nullable<Scene>

getSize

getSize(): ISize

Inherited from BaseTexture.getSize

Returns ISize

getTextureMatrix

getTextureMatrix(): Matrix

Inherited from Texture.getTextureMatrix

Overrides BaseTexture.getTextureMatrix

Returns Matrix

isReady

isReady(): boolean

Overrides ProceduralTexture.isReady

Returns boolean

isReadyOrNotBlocking

isReadyOrNotBlocking(): boolean

Inherited from BaseTexture.isReadyOrNotBlocking

Returns boolean

readPixels

readPixels(faceIndex?: number): Nullable<ArrayBufferView>

Inherited from BaseTexture.readPixels

Parameters
- Optional faceIndex: number
Returns Nullable<ArrayBufferView>

releaseInternalTexture

releaseInternalTexture(): void

Inherited from BaseTexture.releaseInternalTexture

Returns void

render

render(useCameraPostProcess?: boolean): void

Overrides ProceduralTexture.render

Parameters
- Optional useCameraPostProcess: boolean
Returns void

reset

reset(): void

Inherited from ProceduralTexture.reset

Returns void

resetRefreshCounter

resetRefreshCounter(): void

Inherited from ProceduralTexture.resetRefreshCounter

Returns void

resize

resize(size: number, generateMipMaps: boolean): void

Inherited from ProceduralTexture.resize

Parameters
- size: number
- generateMipMaps: boolean
Returns void

scale

scale(ratio: number): void

Inherited from BaseTexture.scale

Parameters
- ratio: number
Returns void

serialize

serialize(): any

Inherited from Texture.serialize

Overrides BaseTexture.serialize

Returns any

setColor3

setColor3(name: string, value: Color3): ProceduralTexture

Inherited from ProceduralTexture.setColor3

Parameters
- name: string
- value: Color3
Returns ProceduralTexture

setColor4

setColor4(name: string, value: Color4): ProceduralTexture

Inherited from ProceduralTexture.setColor4

Parameters
- name: string
- value: Color4
Returns ProceduralTexture

setFloat

setFloat(name: string, value: number): ProceduralTexture

Inherited from ProceduralTexture.setFloat

Parameters
- name: string
- value: number
Returns ProceduralTexture

setFloats

setFloats(name: string, value: number[]): ProceduralTexture

Inherited from ProceduralTexture.setFloats

Parameters
- name: string
- value: number[]
Returns ProceduralTexture

setFragment

setFragment(fragment: any): void

Inherited from ProceduralTexture.setFragment

Parameters
- fragment: any
Returns void

setMatrix

setMatrix(name: string, value: Matrix): ProceduralTexture

Inherited from ProceduralTexture.setMatrix

Parameters
- name: string
- value: Matrix
Returns ProceduralTexture

setTexture

setTexture(name: string, texture: Texture): ProceduralTexture

Inherited from ProceduralTexture.setTexture

Parameters
- name: string
- texture: Texture
Returns ProceduralTexture

setVector2

setVector2(name: string, value: Vector2): ProceduralTexture

Inherited from ProceduralTexture.setVector2

Parameters
- name: string
- value: Vector2
Returns ProceduralTexture

setVector3

setVector3(name: string, value: Vector3): ProceduralTexture

Inherited from ProceduralTexture.setVector3

Parameters
- name: string
- value: Vector3
Returns ProceduralTexture

toString

toString(): string

Inherited from BaseTexture.toString

Returns string

updateSamplingMode

updateSamplingMode(samplingMode: number): void

Inherited from Texture.updateSamplingMode

Parameters
- samplingMode: number
Returns void

updateShaderUniforms

updateShaderUniforms(): void

Returns void

updateTextures

updateTextures(): void

Returns void

updateURL

updateURL(url: string): void

Inherited from Texture.updateURL

Parameters
- url: string
Returns void

Static CreateFromBase64String

CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<function>, onError?: Nullable<function>, format?: number): Texture

Inherited from Texture.CreateFromBase64String

Parameters
- data: string
- name: string
- scene: Scene
- Optional noMipmap: boolean
- Optional invertY: boolean
- Optional samplingMode: number
- Optional onLoad: Nullable<function>
- Optional onError: Nullable<function>
- Optional format: number
Returns Texture

Static LoadFromDataString

LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<function>, onError?: Nullable<function>, format?: number): Texture

Inherited from Texture.LoadFromDataString

Parameters
- name: string
- buffer: any
- scene: Scene
- Optional deleteBuffer: boolean
- Optional noMipmap: boolean
- Optional invertY: boolean
- Optional samplingMode: number
- Optional onLoad: Nullable<function>
- Optional onError: Nullable<function>
- Optional format: number
Returns Texture

Static Parse

Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>

Inherited from Texture.Parse

Parameters
- parsedTexture: any
- scene: Scene
- rootUrl: string
Returns Nullable<BaseTexture>

Static WhenAllReady

WhenAllReady(textures: BaseTexture[], callback: function): void

Inherited from BaseTexture.WhenAllReady

Parameters
- textures: BaseTexture[]
- callback: function
  - - (): void
    - Returns void
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

texturePath: any

size: number

scene: Scene

Optional fallbackTexture: Texture

Optional generateMipMaps: boolean

Returns CustomProceduralTexture

Properties

animate

animations

anisotropicFilteringLevel

canRescale

coordinatesIndex

coordinatesMode

delayLoadState

gammaSpace

getAlphaFromRGB

hasAlpha

invertZ

is3D

isBlocking

isCube

isEnabled

isRenderTarget

level

lodGenerationOffset

lodGenerationScale

lodLevelInAlpha

name

noMipmap

onDispose

Type declaration

Returns void

onDisposeObservable

onGenerated

Type declaration

Returns void

onLoadObservable

refreshRate

samplingMode

sphericalPolynomial

textureFormat

textureType

uAng

uOffset

uScale

uid

url

vAng

vOffset

vScale

wAng

wrapR

wrapU

wrapV

Static BILINEAR_SAMPLINGMODE

Static CLAMP_ADDRESSMODE

Static CUBIC_MODE

Static DEFAULT_ANISOTROPIC_FILTERING_LEVEL

Static EQUIRECTANGULAR_MODE

Static EXPLICIT_MODE

Static FIXED_EQUIRECTANGULAR_MIRRORED_MODE

Static FIXED_EQUIRECTANGULAR_MODE

Static INVCUBIC_MODE

Static LINEAR_LINEAR

Static LINEAR_LINEAR_MIPLINEAR

Static LINEAR_LINEAR_MIPNEAREST

Static LINEAR_NEAREST

Static LINEAR_NEAREST_MIPLINEAR

Static LINEAR_NEAREST_MIPNEAREST

Static MIRROR_ADDRESSMODE

Static NEAREST_LINEAR