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

    Class BatchRenderer

    A batch renderer with a customizable data transfer function to packed geometries.

    Hierarchy

    • BatchRenderer
      • BatchRenderer
    Index

    Properties

    _packInterleavedGeometry _preRenderBatch defaultUniforms shaderGeneratorClass

    Accessors

    uniforms reservedTextureUnits

    Methods

    contextChange onPrerender packInterleavedGeometry setShaderGenerator start hasPlugin

    Properties

    Protected_packInterleavedGeometry

    _packInterleavedGeometry: Function | undefined

    The PackInterleavedGeometry function provided by the sampler.

    Protected_preRenderBatch

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

    The update function provided by the sampler and that is called just before a flush.

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

    The default uniform values for the batch shader.

    shaderGeneratorClass: typeof BatchShaderGenerator = BatchShaderGenerator

    The batch shader generator class.

    Accessors

    • get uniforms(): object | undefined

      Get the uniforms bound to this abstract batch renderer.

      Returns object | undefined

    • get reservedTextureUnits(): number

      Number of reserved texture units reserved by the batch shader that cannot be used by the batch renderer.

      Returns number

    • set reservedTextureUnits(val: number): void
      Protected

      The number of reserved texture units that the shader generator should not use (maximum 4).

      Parameters

      • val: number

      Returns void

    Methods

    • This override allows to allocate a given number of texture units reserved for a custom batched shader. These reserved texture units won't be used to batch textures for PIXI.Sprite or SpriteMesh.

      Returns void

    • Returns void

    • Parameters

      • element: any
      • attributeBuffer: any
      • indexBuffer: any
      • aIndex: any
      • iIndex: any

      Returns void

    • Parameters

      • __namedParameters: { fragment?: any; uniforms?: any; vertex?: any } = {}

      Returns void

    • Returns void

    • Verify if a PIXI plugin exists. Check by name.

      Parameters

      • name: string

        The name of the pixi plugin to check.

      Returns boolean

      True if the plugin exists, false otherwise.

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods