Options
All
  • Public
  • Public/Protected
  • All
Menu

A shader used to control channels intensity using an externally provided mask texture.

Hierarchy

Index

Constructors

Methods

  • _preRender(mesh: any): void
  • initializeBatchGeometry(): void
  • createPlugin(): any
  • Create a batch plugin for this sampler class.

    Returns any

    The batch plugin class linked to this sampler class.

  • registerPlugin(): void
  • _preRenderBatch(): void

Properties

pluginName: string

The plugin name associated for this instance.

_defaults: any

The initial default values of shader uniforms

#enabled: boolean = true
classPluginName: any = null
override
vertexShader: string = ...

The raw vertex shader used by this class. A subclass of AbstractBaseShader must implement the vertexShader static field.

fragmentShader: string = ...

The raw fragment shader used by this class. A subclass of AbstractBaseShader must implement the fragmentShader static field.

defaultUniforms: { roof: boolean; vision: boolean; tintAlpha: number[]; depthElevation: number; sampler: number; maskSampler: number; alpha: number; alphaOcclusion: number; screenDimensions: number[] } = ...

The default uniform values for the shader. A subclass of AbstractBaseShader must implement the defaultUniforms static field.

Type declaration

  • roof: boolean
  • vision: boolean
  • tintAlpha: number[]
  • depthElevation: number
  • sampler: number
  • maskSampler: number
  • alpha: number
  • alphaOcclusion: number
  • screenDimensions: number[]
CONTRAST: string = ...

Contrast adjustment

SATURATION: string = ...

Saturation adjustment

EXPOSURE: string = ...

Exposure adjustment.

batchVertexShader: string = ...

Batch default vertex

batchFragmentShader: string = ...

Batch default fragment

batchGeometry: any = PIXI.BatchGeometry

Batch geometry associated with this sampler.

batchVertexSize: number = 6

The size of a vertice with all its packed attributes.

batchDefaultUniforms: Function

A function that returns default uniforms associated with the batched version of this sampler.

abstract
reservedTextureUnits: number = 0

The number of reserved texture units for this shader that cannot be used by the batch renderer.

batchRendererClass: typeof BatchRenderer = BatchRenderer

The batch renderer to use.

batchShaderGeneratorClass: typeof BatchShaderGenerator = BatchShaderGenerator

The batch generator to use.

_packInterleavedGeometry: Function

Pack interleaved geometry custom function.

Accessors

  • get enabled(): boolean
  • set enabled(enabled: boolean): void
  • 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

  • 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)

    Parameters

    • enabled: boolean

    Returns void

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

    Returns string