Class TokenRingSamplerShader

The shader definition which powers the TokenRing.

Hierarchy (View Summary)

PrimaryBaseSamplerShader
- TokenRingSamplerShader

Properties

initialUniforms

initialUniforms: object

The initial values of the shader uniforms.

`Static`_batchFragmentShader

_batchFragmentShader: string = ...

`Static`_batchVertexShader

_batchVertexShader: string = ...

`Static`batchGeometry

batchGeometry: { id: string; normalized: boolean; size: number; type: TYPES }[] = ...

`Static`batchRendererClass

batchRendererClass: typeof BatchRenderer = BatchRenderer

The batch renderer to use.

`Static`batchShaderGeneratorClass

batchShaderGeneratorClass: typeof BatchShaderGenerator = BatchShaderGenerator

The batch generator to use.

`Static`batchVertexSize

batchVertexSize: number = ...

`Static`classPluginName

classPluginName: string = "tokenRingBatch"

`Static`CONTRAST

CONTRAST: string = ...

Contrast adjustment

`Static`depthShaderClass

depthShaderClass: typeof DepthSamplerShader = DepthSamplerShader

The depth shader class associated with this shader.

`Static`EXPOSURE

EXPOSURE: string = ...

Exposure adjustment.

`Static`nullUvs

nullUvs: Float32Array = ...

A null UVs array used for nulled texture position.

`Static`pausable

pausable: boolean = false

`Static`reservedTextureUnits

reservedTextureUnits: number = ...

`Static`SATURATION

SATURATION: string = ...

Saturation adjustment

`Protected` `Static`_fragmentShader

_fragmentShader: string = ...

The fragment shader source. Subclasses can override it.

`Protected` `Static`_vertexShader

_vertexShader: string = ...

The vertex shader source. Subclasses can override it.

Accessors

depthShader

get depthShader(): DepthSamplerShader
The depth shader associated with this shader. The depth shader is lazily constructed.

Returns DepthSamplerShader
Inherited from PrimaryBaseSamplerShader.depthShader

enabled

get enabled(): boolean
Activate or deactivate this sampler. If set to false, the batch rendering is redirected to "batch". Otherwise, the batch rendering is directed toward the instance pluginName (might be null)

Returns boolean
Inherited from PrimaryBaseSamplerShader.enabled

paused

get paused(): boolean
Pause or Unpause this sampler. If set to true, the shader is disabled. Otherwise, it is enabled. Contrary to enabled, a shader might decide to refuse a pause, to continue to render animations per example.

Returns boolean
See
Inherited from PrimaryBaseSamplerShader.paused

pluginName

get pluginName(): string | null
The plugin name associated for this instance, if any. Returns "batch" if the shader is disabled.

Returns string | null
Inherited from PrimaryBaseSamplerShader.pluginName

`Static`ADJUSTMENTS

get ADJUSTMENTS(): string
The adjustments made into fragment shaders.

Returns string
Inherited from PrimaryBaseSamplerShader.ADJUSTMENTS

`Static`batchFragmentShader

get batchFragmentShader(): string
Returns string
Inherited from PrimaryBaseSamplerShader.batchFragmentShader

`Static`batchVertexShader

get batchVertexShader(): string
Returns string
Inherited from PrimaryBaseSamplerShader.batchVertexShader

`Static`defaultUniforms

get defaultUniforms(): {
    fadeOcclusion: number;
    occludedAlpha: number;
    occlusionElevation: number;
    occlusionTexture: null;
    radialOcclusion: number;
    sampler: null;
    screenDimensions: number[];
    surfaceOcclusion: number;
    tintAlpha: number[];
    unoccludedAlpha: number;
    visionOcclusion: number;
}
Returns {
    fadeOcclusion: number;
    occludedAlpha: number;
    occlusionElevation: number;
    occlusionTexture: null;
    radialOcclusion: number;
    sampler: null;
    screenDimensions: number[];
    surfaceOcclusion: number;
    tintAlpha: number[];
    unoccludedAlpha: number;
    visionOcclusion: number;
}
Inherited from PrimaryBaseSamplerShader.defaultUniforms

Methods

_preRender

_preRender(mesh: any, renderer: any): void
Parameters
- mesh: any
- renderer: any
Returns void
Inherited from PrimaryBaseSamplerShader._preRender

reset

reset(): void
Reset the shader uniforms back to their initial values.

Returns void
Inherited from PrimaryBaseSamplerShader.reset

`Protected`_configureDepthShader

_configureDepthShader(depthShader: DepthSamplerShader): void
Protected
One-time configuration that is called when the depth shader is created.
Parameters
- depthShader: DepthSamplerShader
  The depth shader
Returns void
Inherited from PrimaryBaseSamplerShader._configureDepthShader

`Static`_createFragmentShader

_createFragmentShader(): string
Returns string
Inherited from PrimaryBaseSamplerShader._createFragmentShader

`Static`_createVertexShader

_createVertexShader(): string
Returns string
Inherited from PrimaryBaseSamplerShader._createVertexShader

`Static`_packInterleavedGeometry

