CubeTextureLoader.html 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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:Loader] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Class for loading a [page:CubeTexture CubeTexture].
  14. This uses the [page:ImageLoader] internally for loading files.
  15. </p>
  16. <h2>Code Example</h2>
  17. <code>
  18. const scene = new THREE.Scene();
  19. scene.background = new THREE.CubeTextureLoader()
  20. .setPath( 'textures/cubeMaps/' )
  21. .load( [
  22. 'px.png',
  23. 'nx.png',
  24. 'py.png',
  25. 'ny.png',
  26. 'pz.png',
  27. 'nz.png'
  28. ] );
  29. </code>
  30. <h2>Examples</h2>
  31. <p>
  32. [example:webgl_materials_cubemap materials / cubemap]<br />
  33. [example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic]<br />
  34. [example:webgl_materials_cubemap_refraction materials / cubemap / refraction]
  35. </p>
  36. <h2>Constructor</h2>
  37. <h3>[name]( [param:LoadingManager manager] )</h3>
  38. <p>
  39. [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].<br /><br />
  40. Creates a new [name].
  41. </p>
  42. <h2>Properties</h2>
  43. <p>See the base [page:Loader] class for common properties.</p>
  44. <h2>Methods</h2>
  45. <p>See the base [page:Loader] class for common methods.</p>
  46. <h3>[method:CubeTexture load]( [param:String urls], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  47. <p>
  48. [page:String urls] — array of 6 urls to images, one for each side of the CubeTexture.
  49. The urls should be specified in the following order: pos-x, neg-x, pos-y, neg-y, pos-z, neg-z.
  50. They can also be [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URIs].<br />
  51. Note that, by convention, cube maps are specified in a coordinate system in which positive-x is to the right
  52. when looking up the positive-z axis -- in other words, using a left-handed coordinate system.
  53. Since three.js uses a right-handed coordinate system, environment maps used in three.js will have pos-x and neg-x swapped.<br />
  54. [page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].<br />
  55. [page:Function onProgress] — Will be called while load progresses. The argument will be the XMLHttpRequest instance, which contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
  56. [page:Function onError] — Will be called when load errors.<br />
  57. </p>
  58. <p>
  59. Begin loading from url and pass the loaded [page:CubeTexture texture] to onLoad.
  60. </p>
  61. <h2>Source</h2>
  62. <p>
  63. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  64. </p>
  65. </body>
  66. </html>