From eb77f9e6757c691919223dab4f58d80a6cc6af73 Mon Sep 17 00:00:00 2001
From: mistic100 See the base [page:Loader] class for common methods.
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI]. See the base [page:Loader] class for common methods.
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
Begin loading from url and pass the loaded [page:String AudioBuffer] to onLoad.
diff --git a/docs/api/en/loaders/BufferGeometryLoader.html b/docs/api/en/loaders/BufferGeometryLoader.html
index f475c23210094e..d2041ccf906186 100644
--- a/docs/api/en/loaders/BufferGeometryLoader.html
+++ b/docs/api/en/loaders/BufferGeometryLoader.html
@@ -68,13 +68,14 @@ See the base [page:Loader] class for common methods.
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].d
Begin loading from url and call onLoad with the parsed response content.
diff --git a/docs/api/en/loaders/CompressedTextureLoader.html b/docs/api/en/loaders/CompressedTextureLoader.html
index 978badddda549f..3c425d358900ed 100644
--- a/docs/api/en/loaders/CompressedTextureLoader.html
+++ b/docs/api/en/loaders/CompressedTextureLoader.html
@@ -40,13 +40,14 @@ See the base [page:Loader] class for common methods.
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
Begin loading from url and pass the loaded texture to onLoad.
diff --git a/docs/api/en/loaders/CubeTextureLoader.html b/docs/api/en/loaders/CubeTextureLoader.html
index 65c64ca15e159e..76149794e84b14 100644
--- a/docs/api/en/loaders/CubeTextureLoader.html
+++ b/docs/api/en/loaders/CubeTextureLoader.html
@@ -55,7 +55,7 @@ See the base [page:Loader] class for common methods.
[page:String urls] — array of 6 urls to images, one for each side of the CubeTexture.
The urls should be specified in the following order: pos-x, neg-x, pos-y, neg-y, pos-z, neg-z.
@@ -64,8 +64,9 @@ Properties
Methods
[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )
+ [method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError], [param:AbortSignal abortSignal] )
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:AnimationClip animation clips].
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called if load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called if load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Begin loading from url and pass the loaded animation to onLoad.
Properties
Methods
[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )
+ [method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError], [param:AbortSignal abortSignal] )
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded text response.
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Properties
Methods
[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )
+ [method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError], [param:AbortSignal abortSignal] )
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:BufferGeometry].
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Properties
Methods
[method:CompressedTexture load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )
+ [method:CompressedTexture load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError], [param:AbortSignal abortSignal] )
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded texture.
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Properties
Methods
[method:CubeTexture load]( [param:String urls], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )
+ [method:CubeTexture load]( [param:String urls], [param:Function onLoad], [param:Function onProgress], [param:Function onError], [param:AbortSignal abortSignal] )
[method:CubeTexture load]( [param:String urls], [param:Function onLoad], [pa
when looking up the positive-z axis -- in other words, using a left-handed coordinate system.
Since three.js uses a right-handed coordinate system, environment maps used in three.js will have pos-x and neg-x swapped.
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — This callback function is currently not supported.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Begin loading from url and pass the loaded [page:CubeTexture texture] to onLoad. diff --git a/docs/api/en/loaders/DataTextureLoader.html b/docs/api/en/loaders/DataTextureLoader.html index 715677a814d7c4..eab51b84452250 100644 --- a/docs/api/en/loaders/DataTextureLoader.html +++ b/docs/api/en/loaders/DataTextureLoader.html @@ -40,13 +40,14 @@
See the base [page:Loader] class for common methods.
-
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded texture.
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses.The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Begin loading from url and pass the loaded texture to onLoad. diff --git a/docs/api/en/loaders/FileLoader.html b/docs/api/en/loaders/FileLoader.html index 2eb00d3d433d73..de5bdc384ee6df 100644 --- a/docs/api/en/loaders/FileLoader.html +++ b/docs/api/en/loaders/FileLoader.html @@ -12,7 +12,7 @@
- A low level class for loading resources with XMLHttpRequest, used internaly by most loaders. + A low level class for loading resources with Fetch, used internaly by most loaders. It can also be used directly to load any file type that does not have a loader.
@@ -74,14 +74,14 @@See the base [page:Loader] class for common methods.
-
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] (optional) — Will be called when loading completes. The argument will be the loaded response.
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the XMLHttpRequest instance,
- which contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] (optional) — Will be called if an error occurs.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called if an error occurs.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Load the URL and pass the response to the onLoad function.
See the base [page:Loader] class for common methods.
-
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Image image].
- [page:Function onProgress] — This callback function is currently not supported.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — This callback function is currently not supported.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Begin loading from url and return the [page:ImageBitmap image] object that will contain the data. diff --git a/docs/api/en/loaders/ImageLoader.html b/docs/api/en/loaders/ImageLoader.html index 24a7def254d091..6eb1b1306e9f41 100644 --- a/docs/api/en/loaders/ImageLoader.html +++ b/docs/api/en/loaders/ImageLoader.html @@ -78,8 +78,8 @@
Begin loading from url and return the [page:Image image] object that will contain the data. diff --git a/docs/api/en/loaders/Loader.html b/docs/api/en/loaders/Loader.html index 7fb38e41f50b1f..9b11c68ef1a8ba 100644 --- a/docs/api/en/loaders/Loader.html +++ b/docs/api/en/loaders/Loader.html @@ -67,10 +67,11 @@
[page:String url] — A string containing the path/URL of the file to be loaded.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — A function to be called while the loading is in progress. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
This method is equivalent to [page:.load], but returns a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]. diff --git a/docs/api/en/loaders/MaterialLoader.html b/docs/api/en/loaders/MaterialLoader.html index 22eff3945bdd31..168a884092aa76 100644 --- a/docs/api/en/loaders/MaterialLoader.html +++ b/docs/api/en/loaders/MaterialLoader.html @@ -62,13 +62,14 @@
See the base [page:Loader] class for common methods.
-
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Material].
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Begin loading from url.
See the base [page:Loader] class for common methods.
-
[page:String url] — the path or URL to the file. This can also be a
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Object3D object].
- [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. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
- [page:Function onError] — Will be called when load errors.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onError] (optional) — Will be called when load errors.
+ [page:AbortSignal abortSignal] (optional) — the signal of an AbortController used to cancel the request.
Begin loading from url and call onLoad with the parsed response content. diff --git a/docs/api/en/loaders/TextureLoader.html b/docs/api/en/loaders/TextureLoader.html index a6863840b79bfd..4b3b7e5ab3cd03 100644 --- a/docs/api/en/loaders/TextureLoader.html +++ b/docs/api/en/loaders/TextureLoader.html @@ -85,8 +85,8 @@