Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    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)

    Index

    Properties

    initialUniforms batchDefaultUniforms batchGeometry batchRendererClass batchShaderGeneratorClass batchVertexSize classPluginName CONTRAST EXPOSURE pausable reservedTextureUnits SATURATION _packInterleavedGeometry _preRenderBatch

    Accessors

    enabled paused pluginName ADJUSTMENTS batchFragmentShader batchVertexShader defaultUniforms

    Methods

    _preRender reset _createFragmentShader _createVertexShader create createPlugin initializeBatchGeometry registerPlugin

    Properties

    initialUniforms: object

    The initial values of the shader uniforms.

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

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

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

    Batch geometry associated with this sampler.

    batchRendererClass: typeof BatchRenderer = BatchRenderer

    The batch renderer to use.

    batchShaderGeneratorClass: typeof BatchShaderGenerator = BatchShaderGenerator

    The batch generator to use.

    batchVertexSize: number = 6

    The size of a vertex with all its packed attributes.

    classPluginName: string | null = "batch"

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

    CONTRAST: string = ...

    Contrast adjustment

    EXPOSURE: string = ...

    Exposure adjustment.

    pausable: boolean = true

    Is this shader pausable or not?

    reservedTextureUnits: number = 0

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

    SATURATION: string = ...

    Saturation adjustment

    Protected Static_packInterleavedGeometry

    _packInterleavedGeometry: Function | undefined

    Pack interleaved geometry custom function.

    Protected Static_preRenderBatch

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

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

    Accessors

    • 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

    • 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

    • get pluginName(): string | null

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

      Returns string | null

    • get ADJUSTMENTS(): string

      The adjustments made into fragment shaders.

      Returns string

    • get batchFragmentShader(): string

      The batch fragment shader source.

      Returns string

    • get batchVertexShader(): string

      The batch vertex shader source.

      Returns string

    • get defaultUniforms(): { sampler: number; tintAlpha: number[] }

      Returns { sampler: number; tintAlpha: number[] }

    Methods

    _preRender

    • Reset the shader uniforms back to their initial values.

      Returns void

    Static_createFragmentShader

    • _createFragmentShader(): string

      Returns string

    Static_createVertexShader

    • _createVertexShader(): string

      Returns string

    • Create a batch plugin for this sampler class.

      Returns any

      The batch plugin class linked to this sampler class.

    • Initialize the batch geometry with custom properties.

      Returns 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