WebGLCubeRenderTarget.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>WebGLCubeRenderTarget - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="RenderTarget.html">RenderTarget</a> → <a href="WebGLRenderTarget.html">WebGLRenderTarget</a> → </p>
  13. <h1 translate="no">WebGLCubeRenderTarget</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A cube render target used in context of <a href="WebGLRenderer.html">WebGLRenderer</a>.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="WebGLCubeRenderTarget" translate="no">new <a href="#WebGLCubeRenderTarget">WebGLCubeRenderTarget</a><span class="signature">( size : <span class="param-type">number</span>, options : <span class="param-type">RenderTarget~Options</span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new cube render target.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name"><code>size</code></td>
  30. <td class="description last"><p>The size of the render target.<br/>Default is <code>1</code>.</p></td>
  31. </tr>
  32. <tr>
  33. <td class="name"><code>options</code></td>
  34. <td class="description last"><p>The configuration object.</p></td>
  35. </tr>
  36. </tbody>
  37. </table>
  38. </div>
  39. </div>
  40. <h2 class="subsection-title">Properties</h2>
  41. <div class="member">
  42. <h3 class="name" id="isWebGLCubeRenderTarget" translate="no">.<a href="#isWebGLCubeRenderTarget">isWebGLCubeRenderTarget</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  43. <div class="description">
  44. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  45. </div>
  46. </div>
  47. <div class="member">
  48. <h3 class="name" id="texture" translate="no">.<a href="#texture">texture</a><span class="type-signature"> : <a href="DataArrayTexture.html">DataArrayTexture</a></span> </h3>
  49. <div class="description">
  50. <p>Overwritten with a different texture type.</p>
  51. </div>
  52. <dl class="details">
  53. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="WebGLRenderTarget.html#texture">WebGLRenderTarget#texture</a></dt>
  54. </dl>
  55. </div>
  56. <h2 class="subsection-title">Methods</h2>
  57. <h3 class="name name-method" id="clear" translate="no">.<a href="#clear">clear</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span>, color : <span class="param-type">boolean</span>, depth : <span class="param-type">boolean</span>, stencil : <span class="param-type">boolean</span> )</span> </h3>
  58. <div class="method">
  59. <div class="description">
  60. <p>Clears this cube render target.</p>
  61. </div>
  62. <table class="params">
  63. <tbody>
  64. <tr>
  65. <td class="name"><code>renderer</code></td>
  66. <td class="description last"><p>The renderer.</p></td>
  67. </tr>
  68. <tr>
  69. <td class="name"><code>color</code></td>
  70. <td class="description last"><p>Whether the color buffer should be cleared or not.<br/>Default is <code>true</code>.</p></td>
  71. </tr>
  72. <tr>
  73. <td class="name"><code>depth</code></td>
  74. <td class="description last"><p>Whether the depth buffer should be cleared or not.<br/>Default is <code>true</code>.</p></td>
  75. </tr>
  76. <tr>
  77. <td class="name"><code>stencil</code></td>
  78. <td class="description last"><p>Whether the stencil buffer should be cleared or not.<br/>Default is <code>true</code>.</p></td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. </div>
  83. <h3 class="name name-method" id="fromEquirectangularTexture" translate="no">.<a href="#fromEquirectangularTexture">fromEquirectangularTexture</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span>, texture : <span class="param-type">Texture</span> )</span><span class="type-signature"> : <a href="WebGLCubeRenderTarget.html">WebGLCubeRenderTarget</a></span> </h3>
  84. <div class="method">
  85. <div class="description">
  86. <p>Converts the given equirectangular texture to a cube map.</p>
  87. </div>
  88. <table class="params">
  89. <tbody>
  90. <tr>
  91. <td class="name"><code>renderer</code></td>
  92. <td class="description last"><p>The renderer.</p></td>
  93. </tr>
  94. <tr>
  95. <td class="name"><code>texture</code></td>
  96. <td class="description last"><p>The equirectangular texture.</p></td>
  97. </tr>
  98. </tbody>
  99. </table>
  100. <dl class="details">
  101. <dt class="tag-returns"><strong>Returns:</strong> A reference to this cube render target.</dt>
  102. </dl>
  103. </div>
  104. <h2 class="subsection-title">Source</h2>
  105. <p>
  106. <a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/WebGLCubeRenderTarget.js" target="_blank" rel="noopener" translate="no">src/renderers/WebGLCubeRenderTarget.js</a>
  107. </p>
  108. </article>
  109. </section>
  110. <script src="../scripts/linenumber.js"></script>
  111. <script src="../scripts/page.js"></script>
  112. </body>
  113. </html>
粤ICP备19079148号