Skip to content

Commit b2f1c92

Browse files
authored
Docs: Document minimum texture sizes of PMREMGenerator. (#33465)
1 parent 3a45a86 commit b2f1c92

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

src/extras/PMREMGenerator.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ class PMREMGenerator {
142142

143143
/**
144144
* Generates a PMREM from an equirectangular texture, which can be either LDR
145-
* or HDR. The ideal input image size is 1k (1024 x 512),
146-
* as this matches best with the 256 x 256 cubemap output.
145+
* or HDR. The ideal input image size is 1k (1024 x 512), as this matches best
146+
* with the 256 x 256 cubemap output. The minimum supported resolution is 64 x 32.
147147
*
148148
* @param {Texture} equirectangular - The equirectangular texture to be converted.
149149
* @param {?WebGLRenderTarget} [renderTarget=null] - The render target to use.
@@ -157,8 +157,9 @@ class PMREMGenerator {
157157

158158
/**
159159
* Generates a PMREM from an cubemap texture, which can be either LDR
160-
* or HDR. The ideal input cube size is 256 x 256,
161-
* as this matches best with the 256 x 256 cubemap output.
160+
* or HDR. The ideal input cube size is 256 x 256, as this matches best
161+
* with the 256 x 256 cubemap output. The minimum supported resolution is
162+
* 16 x 16 per face.
162163
*
163164
* @param {Texture} cubemap - The cubemap texture to be converted.
164165
* @param {?WebGLRenderTarget} [renderTarget=null] - The render target to use.

src/renderers/common/extras/PMREMGenerator.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ class PMREMGenerator {
214214

215215
/**
216216
* Generates a PMREM from an equirectangular texture, which can be either LDR
217-
* or HDR. The ideal input image size is 1k (1024 x 512),
218-
* as this matches best with the 256 x 256 cubemap output.
217+
* or HDR. The ideal input image size is 1k (1024 x 512), as this matches best
218+
* with the 256 x 256 cubemap output. The minimum supported resolution is 64 x 32.
219219
*
220220
* @param {Texture} equirectangular - The equirectangular texture to be converted.
221221
* @param {?RenderTarget} [renderTarget=null] - The render target to use.
@@ -265,8 +265,9 @@ class PMREMGenerator {
265265

266266
/**
267267
* Generates a PMREM from an cubemap texture, which can be either LDR
268-
* or HDR. The ideal input cube size is 256 x 256,
269-
* as this matches best with the 256 x 256 cubemap output.
268+
* or HDR. The ideal input cube size is 256 x 256, as this matches best
269+
* with the 256 x 256 cubemap output. The minimum supported resolution is
270+
* 16 x 16 per face.
270271
*
271272
* @param {Texture} cubemap - The cubemap texture to be converted.
272273
* @param {?RenderTarget} [renderTarget=null] - The render target to use.

0 commit comments

Comments
 (0)