Class BaseSamplerShader

The base sampler shader exposes a simple sprite shader and all the framework to handle:

  • Batched shaders and plugin subscription
  • Configure method (for special processing done once or punctually)
  • Update method (pre-binding, normally done each frame) All other sampler shaders (batched or not) should extend BaseSamplerShader

Hierarchy (View Summary)

Properties

initialUniforms batchDefaultUniforms batchFragmentShader batchGeometry batchRendererClass batchShaderGeneratorClass batchVertexShader batchVertexSize classPluginName CONTRAST defaultUniforms EXPOSURE fragmentShader pausable reservedTextureUnits SATURATION vertexShader _packInterleavedGeometry _preRenderBatch

Accessors

enabled paused pluginName ADJUSTMENTS

Methods

_preRender reset _configure create createPlugin initializeBatchGeometry registerPlugin

Properties

initialUniforms

initialUniforms: object

The initial values of the shader uniforms.

StaticbatchDefaultUniforms

batchDefaultUniforms: object | (maxTextures: number) => object = {}

Returns default uniforms associated with the batched version of this sampler.

StaticbatchFragmentShader

batchFragmentShader: string = ...

The batch fragment shader source.

StaticbatchGeometry

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

Batch geometry associated with this sampler.

StaticbatchRendererClass

batchRendererClass: typeof BatchRenderer = BatchRenderer

The batch renderer to use.

StaticbatchShaderGeneratorClass

batchShaderGeneratorClass: typeof BatchShaderGenerator = BatchShaderGenerator

The batch generator to use.

StaticbatchVertexShader

batchVertexShader: string = ...

The batch vertex shader source.

StaticbatchVertexSize

batchVertexSize: number = 6

The size of a vertex with all its packed attributes.

StaticclassPluginName

classPluginName: null | string = "batch"

The named batch sampler plugin that is used by this shader, or null if no batching is used.

StaticCONTRAST

CONTRAST: string = ...

Contrast adjustment

StaticdefaultUniforms

defaultUniforms: { sampler: number; tintAlpha: number[] } = ...

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

StaticEXPOSURE

EXPOSURE: string = ...

Exposure adjustment.

StaticfragmentShader

fragmentShader: string = ...

Staticpausable

pausable: boolean = true

Is this shader pausable or not?

StaticreservedTextureUnits

reservedTextureUnits: number = 0

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

StaticSATURATION

SATURATION: string = ...

Saturation adjustment

StaticvertexShader

vertexShader: string = ...

Protected Static_packInterleavedGeometry

_packInterleavedGeometry: undefined | Function

Pack interleaved geometry custom function.

Protected Static_preRenderBatch

_preRenderBatch: (batchRenderer: BatchRenderer) => undefined | void

A prerender function happening just before the batch renderer is flushed.

Accessors

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

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

pluginName

  • get pluginName(): null | string

    The plugin name associated for this instance, if any. Returns "batch" if the shader is disabled.

    Returns null | string

StaticADJUSTMENTS

  • get ADJUSTMENTS(): string

    The adjustments made into fragment shaders.

    Returns string

Methods

_preRender

reset

  • reset(): void

    Reset the shader uniforms back to their initial values.

    Returns void

Protected_configure

Staticcreate

StaticcreatePlugin

  • createPlugin(): any

    Create a batch plugin for this sampler class.

    Returns any

    The batch plugin class linked to this sampler class.

StaticinitializeBatchGeometry

  • initializeBatchGeometry(): void

    Initialize the batch geometry with custom properties.

    Returns void

StaticregisterPlugin

  • 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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods