Class: RenderTexturePool

PIXI.RenderTexturePool

Texture pool, used by FilterSystem and plugins.

Stores collection of temporary pow2 or screen-sized renderTextures

If you use custom RenderTexturePool for your filters, you can use methods getFilterTexture and returnFilterTexture same as in

new PIXI.RenderTexturePool (textureOptions)

RenderTexturePool.ts:33

Name	Type	Attributes	Description
`textureOptions`	IBaseTextureOptions	<optional>	options that will be passed to BaseRenderTexture constructor
`textureOptions.scaleMode`	PIXI.SCALE_MODES	<optional>	See PIXI.SCALE_MODES for possible values.

Members

PIXI.RenderTexturePool.SCREEN_KEY number staticreadonly

Key that is used to store fullscreen renderTextures in a pool

Default Value:

-1

enableFullScreen boolean

Allow renderTextures of the same size as screen, not just pow2

Automatically sets to true after setScreenSize

Default Value:

false

Methods

clear (destroyTextures) void

RenderTexturePool.ts:154

Clears the pool.

Name	Type	Attributes	Description
`destroyTextures`	boolean	<optional>	Destroy all stored textures.

createTexture (realWidth, realHeight, multisample) PIXI.RenderTexture

RenderTexturePool.ts:47

Creates texture with params that were specified in pool constructor.

Name	Type	Description
`realWidth`	number	Width of texture in pixels.
`realHeight`	number	Height of texture in pixels.
`multisample`		Number of samples of the framebuffer.

Returns:

Type	Description
PIXI.RenderTexture

getFilterTexture (input, resolution, multisample) PIXI.RenderTexture

RenderTexturePool.ts:114

Gets extra texture of the same size as input renderTexture

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

Name	Type	Attributes	Description
`input`	PIXI.RenderTexture		renderTexture from which size and resolution will be copied
`resolution`	number	<optional>	override resolution of the renderTexture It overrides, it does not multiply
`multisample`	PIXI.MSAA_QUALITY	<optional>	number of samples of the renderTexture

Returns:

Type	Description
PIXI.RenderTexture

getOptimalTexture (minWidth, minHeight, resolution, multisample) PIXI.RenderTexture

RenderTexturePool.ts:65

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

Name	Type	Default	Description
`minWidth`	number		The minimum width of the render texture.
`minHeight`	number		The minimum height of the render texture.
`resolution`	number	1	The resolution of the render texture.
`multisample`			Number of samples of the render texture.

Returns:

Type	Description
PIXI.RenderTexture	The new render texture.

returnFilterTexture (renderTexture) void

RenderTexturePool.ts:145

Alias for returnTexture, to be compliant with FilterSystem interface.

Name	Type	Description
`renderTexture`	PIXI.RenderTexture	The renderTexture to free

returnTexture (renderTexture) void

RenderTexturePool.ts:133

Place a render texture back into the pool.

Name	Type	Description
`renderTexture`	PIXI.RenderTexture	The renderTexture to free

setScreenSize (size) void

RenderTexturePool.ts:180

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

Name	Type	Description
`size`	PIXI.ISize	Initial size of screen.