Class OccludableSamplerShader

The occlusion sampler shader.

Hierarchy (view full)

BaseSamplerShader
- OccludableSamplerShader
  - PrimaryBaseSamplerShader

Properties

initialUniforms

initialUniforms: object

The initial values of the shader uniforms.

`Static` classPluginName

classPluginName: string = "batchOcclusion"

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

`Static` reservedTextureUnits

reservedTextureUnits: number = 1

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

pausable: boolean = true

Is this shader pausable or not?

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

_batchVertexShader: string = ...

The batch vertex shader source. Subclasses can override it.

`Static` `Protected` _batchFragmentShader

_batchFragmentShader: string = ...

The batch fragment shader source. Subclasses can override it.

`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` #OCCLUSION

#OCCLUSION: string = ...

The fragment shader code that applies occlusion.

Accessors

pluginName

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

Returns string
Inherited from BaseSamplerShader.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 BaseSamplerShader.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 BaseSamplerShader.paused

`Static` batchVertexShader

get batchVertexShader(): string
Returns string
Overrides BaseSamplerShader.batchVertexShader

`Static` batchFragmentShader

get batchFragmentShader(): string
Returns string
Overrides BaseSamplerShader.batchFragmentShader

`Static` vertexShader

get vertexShader(): string
Returns string
Overrides BaseSamplerShader.vertexShader

`Static` fragmentShader

get fragmentShader(): string
Returns string
Overrides BaseSamplerShader.fragmentShader

`Static` ADJUSTMENTS

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

Returns string
Inherited from BaseSamplerShader.ADJUSTMENTS

Methods

_preRender

_preRender(mesh, renderer): void
Parameters
- mesh: any
- renderer: any
Returns void
Overrides BaseSamplerShader._preRender

reset

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

Returns void
Inherited from BaseSamplerShader.reset

`Protected` _configure

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

Returns void
Inherited from BaseSamplerShader._configure

`Static` batchDefaultUniforms

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

`Static` _preRenderBatch

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

`Static` _packInterleavedGeometry

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

`Static` initializeBatchGeometry

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

Returns void
Inherited from BaseSamplerShader.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 BaseSamplerShader.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 BaseSamplerShader.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 BaseSamplerShader.create

Class OccludableSamplerShader

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

initialUniforms

Static classPluginName

Static batchGeometry

Type declaration

id: string

size: number

normalized: boolean

type: any

Static batchVertexSize

Static reservedTextureUnits

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 pausable

Static CONTRAST

Static SATURATION

Static EXPOSURE

Static batchRendererClass

Static batchShaderGeneratorClass

Static Protected _batchVertexShader

Static Protected _batchFragmentShader

Static Protected _vertexShader

Static Protected _fragmentShader

Static Private #OCCLUSION

Accessors

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 _configure

Returns void

Static batchDefaultUniforms

Parameters

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

screenDimensions: number[]

occlusionTexture: any

Static _preRenderBatch

Parameters

Returns void

Static _packInterleavedGeometry

Parameters

Returns void

Static initializeBatchGeometry

Returns void

Static createPlugin

`Static` classPluginName

`Static` batchGeometry

`Static` batchVertexSize

`Static` reservedTextureUnits

`Static` defaultUniforms

`Static` pausable

`Static` CONTRAST

`Static` SATURATION

`Static` EXPOSURE

`Static` batchRendererClass

`Static` batchShaderGeneratorClass

`Static` `Protected` _batchVertexShader

`Static` `Protected` _batchFragmentShader

`Static` `Protected` _vertexShader

`Static` `Protected` _fragmentShader

`Static` `Private` #OCCLUSION

`Static` batchVertexShader

`Static` batchFragmentShader

`Static` vertexShader

`Static` fragmentShader

`Static` ADJUSTMENTS

`Protected` _configure

`Static` batchDefaultUniforms

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

`Static` _preRenderBatch

`Static` _packInterleavedGeometry

`Static` initializeBatchGeometry

`Static` createPlugin

`Static` registerPlugin

`Static` create