Class RenderTexturePool

constructor

• new RenderTexturePool(
      textureOptions?: IBaseTextureOptions<any>,
  ): RenderTexturePool

• Parameters

  • OptionaltextureOptions: IBaseTextureOptions<any>

    options that will be passed to BaseRenderTexture constructor

    • OptionalalphaMode?: ALPHA_MODES

    • OptionalanisotropicLevel?: number

    • Optionalformat?: FORMATS

    • Optionalheight?: number

    • Optionalmipmap?: MIPMAP_MODES

    • Optionalmultisample?: MSAA_QUALITY

    • OptionalpixiIdPrefix?: string

    • Optionalresolution?: number

    • OptionalresourceOptions?: RO

    • OptionalscaleMode?: SCALE_MODES

    • Optionaltarget?: TARGETS

    • Optionaltype?: TYPES

    • Optionalwidth?: number

    • OptionalwrapMode?: WRAP_MODES

  Returns RenderTexturePool

enableFullScreen

false
Copy

textureOptions

texturePool

Static ReadonlySCREEN_KEY

clear

• clear(destroyTextures?: boolean): void

• Clears the pool.

  Parameters

  • OptionaldestroyTextures: boolean

    Destroy all stored textures.

  Returns void

createTexture

• createTexture(
      realWidth: number,
      realHeight: number,
      multisample?: MSAA_QUALITY,
  ): RenderTexture

• Creates texture with params that were specified in pool constructor.

  Parameters

  • realWidth: number

    Width of texture in pixels.
  • realHeight: number

    Height of texture in pixels.
  • Optionalmultisample: MSAA_QUALITY

    Number of samples of the framebuffer.

  Returns RenderTexture

getFilterTexture

• getFilterTexture(
      input: RenderTexture,
      resolution?: number,
      multisample?: MSAA_QUALITY,
  ): RenderTexture

• Gets extra texture of the same size as input renderTexture

  getFilterTexture(input, 0.5) or getFilterTexture(0.5, input)

  Parameters

  • input: RenderTexture

    renderTexture from which size and resolution will be copied
  • Optionalresolution: number

    override resolution of the renderTexture It overrides, it does not multiply
  • Optionalmultisample: MSAA_QUALITY

    number of samples of the renderTexture

  Returns RenderTexture

getOptimalTexture

• getOptimalTexture(
      minWidth: number,
      minHeight: number,
      resolution?: number,
      multisample?: MSAA_QUALITY,
  ): RenderTexture

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

  Parameters

  • minWidth: number

    The minimum width of the render texture.
  • minHeight: number

    The minimum height of the render texture.
  • Optionalresolution: number

    The resolution of the render texture.
  • Optionalmultisample: MSAA_QUALITY

    Number of samples of the render texture.

  Returns RenderTexture

  The new render texture.

returnFilterTexture

• returnFilterTexture(renderTexture: RenderTexture): void

• Alias for returnTexture, to be compliant with FilterSystem interface.

  Parameters

  • renderTexture: RenderTexture

    The renderTexture to free

  Returns void

returnTexture

• returnTexture(renderTexture: RenderTexture): void

• Place a render texture back into the pool.

  Parameters

  • renderTexture: RenderTexture

    The renderTexture to free

  Returns void

setScreenSize

• setScreenSize(size: ISize): void

• If screen size was changed, drops all screen-sized textures, sets new screen size, sets enableFullScreen to true

  Size is measured in pixels, renderer.view can be passed here, not renderer.screen

  Parameters

  • size: ISize

    Initial size of screen.

  Returns void