Skip to content

Commit

Permalink
PMREMGenerator: Clarify image size limitations (#837)
Browse files Browse the repository at this point in the history
  • Loading branch information
Methuselah96 authored Feb 23, 2024
1 parent 0086896 commit 0f3994c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions types/three/src/extras/PMREMGenerator.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,15 @@ export class PMREMGenerator {
fromScene(scene: Scene, sigma?: number, near?: number, far?: number): WebGLRenderTarget;

/**
* Generates a PMREM from an equirectangular texture.
* @param equirectangular The equirectangular texture.
* Generates a PMREM from an equirectangular texture, which can be either LDR or HDR. The ideal input image size is
* 1k (1024 x 512), as this matches best with the 256 x 256 cubemap output. The smallest supported equirectangular
* image size is 64 x 32.
*/
fromEquirectangular(equirectangular: Texture, renderTarget?: WebGLRenderTarget | null): WebGLRenderTarget;

/**
* Generates a PMREM from an cubemap texture.
* @param cubemap The cubemap texture.
* Generates a PMREM from an cubemap texture, which can be either LDR or HDR. The ideal input cube size is
* 256 x 256, as this matches best with the 256 x 256 cubemap output. The smallest supported cube size is 16 x 16.
*/
fromCubemap(cubemap: CubeTexture, renderTarget?: WebGLRenderTarget | null): WebGLRenderTarget;

Expand Down

0 comments on commit 0f3994c

Please sign in to comment.