_packInterleavedGeometry(
    element: any,
    attributeBuffer: any,
    indexBuffer: any,
    aIndex: any,
    iIndex: any,
): void
Parameters
- element: any
- attributeBuffer: any
- indexBuffer: any
- aIndex: any
- iIndex: any
Returns void
Overrides PrimaryBaseSamplerShader._packInterleavedGeometry

`Static`_preRenderBatch

_preRenderBatch(batchRenderer: any): void
Parameters
- batchRenderer: any
Returns void
Overrides PrimaryBaseSamplerShader._preRenderBatch

`Static`batchDefaultUniforms

batchDefaultUniforms(
    maxTex: any,
): {
    occlusionTexture: any;
    screenDimensions: number[];
    time: number;
    tokenRingTexture: any;
}
Parameters
- maxTex: any
Returns {
    occlusionTexture: any;
    screenDimensions: number[];
    time: number;
    tokenRingTexture: any;
}
Overrides PrimaryBaseSamplerShader.batchDefaultUniforms

`Static`create

create(uniforms: any, options: any): AbstractBaseShader
Parameters
- uniforms: any
- options: any
Returns AbstractBaseShader
Inherited from PrimaryBaseSamplerShader.create

`Static`createPlugin

createPlugin(): any
Create a batch plugin for this sampler class.

Returns any
The batch plugin class linked to this sampler class.

Inherited from PrimaryBaseSamplerShader.createPlugin

`Static`initializeBatchGeometry

initializeBatchGeometry(): void
Initialize the batch geometry with custom properties.

Returns void
Inherited from PrimaryBaseSamplerShader.initializeBatchGeometry

`Static`registerPlugin

registerPlugin(options?: { force?: object }): void
Register the plugin for this sampler.
Parameters
- Optionaloptions: { force?: object } = {}
  The options
  - Optionalforce?: object
    Override the plugin of the same name that is already registered?
Returns void
Inherited from PrimaryBaseSamplerShader.registerPlugin

Class TokenRingSamplerShader

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

initialUniforms

Static_batchFragmentShader

Static_batchVertexShader

StaticbatchGeometry

StaticbatchRendererClass

StaticbatchShaderGeneratorClass

StaticbatchVertexSize

StaticclassPluginName

StaticCONTRAST

StaticdepthShaderClass

StaticEXPOSURE

StaticnullUvs

Staticpausable

StaticreservedTextureUnits

StaticSATURATION

Protected Static_fragmentShader

Protected Static_vertexShader

Accessors

depthShader

Returns DepthSamplerShader

enabled

Returns boolean

paused

Returns boolean

See

pluginName

Returns string | null

StaticADJUSTMENTS

Returns string

StaticbatchFragmentShader

Returns string

StaticbatchVertexShader

Returns string

StaticdefaultUniforms

Returns { fadeOcclusion: number; occludedAlpha: number; occlusionElevation: number; occlusionTexture: null; radialOcclusion: number; sampler: null; screenDimensions: number[]; surfaceOcclusion: number; tintAlpha: number[]; unoccludedAlpha: number; visionOcclusion: number;}

Methods

_preRender

Parameters

Returns void

reset

Returns void

Protected_configureDepthShader

Parameters

Returns void

Static_createFragmentShader

Returns string

Static_createVertexShader

Returns string

Static_packInterleavedGeometry

Parameters

Returns void

Static_preRenderBatch

Parameters

Returns void

StaticbatchDefaultUniforms

Parameters

Returns { occlusionTexture: any; screenDimensions: number[]; time: number; tokenRingTexture: any;}

Staticcreate

Parameters

Returns AbstractBaseShader

StaticcreatePlugin

Returns any

StaticinitializeBatchGeometry

Returns void

StaticregisterPlugin

Parameters

Optionalforce?: object

Returns void

Settings

On This Page

`Static`_batchFragmentShader

`Static`_batchVertexShader

`Static`batchGeometry

`Static`batchRendererClass

`Static`batchShaderGeneratorClass

`Static`batchVertexSize

`Static`classPluginName

`Static`CONTRAST

`Static`depthShaderClass

`Static`EXPOSURE

`Static`nullUvs

`Static`pausable

`Static`reservedTextureUnits

`Static`SATURATION

`Protected` `Static`_fragmentShader

`Protected` `Static`_vertexShader

`Static`ADJUSTMENTS

`Static`batchFragmentShader

`Static`batchVertexShader

`Static`defaultUniforms

Returns {
fadeOcclusion: number;
occludedAlpha: number;
occlusionElevation: number;
occlusionTexture: null;
radialOcclusion: number;
sampler: null;
screenDimensions: number[];
surfaceOcclusion: number;
tintAlpha: number[];
unoccludedAlpha: number;
visionOcclusion: number;
}

`Protected`_configureDepthShader

`Static`_createFragmentShader

`Static`_createVertexShader

`Static`_packInterleavedGeometry

`Static`_preRenderBatch

`Static`batchDefaultUniforms

Returns {
occlusionTexture: any;
screenDimensions: number[];
time: number;
tokenRingTexture: any;
}

`Static`create

`Static`createPlugin

`Static`initializeBatchGeometry

`Static`registerPlugin

`Optional`force?: object