Class TextureCache

A caching texture manager It is instantiated with a WebGL context and then used to load and cache textures

Accessors

defaultRand defaultWhite instance size

Methods

add get getCreate clear init

Accessors

StaticdefaultRand

  • get defaultRand(): WebGLTexture

  • Return the default random RGB texture

    Returns WebGLTexture

StaticdefaultWhite

  • get defaultWhite(): WebGLTexture

  • Return the default white 1x1 texture

    Returns WebGLTexture

Staticinstance

Staticsize

  • get size(): number

  • Return the number of textures in the cache

    Returns number

Methods

add

  • add(key: string, texture: WebGLTexture): void

  • Add a texture to the cache

    Parameters

    • key: string

      Key of texture, this is usually the URL or filename path

    • texture: WebGLTexture

      WebGL texture

    Returns void

get

  • get(key: string): undefined | WebGLTexture

  • Return a texture from the cache by name

    Parameters

    • key: string

      Key of texture, this is usually the URL or filename path

    Returns undefined | WebGLTexture

getCreate

  • getCreate(
        src: string | ArrayBufferView<ArrayBufferLike>,
        filter?: boolean,
        flipY?: boolean,
        textureKey?: string,
        extraOptions?: TextureOptions,
    ): undefined | WebGLTexture

  • Create or return a texture from the cache by name

    Parameters

    • src: string | ArrayBufferView<ArrayBufferLike>

      URL or filename path of texture image, or ArrayBufferView holding texture

    • filter: boolean = true

      Enable texture filtering and mipmaps (default true)

    • flipY: boolean = false

      Flip the texture vertically (default true)

    • textureKey: string = ''

      Unique key, only used for ArrayBuffer textures

    • extraOptions: TextureOptions = {}

      Extra options to pass to twgl.createTexture, see https://twgljs.org/docs/module-twgl.html#.TextureOptions

    Returns undefined | WebGLTexture

Staticclear

Staticinit

  • init(gl: WebGL2RenderingContext, randSize?: number): void

  • Parameters

    • gl: WebGL2RenderingContext
    • randSize: number = 512

    Returns void

Settings

Member Visibility

On This Page

Accessors
Methods