ImageLoader.html 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <script src="../../list.js"></script>
  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. <div class="desc">A loader for loading an [page:Image].</div>
  12. <h2>Constructor</h2>
  13. <h3>[name]( [page:LoadingManager manager] )</h3>
  14. <div>
  15. [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
  16. </div>
  17. <div>
  18. Creates a new [name].
  19. </div>
  20. <h2>Properties</h2>
  21. <h3>[property:String crossOrigin]</h3>
  22. <div>
  23. The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  24. </div>
  25. <h2>Methods</h2>
  26. <h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
  27. <div>
  28. [page:String url] — required<br />
  29. [page:Function onLoad] — Will be called when load completes. The argument will be the loaded Imageloader.<br />
  30. [page:Function onProgress] — Will be called while load progresses. The argument will be the progress event.<br />
  31. [page:Function onError] — Will be called when load errors.<br />
  32. </div>
  33. <div>
  34. Begin loading from url and return the [page:Image image] object that will contain the data.
  35. </div>
  36. <h3>[method:null setCrossOrigin]( [page:String value] )</h3>
  37. <div>
  38. [page:String value] — The crossOrigin string.
  39. </div>
  40. <div>
  41. The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  42. </div>
  43. <h2>Example</h2>
  44. <code>
  45. // instantiate a loader
  46. var loader = new THREE.ImageLoader();
  47. // load a image resource
  48. loader.load(
  49. // resource URL
  50. 'textures/skyboxsun25degtest.png',
  51. // Function when resource is loaded
  52. function ( image ) {
  53. // do something with it
  54. // like drawing a part of it on a canvas
  55. var canvas = document.createElement( 'canvas' );
  56. var context = canvas.getContext( '2d' );
  57. context.drawImage( image, 100, 100 );
  58. },
  59. // Function called when download progresses
  60. function ( xhr ) {
  61. console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
  62. },
  63. // Function called when download errors
  64. function ( xhr ) {
  65. console.log( 'An error happened' );
  66. }
  67. );
  68. </code>
  69. [example:webgl_shaders_ocean]
  70. <h2>Source</h2>
  71. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  72. </body>
  73. </html>