Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add missing pages for ImageUtils and PMREMGenerator. #18480

Merged
merged 1 commit into from
Jan 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/api/en/extras/ImageUtils.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">
A class containing utility functions for images.
</p>

<h2>Methods</h2>

<h3>[method:String getDataURL]( [param:HTMLCanvasElement image] | [param:HTMLImageElement image] | [param:ImageBitmap image] )</h3>
<p>
image -- The image object.<br /><br />

Returns a data URI containing a representation of the given image.
</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
80 changes: 80 additions & 0 deletions docs/api/en/extras/PMREMGenerator.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">
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.
</p>

<h2>Constructor</h2>

<h3>[name]( [param:WebGLRenderer renderer] )</h3>
<p>
This constructor creates a new [name].
</p>

<h2>Methods</h2>

<h3>[method:WebGLRenderTarget fromScene]( [param:Scene scene], [param:Number sigma], [param:Number near], [param:Number far] )</h3>
<p>
[page:Scene scene] - The given scene.<br>
[page:Number sigma] - (optional) Specifies a blur radius in radians to be applied to the scene before PMREM generation. Default is *0*.<br>
[page:Number near] - (optional) The near plane value. Default is *0.1*.<br>
[page:Number far] - (optional) The far plane value. Default is *100*.<br /><br />

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).
</p>

<h3>[method:WebGLRenderTarget fromEquirectangular]( [param:Texture equirectangular] )</h3>
<p>
[page:Texture equirectangular] - The equirectangular texture.<br /><br />

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.
</p>

<h3>[method:WebGLRenderTarget fromCubemap]( [param:CubeTexture cubemap] )</h3>
<p>
[page:CubeTexture cubemap] - The cubemap texture.<br /><br />

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.
</p>

<h3>[method:void compileCubemapShader]()</h3>
<p>
Pre-compiles the cubemap shader. You can get faster start-up by invoking this method during your texture's network fetch for increased concurrency.
</p>

<h3>[method:void compileEquirectangularShader]()</h3>
<p>
Pre-compiles the equirectangular shader. You can get faster start-up by invoking this method during your texture's network fetch for increased concurrency.
</p>

<h3>[method:void dispose]()</h3>
<p>
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.
</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
32 changes: 32 additions & 0 deletions docs/api/zh/extras/ImageUtils.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">
A class containing utility functions for images.
</p>

<h2>Methods</h2>

<h3>[method:String getDataURL]( [param:HTMLCanvasElement image] | [param:HTMLImageElement image] | [param:ImageBitmap image] )</h3>
<p>
image -- The image object.<br /><br />

Returns a data URI containing a representation of the given image.
</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
80 changes: 80 additions & 0 deletions docs/api/zh/extras/PMREMGenerator.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">
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.
</p>

<h2>Constructor</h2>

<h3>[name]( [param:WebGLRenderer renderer] )</h3>
<p>
This constructor creates a new [name].
</p>

<h2>Methods</h2>

<h3>[method:WebGLRenderTarget fromScene]( [param:Scene scene], [param:Number sigma], [param:Number near], [param:Number far] )</h3>
<p>
[page:Scene scene] - The given scene.<br>
[page:Number sigma] - (optional) Specifies a blur radius in radians to be applied to the scene before PMREM generation. Default is *0*.<br>
[page:Number near] - (optional) The near plane value. Default is *0.1*.<br>
[page:Number far] - (optional) The far plane value. Default is *100*.<br /><br />

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).
</p>

<h3>[method:WebGLRenderTarget fromEquirectangular]( [param:Texture equirectangular] )</h3>
<p>
[page:Texture equirectangular] - The equirectangular texture.<br /><br />

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.
</p>

<h3>[method:WebGLRenderTarget fromCubemap]( [param:CubeTexture cubemap] )</h3>
<p>
[page:CubeTexture cubemap] - The cubemap texture.<br /><br />

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.
</p>

<h3>[method:void compileCubemapShader]()</h3>
<p>
Pre-compiles the cubemap shader. You can get faster start-up by invoking this method during your texture's network fetch for increased concurrency.
</p>

<h3>[method:void compileEquirectangularShader]()</h3>
<p>
Pre-compiles the equirectangular shader. You can get faster start-up by invoking this method during your texture's network fetch for increased concurrency.
</p>

<h3>[method:void dispose]()</h3>
<p>
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.
</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
6 changes: 5 additions & 1 deletion docs/list.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,9 @@ var list = {

"Extras": {
"Earcut": "api/en/extras/Earcut",
"ShapeUtils": "api/en/extras/ShapeUtils"
"ImageUtils": "api/en/extras/ImageUtils",
"PMREMGenerator": "api/en/extras/PMREMGenerator",
"ShapeUtils": "api/en/extras/ShapeUtils",
},

"Extras / Core": {
Expand Down Expand Up @@ -561,6 +563,8 @@ var list = {

"附件": {
"Earcut": "api/zh/extras/Earcut",
"ImageUtils": "api/zh/extras/ImageUtils",
"PMREMGenerator": "api/zh/extras/PMREMGenerator",
"ShapeUtils": "api/zh/extras/ShapeUtils"
},

Expand Down