WebGLCubeRenderTarget.html 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:WebGLRenderTarget] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Used by the [page:CubeCamera] as its [page:WebGLRenderTarget].
  14. </p>
  15. <h2>Examples</h2>
  16. <p>See [page:CubeCamera] for examples.</p>
  17. <h2>Constructor</h2>
  18. <h3>[name]([param:Number size], [param:Object options])</h3>
  19. <p>
  20. [page:Float size] - the size, in pixels. <br />
  21. options - (optional) object that holds texture parameters for an auto-generated target
  22. texture and depthBuffer/stencilBuffer booleans.
  23. For an explanation of the texture parameters see [page:Texture Texture]. The following are
  24. valid options:<br /><br />
  25. [page:Constant wrapS] - default is [page:Textures ClampToEdgeWrapping]. <br />
  26. [page:Constant wrapT] - default is [page:Textures ClampToEdgeWrapping]. <br />
  27. [page:Constant magFilter] - default is [page:Textures .LinearFilter]. <br />
  28. [page:Constant minFilter] - default is [page:Textures LinearFilter]. <br />
  29. [page:Constant format] - default is [page:Textures RGBAFormat]. <br />
  30. [page:Constant type] - default is [page:Textures UnsignedByteType]. <br />
  31. [page:Number anisotropy] - default is *1*. See [page:Texture.anistropy]<br />
  32. [page:Constant encoding] - default is [page:Textures LinearEncoding]. <br />
  33. [page:Boolean depthBuffer] - default is *true*. Set this to false if you don't need it. <br />
  34. [page:Boolean stencilBuffer] - default is *false*. Set this to true if you need it.<br /><br />
  35. Creates a new [name]
  36. </p>
  37. <h2>Properties</h2>
  38. <h3>See [page:WebGLRenderTarget] for inherited properties</h3>
  39. <h2>Methods</h2>
  40. <h3>See [page:WebGLRenderTarget] for inherited methods</h3>
  41. <h3>[method:WebGLCubeRenderTarget fromEquirectangularTexture]( [param:WebGLRenderer renderer], [param:Texture texture] )</h3>
  42. <p>
  43. [page:WebGLRenderer renderer] — the renderer.<br/>
  44. [page:Texture texture] — the equirectangular texture.
  45. </p>
  46. <p>
  47. Use this method if you want to convert an equirectangular panorama to the cubemap format.
  48. </p>
  49. <h3>[method:undefined clear]( [param:WebGLRenderer renderer], [param:Boolean color], [param:Boolean depth], [param:Boolean stencil] )</h3>
  50. <p>
  51. Call this to clear the renderTarget's color, depth, and/or stencil buffers.
  52. The color buffer is set to the renderer's current clear color. Arguments default to *true*.
  53. </p>
  54. <h2>Source</h2>
  55. <p>
  56. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  57. </p>
  58. </body>
  59. </html>