Class TexturePoolClassAdvanced

constructor

• new TexturePoolClass(textureOptions?: TextureSourceOptions): TexturePoolClass

  Parameters

  • OptionaltextureOptions: TextureSourceOptions

    options that will be passed to BaseRenderTexture constructor

    options for creating a new TextureSource

    • Optional_resourceId?: number

    • OptionaladdressMode?: WRAP_MODE

      setting this will set wrapModeU,wrapModeV and wrapModeW all at once!

    • OptionaladdressModeU?: WRAP_MODE

      specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

    • OptionaladdressModeV?: WRAP_MODE

      specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

    • OptionaladdressModeW?: WRAP_MODE

      Specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

    • OptionalalphaMode?: ALPHA_MODES

      the alpha mode of the texture

    • Optionalantialias?: boolean

      Only really affects RenderTextures. Should we use antialiasing for this texture. It will look better, but may impact performance as a Blit operation will be required to resolve the texture.

    • Optional AdvancedarrayLayerCount?: number

      The number of array layers for this texture source.

      This maps to WebGPU's GPUTextureDescriptor.size.depthOrArrayLayers and is used for array-backed textures such as cube maps (6 layers).

      Default

      1
      @advanced
      Copy

    • OptionalautoGarbageCollect?: boolean

      If true, the Garbage Collector will unload this texture if it is not used after a period of time

    • OptionalautoGenerateMipmaps?: boolean

      Should we auto generate mipmaps for this texture? This will automatically generate mipmaps for this texture when uploading to the GPU. Mipmapped textures take up more memory, but can look better when scaled down.

      For performance reasons, it is recommended to NOT use this with RenderTextures, as they are often updated every frame. If you do, make sure to call updateMipmaps after you update the texture.

    • Optionalcompare?: COMPARE_FUNCTION

      When provided the sampler will be a comparison sampler with the specified COMPARE_FUNCTION. Note: Comparison samplers may use filtering, but the sampling results will be implementation-dependent and may differ from the normal filtering rules.

    • Optional Readonlydestroyed?: boolean

      Has the style been destroyed?

    • Optionaldimensions?: TEXTURE_DIMENSIONS

      how many dimensions does this texture have? currently v8 only supports 2d

    • Optionaldynamic?: boolean

      Used by RenderTexture.create to allow resizing. Not used by TextureSource itself.

    • Optionalformat?: TEXTURE_FORMATS

      the format that the texture data has

    • Optionalheight?: number

      the pixel height of this texture source. This is the REAL pure number, not accounting resolution

    • Optionallabel?: string

      optional label, can be used for debugging

    • OptionallodMaxClamp?: number

      Specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

    • OptionallodMinClamp?: number

      specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

    • OptionalmagFilter?: SCALE_MODE

      specifies the sampling behavior when the sample footprint is smaller than or equal to one texel.

    • OptionalmaxAnisotropy?: number

      Specifies the maximum anisotropy value clamp used by the sampler. Note: Most implementations support TextureStyle#maxAnisotropy values in range between 1 and 16, inclusive. The used value of TextureStyle#maxAnisotropy will be clamped to the maximum value that the platform supports.

      setting this to anything higher than 1 will set scale modes to 'linear'

    • OptionalminFilter?: SCALE_MODE

      specifies the sampling behavior when the sample footprint is larger than one texel.

    • OptionalmipLevelCount?: number

      The number of mip levels to generate for this texture. this is overridden if autoGenerateMipmaps is true

    • OptionalmipmapFilter?: SCALE_MODE

      specifies behavior for sampling between mipmap levels.

    • Optionalresolution?: number

      the resolution of the texture.

    • Optionalresource?: T

      the resource that will be uploaded to the GPU. This is where we get our pixels from eg an ImageBimt / Canvas / Video etc

    • OptionalscaleMode?: SCALE_MODE

      setting this will set magFilter,minFilter and mipmapFilter all at once!

    • OptionalviewDimension?: TEXTURE_VIEW_DIMENSIONS

      How this texture is viewed/sampled by shaders.

      This aligns with WebGPU's GPUTextureViewDescriptor.dimension. For example, cube maps are typically stored as a 2D texture with 6 array layers (dimensions: '2d') but viewed as viewDimension: 'cube'.

    • Optionalwidth?: number

      the pixel width of this texture source. This is the REAL pure number, not accounting resolution

    • OptionalwrapMode?: WRAP_MODE

    • destroy?: function

      • destroy?(): void

        Destroys the style

        Returns void

    • update?: function

      • update?(): void

        Returns void

  Returns TexturePoolClass

enableFullScreen

false
Copy

textureOptions

textureStyle

clear

• clear(destroyTextures?: boolean): void

  Clears the pool.

  Parameters

  • OptionaldestroyTextures: boolean

    Destroy all stored textures.

  Returns void

createTexture

• createTexture(
      pixelWidth: number,
      pixelHeight: number,
      antialias: boolean,
      autoGenerateMipmaps: boolean,
  ): Texture

  Creates texture with params that were specified in pool constructor.

  Parameters

  • pixelWidth: number

    Width of texture in pixels.

  • pixelHeight: number

    Height of texture in pixels.

  • antialias: boolean
  • autoGenerateMipmaps: boolean

    Whether to automatically generate mipmaps for this texture

  Returns Texture

getOptimalTexture

• getOptimalTexture(
      frameWidth: number,
      frameHeight: number,
      resolution?: number,
      antialias: boolean,
      autoGenerateMipmaps?: boolean,
  ): Texture

  Gets a Power-of-Two render texture or fullScreen texture

  Parameters

  • frameWidth: number

    The minimum width of the render texture.

  • frameHeight: number

    The minimum height of the render texture.

  • resolution: number = 1

    The resolution of the render texture.

  • antialias: boolean
  • autoGenerateMipmaps: boolean = false

    Whether to automatically generate mipmaps. Defaults to false.

  Returns Texture

  The new render texture.

getSameSizeTexture

• getSameSizeTexture(
      texture: Texture,
      antialias?: boolean,
  ): Texture<TextureSource<any>>

  Gets a pooled texture matching the dimensions and resolution of the given texture.

  This is a convenience wrapper around getOptimalTexture that copies width, height, and resolution from an existing texture. Useful when a filter needs a temporary texture the same size as its input (e.g., for multi-pass blur).

  Parameters

  • texture: Texture

    The texture whose dimensions to match.

  • antialias: boolean = false

    Whether to use antialias on the pooled texture. Defaults to false.

  Returns Texture<TextureSource<any>>

  A pooled texture with power-of-two backing dimensions at the source resolution.

returnTexture

• returnTexture(renderTexture: Texture, resetStyle?: boolean): void

  Returns a texture to the pool so it can be reused by future getOptimalTexture or getSameSizeTexture calls.

  If you modified the texture's style after obtaining it (e.g., changed filtering or wrapping), pass resetStyle = true to restore the pool's default textureStyle. This prevents style changes from leaking into subsequent consumers of the same pooled texture.

  Parameters

  • renderTexture: Texture

    The texture to return to the pool.

  • resetStyle: boolean = false

    When true, replaces the texture source's style with the pool default. Defaults to false.

  Returns void