PMREMGenerator

This class generates a Prefiltered, Mipmapped Radiance Environment Map (PMREM) from a cubeMap environment texture. This allows different levels of blur to be quickly accessed based on material roughness. It is packed into a special CubeUV format that allows us to perform custom interpolation so that we can support nonlinear formats such as RGBE. Unlike a traditional mipmap chain, it only goes down to the LOD_MIN level (above), and then creates extra even more filtered 'mips' at the same LOD_MIN resolution, associated with higher roughness levels. In this way we maintain resolution to smoothly interpolate diffuse lighting while limiting sampling computation.

Constructor

PMREMGenerator(renderer : WebGLRenderer)

This constructor creates a new PMREMGenerator.

Methods

.fromScene (scene : Scene, sigma : Number, near : Number, far : Number) : WebGLRenderTarget

scene - The given scene.
sigma - (optional) Specifies a blur radius in radians to be applied to the scene before PMREM generation. Default is 0.
near - (optional) The near plane value. Default is 0.1.
far - (optional) The far plane value. Default is 100.

Generates a PMREM from a supplied Scene, which can be faster than using an image if networking bandwidth is low. Optional near and far planes ensure the scene is rendered in its entirety (the cubeCamera is placed at the origin).

.fromEquirectangular (equirectangular : Texture) : WebGLRenderTarget

equirectangular - The equirectangular texture.

Generates a PMREM from an equirectangular texture, which can be either LDR (RGBFormat) or HDR (RGBEFormat). The ideal input image size is 1k (1024 x 512), as this matches best with the 256 x 256 cubemap output.

.fromCubemap (cubemap : CubeTexture) : WebGLRenderTarget

cubemap - The cubemap texture.

Generates a PMREM from an cubemap texture, which can be either LDR (RGBFormat) or HDR (RGBEFormat). The ideal input cube size is 256 x 256, as this matches best with the 256 x 256 cubemap output.

.compileCubemapShader () : void

Pre-compiles the cubemap shader. You can get faster start-up by invoking this method during your texture's network fetch for increased concurrency.

.compileEquirectangularShader () : void

Pre-compiles the equirectangular shader. You can get faster start-up by invoking this method during your texture's network fetch for increased concurrency.

.dispose () : void

Disposes of the PMREMGenerator's internal memory. Note that PMREMGenerator is a static class, so you should not need more than one PMREMGenerator object. If you do, calling dispose() on one of them will cause any others to also become unusable.

Source

For more info on how to obtain the source code of this module see this page.