Class TokenRingSamplerShader

The shader definition which powers the TokenRing.

Hierarchy (view full)

PrimaryBaseSamplerShader
- TokenRingSamplerShader

Properties

initialUniforms

initialUniforms: object

The initial values of the shader uniforms.

`Static` classPluginName

classPluginName: string = "tokenRingBatch"

`Static` pausable

pausable: boolean = false

`Static` batchGeometry

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

Type declaration

id: string
size: number
normalized: boolean
type: any

`Static` batchVertexSize

batchVertexSize: number = ...

`Static` reservedTextureUnits

reservedTextureUnits: number = ...

`Static` nullUvs

nullUvs: Float32Array = ...

A null UVs array used for nulled texture position.

`Static` _batchVertexShader

_batchVertexShader: string = ...

`Static` _batchFragmentShader

_batchFragmentShader: string = ...

`Static` depthShaderClass

depthShaderClass: typeof DepthSamplerShader = DepthSamplerShader

The depth shader class associated with this shader.

`Static` defaultUniforms

defaultUniforms: {
    screenDimensions: number[];
    sampler: any;
    tintAlpha: number[];
    occlusionTexture: any;
    unoccludedAlpha: number;
    occludedAlpha: number;
    occlusionElevation: number;
    fadeOcclusion: number;
    radialOcclusion: number;
    visionOcclusion: number;
} = ...

Type declaration

screenDimensions: number[]
sampler: any
tintAlpha: number[]
occlusionTexture: any
unoccludedAlpha: number
occludedAlpha: number
occlusionElevation: number
fadeOcclusion: number
radialOcclusion: number
visionOcclusion: number

`Static` CONTRAST

CONTRAST: string = ...

Contrast adjustment

`Static` SATURATION

SATURATION: string = ...

Saturation adjustment

`Static` EXPOSURE

EXPOSURE: string = ...

Exposure adjustment.

`Static` batchRendererClass

batchRendererClass: typeof BatchRenderer = BatchRenderer

The batch renderer to use.

`Static` batchShaderGeneratorClass

batchShaderGeneratorClass: typeof BatchShaderGenerator = BatchShaderGenerator

The batch generator to use.

`Static` `Protected` _vertexShader

_vertexShader: string = ...

The vertex shader source. Subclasses can override it.

`Static` `Protected` _fragmentShader

_fragmentShader: string = ...

The fragment shader source. Subclasses can override it.

`Static` `Private` #FRAG_HEADER

#FRAG_HEADER: string = ...

The fragment shader header.

`Static` `Private` #FRAG_MAIN

#FRAG_MAIN: string = ...

Fragment shader body.

`Static` `Private` #FRAG_MAIN_DEBUG

#FRAG_MAIN_DEBUG: string = ...

Fragment shader body for debug code.

Accessors

depthShader

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

Returns DepthSamplerShader
Inherited from PrimaryBaseSamplerShader.depthShader

pluginName

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

Returns string
Inherited from PrimaryBaseSamplerShader.pluginName

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

`Static` batchVertexShader

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

`Static` batchFragmentShader

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

`Static` vertexShader

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

`Static` fragmentShader

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

`Static` ADJUSTMENTS

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

Returns string
Inherited from PrimaryBaseSamplerShader.ADJUSTMENTS

Methods

_preRender

_preRender(mesh, renderer): 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): 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

`Protected` _configure

_configure(): void
Protected
A one time initialization performed on creation.

Returns void
Inherited from PrimaryBaseSamplerShader._configure

`Private` #createDepthShader

#createDepthShader(): DepthSamplerShader
Create the depth shader and configure it.

Returns DepthSamplerShader
Inherited from PrimaryBaseSamplerShader.#createDepthShader

`Static` batchDefaultUniforms

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

`Static` _preRenderBatch

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

`Static` _packInterleavedGeometry

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

`Static` initializeBatchGeometry

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

Returns void
Inherited from PrimaryBaseSamplerShader.initializeBatchGeometry

`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` registerPlugin

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

`Static` create

create(initialUniforms): AbstractBaseShader
A factory method for creating the shader using its defined default values
Parameters
- initialUniforms: object
Returns AbstractBaseShader
Inherited from PrimaryBaseSamplerShader.create

Class TokenRingSamplerShader

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

initialUniforms

Static classPluginName

Static pausable

Static batchGeometry

Type declaration

id: string

size: number

normalized: boolean

type: any

Static batchVertexSize

Static reservedTextureUnits

Static nullUvs

Static _batchVertexShader

Static _batchFragmentShader

Static depthShaderClass

Static defaultUniforms

Type declaration

screenDimensions: number[]

sampler: any

tintAlpha: number[]

occlusionTexture: any

unoccludedAlpha: number

occludedAlpha: number

occlusionElevation: number

fadeOcclusion: number

radialOcclusion: number

visionOcclusion: number

Static CONTRAST

Static SATURATION

Static EXPOSURE

Static batchRendererClass

Static batchShaderGeneratorClass

Static Protected _vertexShader

Static Protected _fragmentShader

Static Private #FRAG_HEADER

Static Private #FRAG_MAIN

Static Private #FRAG_MAIN_DEBUG

Accessors

depthShader

Returns DepthSamplerShader

pluginName

Returns string

enabled

Returns boolean

paused

Returns boolean

See

Static batchVertexShader

Returns string

Static batchFragmentShader

Returns string

Static vertexShader

Returns string

Static fragmentShader

Returns string

Static ADJUSTMENTS

Returns string

Methods

_preRender

Parameters

Returns void

reset

Returns void

Protected _configureDepthShader

Parameters

Returns void

Protected _configure

Returns void

Private #createDepthShader

Returns DepthSamplerShader

Static batchDefaultUniforms

Parameters

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

`Static` classPluginName

`Static` pausable

`Static` batchGeometry

`Static` batchVertexSize

`Static` reservedTextureUnits

`Static` nullUvs

`Static` _batchVertexShader

`Static` _batchFragmentShader

`Static` depthShaderClass

`Static` defaultUniforms

`Static` CONTRAST

`Static` SATURATION

`Static` EXPOSURE

`Static` batchRendererClass

`Static` batchShaderGeneratorClass

`Static` `Protected` _vertexShader

`Static` `Protected` _fragmentShader

`Static` `Private` #FRAG_HEADER

`Static` `Private` #FRAG_MAIN

`Static` `Private` #FRAG_MAIN_DEBUG

`Static` batchVertexShader

`Static` batchFragmentShader

`Static` vertexShader

`Static` fragmentShader

`Static` ADJUSTMENTS

`Protected` _configureDepthShader

`Protected` _configure

`Private` #createDepthShader

`Static` batchDefaultUniforms

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

`Static` _preRenderBatch

`Static` _packInterleavedGeometry

`Static` initializeBatchGeometry

`Static` createPlugin

`Static` registerPlugin

`Static` create