EffectComposer.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. <!DOCTYPE html>
  2. <html lang="zh">
  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. <h1>效果合成器([name])</h1>
  11. <p class="desc">
  12. 用于在three.js中实现后期处理效果。该类管理了产生最终视觉效果的后期处理过程链。
  13. 后期处理过程根据它们添加/插入的顺序来执行,最后一个过程会被自动渲染到屏幕上。
  14. </p>
  15. <h2>例子</h2>
  16. <p>
  17. [example:webgl_postprocessing postprocessing]<br />
  18. [example:webgl_postprocessing_advanced postprocessing advanced]<br />
  19. [example:webgl_postprocessing_backgrounds postprocessing backgrounds]<br />
  20. [example:webgl_postprocessing_crossfade postprocessing crossfade]<br />
  21. [example:webgl_postprocessing_dof postprocessing depth-of-field]<br />
  22. [example:webgl_postprocessing_dof2 postprocessing depth-of-field 2]<br />
  23. [example:webgl_postprocessing_fxaa postprocessing fxaa]<br />
  24. [example:webgl_postprocessing_glitch postprocessing glitch]<br />
  25. [example:webgl_postprocessing_godrays postprocessing godrays]<br />
  26. [example:webgl_postprocessing_masking postprocessing masking]<br />
  27. [example:webgl_postprocessing_outline postprocessing outline]<br />
  28. [example:webgl_postprocessing_pixel postprocessing pixelate]<br />
  29. [example:webgl_postprocessing_procedural postprocessing procedural]<br />
  30. [example:webgl_postprocessing_rgb_halftone postprocessing rgb halftone]<br />
  31. [example:webgl_postprocessing_sao postprocessing sao]<br />
  32. [example:webgl_postprocessing_smaa postprocessing smaa]<br />
  33. [example:webgl_postprocessing_sobel postprocessing sobel]<br />
  34. [example:webgl_postprocessing_ssaa postprocessing ssaa]<br />
  35. [example:webgl_postprocessing_ssao postprocessing ssao]<br />
  36. [example:webgl_postprocessing_taa postprocessing taa]<br />
  37. [example:webgl_postprocessing_unreal_bloom postprocessing unreal bloom]<br />
  38. [example:webgl_postprocessing_unreal_bloom_selective postprocessing unreal bloom selective]<br />
  39. </p>
  40. <h2>构造函数</h2>
  41. <h3>[name]( [param:WebGLRenderer renderer], [param:WebGLRenderTarget renderTarget] )</h3>
  42. <p>
  43. [page:WebGLRenderer renderer] -- 用于渲染场景的渲染器。<br />
  44. [page:WebGLRenderTarget renderTarget] -- (可选)一个预先配置的渲染目标,内部由 [name] 使用。
  45. </p>
  46. <h2>属性</h2>
  47. <h3>[property:Array passes]</h3>
  48. <p>
  49. 一个用于表示后期处理过程链(包含顺序)的数组。
  50. </p>
  51. <h3>[property:WebGLRenderTarget readBuffer]</h3>
  52. <p>
  53. 内部读缓冲区的引用。过程一般从该缓冲区读取先前的渲染结果。
  54. </p>
  55. <h3>[property:WebGLRenderer renderer]</h3>
  56. <p>
  57. 内部渲染器的引用。
  58. </p>
  59. <h3>[property:Boolean renderToScreen]</h3>
  60. <p>
  61. 最终过程是否被渲染到屏幕(默认帧缓冲区)。
  62. </p>
  63. <h3>[property:WebGLRenderTarget writeBuffer]</h3>
  64. <p>
  65. 内部写缓冲区的引用。过程常将它们的渲染结果写入该缓冲区。
  66. </p>
  67. <h2>方法</h2>
  68. <h3>[method:undefined addPass]( [param:Pass pass] )</h3>
  69. <p>
  70. pass -- 将被添加到过程链的过程<br /><br />
  71. 将传入的过程添加到过程链。
  72. </p>
  73. <h3>[method:undefined dispose]()</h3>
  74. <p>
  75. Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
  76. </p>
  77. <h3>[method:undefined insertPass]( [param:Pass pass], [param:Integer index] )</h3>
  78. <p>
  79. pass -- 将被插入到过程链的过程。<br />
  80. index -- 定义过程链中过程应插入的位置。<br /><br />
  81. 将传入的过程插入到过程链中所给定的索引处。
  82. </p>
  83. <h3>[method:Boolean isLastEnabledPass]( [param:Integer passIndex] )</h3>
  84. <p>
  85. passIndex -- 被用于检查的过程<br /><br />
  86. 如果给定索引的过程在过程链中是最后一个启用的过程,则返回true。
  87. 由[name]所使用,来决定哪一个过程应当被渲染到屏幕上。
  88. </p>
  89. <h3>[method:undefined removePass]( [param:Pass pass] )</h3>
  90. <p>
  91. pass -- The pass to remove from the pass chain.<br /><br />
  92. Removes the given pass from the pass chain.
  93. </p>
  94. <h3>[method:undefined render]( [param:Float deltaTime] )</h3>
  95. <p>
  96. deltaTime -- The delta time value.<br /><br />
  97. 执行所有启用的后期处理过程,来产生最终的帧,
  98. </p>
  99. <h3>[method:undefined reset]( [param:WebGLRenderTarget renderTarget] )</h3>
  100. <p>
  101. [page:WebGLRenderTarget renderTarget] -- (可选)一个预先配置的渲染目标,内部由 [name] 使用。<br /><br />
  102. 重置所有[name]的内部状态。
  103. </p>
  104. <h3>[method:undefined setPixelRatio]( [param:Float pixelRatio] )</h3>
  105. <p>
  106. pixelRatio -- 设备像素比<br /><br />
  107. 设置设备的像素比。该值通常被用于HiDPI设备,以阻止模糊的输出。
  108. 因此,该方法语义类似于[page:WebGLRenderer.setPixelRatio]()。
  109. </p>
  110. <h3>[method:undefined setSize]( [param:Integer width], [param:Integer height] )</h3>
  111. <p>
  112. width -- [name]的宽度。<br />
  113. height -- [name]的高度。<br /><br />
  114. 考虑设备像素比,重新设置内部渲染缓冲和过程的大小为(width, height)。
  115. 因此,该方法语义类似于[page:WebGLRenderer.setSize]()。
  116. </p>
  117. <h3>[method:undefined swapBuffers]()</h3>
  118. <p>交换内部的读/写缓冲。</p>
  119. <h2>源代码</h2>
  120. <p>
  121. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/postprocessing/EffectComposer.js examples/jsm/postprocessing/EffectComposer.js]
  122. </p>
  123. </body>
  124. </html>