forked from serjIII/threejsSDK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CubeTextureLoader.html
94 lines (81 loc) · 3.15 KB
/
CubeTextureLoader.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Loader] →
<h1>[name]</h1>
<p class="desc">
[name] can be used to load cube maps. The loader returns an instance of [page:CubeTexture] and expects the cube map to
be defined as six separate images representing the sides of a cube. Other cube map definitions like vertical and horizontal cross,
column and row layouts are not supported.
</p>
<p>
The loaded [page:CubeTexture] is in sRGB color space. Meaning the [page:Texture.colorSpace colorSpace]
property is set to `THREE.SRGBColorSpace` by default.
</p>
<h2>Code Example</h2>
<code>
const scene = new THREE.Scene();
scene.background = new THREE.CubeTextureLoader()
.setPath( 'textures/cubeMaps/' )
.load( [
'px.png',
'nx.png',
'py.png',
'ny.png',
'pz.png',
'nz.png'
] );
</code>
<h2>Examples</h2>
<p>
[example:webgl_materials_cubemap materials / cubemap]<br />
[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic]<br />
[example:webgl_materials_cubemap_refraction materials / cubemap / refraction]
</p>
<h2>Constructor</h2>
<h3>[name]( [param:LoadingManager manager] )</h3>
<p>
[page:LoadingManager manager] — The [page:LoadingManager loadingManager]
for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].<br /><br />
Creates a new [name].
</p>
<h2>Properties</h2>
<p>See the base [page:Loader] class for common properties.</p>
<h2>Methods</h2>
<p>See the base [page:Loader] class for common methods.</p>
<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. They can also be
[link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URIs].<br />
Note that, by convention, cube maps are specified in a coordinate system
in which positive-x is to the right 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.<br />
[page:Function onLoad] (optional) — Will be called when load completes.
The argument will be the loaded [page:CubeTexture texture].<br />
[page:Function onProgress] (optional) — This callback function is
currently not supported.<br />
[page:Function onError] (optional) — Will be called when load errors.<br />
</p>
<p>
Begin loading from url and pass the loaded [page:CubeTexture texture] to
onLoad. The method also returns a new texture object which can directly be
used for material creation.
</p>
<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>