Skip to content

Documentation: Clean up loaders #15532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 7, 2019
Merged

Documentation: Clean up loaders #15532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eff095a
correct return type
aardgoose Jan 6, 2019
f6d816d
fix some incorrect type cases
aardgoose Jan 6, 2019
1c51265
correct more return types
aardgoose Jan 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/en/loaders/CompressedTextureLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h3>[property:String path]</h3>

<h2>Methods</h2>

<h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<h3>[method:CompressedTexture load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<p>
[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].<br />
Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/loaders/CubeTextureLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h3>[property:String path]</h3>

<h2>Methods</h2>

<h3>[method:null load]( [param:String urls], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<h3>[method:CubeTexture load]( [param:String urls], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<p>
[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.
Expand All @@ -83,7 +83,7 @@ <h3>[method:null load]( [param:String urls], [param:Function onLoad], [param:Fun
[page:Function onError] — Will be called when load errors.<br />
</p>
<p>
Begin loading from url and pass the loaded [page:Texture texture] to onLoad.
Begin loading from url and pass the loaded [page:CubeTexture texture] to onLoad.
</p>

<h3>[method:null setCrossOrigin]( [param:String value] )</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/loaders/DataTextureLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h3>[property:LoadingManager manager]</h3>

<h2>Methods</h2>

<h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<h3>[method:DataTexture load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<p>
[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].<br />
Expand Down
8 changes: 4 additions & 4 deletions docs/api/en/loaders/FileLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h3>[property:String mimeType]</h3>
<h3>[property:String path]</h3>
<p>The base path from which files will be loaded. See [page:.setPath]. Default is *undefined*.</p>

<h3>[property:object requestHeader]</h3>
<h3>[property:Object requestHeader]</h3>
<p>The [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request. See [page:.setRequestHeader]. Default is *undefined*.</p>

<h3>[property:String responseType]</h3>
Expand All @@ -91,7 +91,7 @@ <h3>[property:String withCredentials]</h3>

<h2>Methods</h2>

<h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<h3>[method:XMLHttpRequest load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<p>
[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].<br />
Expand All @@ -115,7 +115,7 @@ <h3>[method:FileLoader setPath]( [param:String path] )</h3>
you are loading many models from the same directory.
</p>

<h3>[method:FileLoader setRequestHeader]( [param:object requestHeader] )</h3>
<h3>[method:FileLoader setRequestHeader]( [param:Object requestHeader] )</h3>
<p>
[page:object requestHeader] - key: The name of the header whose value is to be set. value: The value to set as the body of the header.<br /><br />

Expand All @@ -125,7 +125,7 @@ <h3>[method:FileLoader setRequestHeader]( [param:object requestHeader] )</h3>
<h3>[method:FileLoader setResponseType]( [param:String responseType] )</h3>
<p>
Change the response type. Valid values are:<br />
[page:String text] or empty string (default) - returns the data as [page:String string].<br />
[page:String text] or empty string (default) - returns the data as [page:String String].<br />
[page:String arraybuffer] - loads the data into a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ArrayBuffer] and returns that.<br />
[page:String blob] - returns the data as a [link:https://developer.mozilla.org/en/docs/Web/API/Blob Blob].<br />
[page:String document] - parses the file using the [link:https://developer.mozilla.org/en-US/docs/Web/API/DOMParser DOMParser].<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/loaders/FontLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ <h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Func
<p>
[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].<br />
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].<br />
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Font font].<br />
[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 />
[page:Function onError] — Will be called when load errors.<br /><br />

Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/loaders/ImageLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h3>[property:String path]</h3>

<h2>Methods</h2>

<h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<h3>[method:HTMLImageElement load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<p>
[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].<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/loaders/MaterialLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Func
[page:Function onProgress] — Will be called while load progresses. The argument will be the progress event.<br />
[page:Function onError] — Will be called when load errors.<br /><br />

Begin loading from url and return the [page:Material] object that will contain the data.
Begin loading from url.
</p>

<h3>[method:Material parse]( [param:Object json] )</h3>
Expand Down