LightProbeHelper.html 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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:Object3D] &rarr; [page:Mesh] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Renders a sphere to visualize a light probe in the scene.
  14. <p>
  15. <h2>Code Example</h2>
  16. <code>
  17. const helper = new LightProbeHelper( lightProbe, 1 );
  18. scene.add( helper );
  19. </code>
  20. <h2>Examples</h2>
  21. <p>[example:webgl_lightprobe_cubecamera WebGL / lightprobe / cubecamera]</p>
  22. <h2>Constructor</h2>
  23. <h3>[name]( [param:LightProbe lightProbe], [param:Number size] )</h3>
  24. <p>
  25. [page:LightProbe lightProbe] -- the light probe.<br />
  26. [page:Number size] -- size of the helper sphere
  27. </p>
  28. <h2>Properties</h2>
  29. <p>See the base [page:Mesh] class for common properties.</p>
  30. <h3>[property:LightProbe lightProbe]</h3>
  31. <p>The light probe.</p>
  32. <h3>[property:Number size]</h3>
  33. <p>The size of the helper sphere.</p>
  34. <h2>Methods</h2>
  35. <p>See the base [page:Mesh] class for common methods.</p>
  36. <h3>[method:undefined dispose]()</h3>
  37. <p>
  38. Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
  39. </p>
  40. <h2>Source</h2>
  41. <p>
  42. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/LightProbeHelper.js examples/jsm/helpers/LightProbeHelper.js]
  43. </p>
  44. </body>
  45. </html>