QuadMesh.html 4.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>QuadMesh - 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="Object3D.html">Object3D</a> → <a href="Mesh.html">Mesh</a> → </p>
  13. <h1 translate="no">QuadMesh</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>This module is a helper for passes which need to render a full
  17. screen effect which is quite common in context of post processing.</p>
  18. <p>The intended usage is to reuse a single quad mesh for rendering
  19. subsequent passes by just reassigning the <code>material</code> reference.</p>
  20. <p>Note: This module can only be used with <code>WebGPURenderer</code>.</p></div>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <h2>Constructor</h2>
  25. <h3 class="name name-method" id="QuadMesh" translate="no">new <a href="#QuadMesh">QuadMesh</a><span class="signature">( material : <span class="param-type">Material</span> )</span> </h3>
  26. <div class="method">
  27. <div class="description">
  28. <p>Constructs a new quad mesh.</p>
  29. </div>
  30. <table class="params">
  31. <tbody>
  32. <tr>
  33. <td class="name"><code>material</code></td>
  34. <td class="description last"><p>The material to render the quad mesh with.<br/>Default is <code>null</code>.</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="camera" translate="no">.<a href="#camera">camera</a><span class="type-signature"> : <a href="OrthographicCamera.html">OrthographicCamera</a></span> <span class="type-signature">(readonly) </span></h3>
  43. <div class="description">
  44. <p>The camera to render the quad mesh with.</p>
  45. </div>
  46. </div>
  47. <div class="member">
  48. <h3 class="name" id="isQuadMesh" translate="no">.<a href="#isQuadMesh">isQuadMesh</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  49. <div class="description">
  50. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  51. </div>
  52. </div>
  53. <h2 class="subsection-title">Methods</h2>
  54. <h3 class="name name-method" id="render" translate="no">.<a href="#render">render</a><span class="signature">( renderer : <span class="param-type">Renderer</span> )</span> </h3>
  55. <div class="method">
  56. <div class="description">
  57. <p>Renders the quad mesh</p>
  58. </div>
  59. <table class="params">
  60. <tbody>
  61. <tr>
  62. <td class="name"><code>renderer</code></td>
  63. <td class="description last"><p>The renderer.</p></td>
  64. </tr>
  65. </tbody>
  66. </table>
  67. </div>
  68. <h3 class="name name-method" id="renderAsync" translate="no">.<a href="#renderAsync">renderAsync</a><span class="signature">( renderer : <span class="param-type">Renderer</span> )</span><span class="type-signature"> : Promise</span> <span class="type-signature">(async) </span></h3>
  69. <div class="method">
  70. <div class="description">
  71. <p>Async version of <code>render()</code>.</p>
  72. </div>
  73. <table class="params">
  74. <tbody>
  75. <tr>
  76. <td class="name"><code>renderer</code></td>
  77. <td class="description last"><p>The renderer.</p></td>
  78. </tr>
  79. </tbody>
  80. </table>
  81. <dl class="details">
  82. <dt class="important tag-deprecated"><strong>Deprecated:</strong> Yes</dt>
  83. </dl>
  84. <dl class="details">
  85. <dt class="tag-returns"><strong>Returns:</strong> A Promise that resolves when the render has been finished.</dt>
  86. </dl>
  87. </div>
  88. <h2 class="subsection-title">Source</h2>
  89. <p>
  90. <a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/common/QuadMesh.js" target="_blank" rel="noopener" translate="no">src/renderers/common/QuadMesh.js</a>
  91. </p>
  92. </article>
  93. </section>
  94. <script src="../scripts/linenumber.js"></script>
  95. <script src="../scripts/page.js"></script>
  96. </body>
  97. </html>
粤ICP备19079148号