Skip to content

Commit d0622f3

Browse files
BjvanminnenBjvanminnen
committed
Document THREE.js constants
1 parent c8ff9ce commit d0622f3

File tree

6 files changed

+239
-0
lines changed

6 files changed

+239
-0
lines changed

‎docs/api/constants/CustomBlendingEquations.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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>Custom Blending Equation Constants</h1>
11+
12+
<h2>Equations</h2>
13+
<div>
14+
THREE.AddEquation<br />
15+
THREE.SubtractEquation<br />
16+
THREE.ReverseSubtractEquation
17+
</div>
18+
19+
<h2>Destination Factors</h2>
20+
<div>
21+
THREE.ZeroFactor<br />
22+
THREE.OneFactor<br />
23+
THREE.SrcColorFactor<br />
24+
THREE.OneMinusSrcColorFactor<br />
25+
THREE.SrcAlphaFactor<br />
26+
THREE.OneMinusSrcAlphaFactor<br />
27+
THREE.DstAlphaFactor<br />
28+
THREE.OneMinusDstAlphaFactor
29+
</div>
30+
31+
<h2>Source Factors</h2>
32+
<div>
33+
THREE.DstColorFactor<br />
34+
THREE.OneMinusDstColorFactor<br />
35+
THREE.SrcAlphaSaturateFactor
36+
</div>
37+
38+
<h2>Source</h2>
39+
40+
[link:https://github.com/mrdoob/three.js/blob/master/src/Three.js src/Three.js]
41+
</body>
42+
</html>

‎docs/api/constants/GLState.html‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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>GL State Conflicts</h1>
11+
12+
<h2>Cull Face</h2>
13+
<div>
14+
THREE.CullFaceNone<br />
15+
THREE.CullFaceBack<br />
16+
THREE.CullFaceFront<br />
17+
THREE.CullFaceFrontBack
18+
</div>
19+
20+
<h2>Front Face Direction</h2>
21+
<div>
22+
THREE.FrontFaceDirectionCW<br />
23+
THREE.FrontFaceDirectionCCW<br />
24+
</div>
25+
26+
<h2>Source</h2>
27+
28+
[link:https://github.com/mrdoob/three.js/blob/master/src/Three.js src/Three.js]
29+
</body>
30+
</html>

‎docs/api/constants/Materials.html‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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>Material Constants</h1>
11+
12+
<h2>Side</h2>
13+
<div>
14+
THREE.FrontSide<br />
15+
THREE.BackSide<br />
16+
THREE.DoubleSide
17+
</div>
18+
19+
<h2>Shading</h2>
20+
<div>
21+
THREE.NoShading<br />
22+
THREE.FlatShading<br />
23+
THREE.SmoothShading
24+
</div>
25+
26+
<h2>Colors</h2>
27+
<div>
28+
THREE.NoColors<br />
29+
THREE.FaceColors<br />
30+
THREE.VertexColors
31+
</div>
32+
33+
<h2>Blending Mode</h2>
34+
<div>
35+
THREE.NoBlending<br />
36+
THREE.NormalBlending<br />
37+
THREE.AdditiveBlending<br />
38+
THREE.SubtractiveBlending<br />
39+
THREE.MultiplyBlending<br />
40+
THREE.CustomBlending
41+
</div>
42+
43+
44+
45+
<h2>Source</h2>
46+
47+
[link:https://github.com/mrdoob/three.js/blob/master/src/Three.js src/Three.js]
48+
</body>
49+
</html>

‎docs/api/constants/ShadowingTypes.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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>Shadowing Type Contants</h1>
11+
12+
<h2>Shadow Map</h2>
13+
<div>
14+
THREE.BasicShadowMap<br />
15+
THREE.PCFShadowMap<br />
16+
THREE.PCFSoftShadowMap
17+
</div>
18+
19+
20+
<h2>Source</h2>
21+
22+
[link:https://github.com/mrdoob/three.js/blob/master/src/Three.js src/Three.js]
23+
</body>
24+
</html>

‎docs/api/constants/Textures.html‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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>Texture Constants</h1>
11+
12+
<h2>Texture Constants</h2>
13+
<h2>Operations</h2>
14+
<div>
15+
THREE.MultiplyOperation<br />
16+
THREE.MixOperation<br />
17+
THREE.AddOperation
18+
</div>
19+
20+
<h2>Mapping Modes</h2>
21+
<div>
22+
THREE.UVMapping<br />
23+
THREE.CubeReflectionMapping<br />
24+
THREE.CubeRefractionMapping<br />
25+
THREE.SphericalReflectionMapping<br />
26+
THREE.SphericalRefractionMapping
27+
</div>
28+
29+
<h2>Wrapping Modes</h2>
30+
<div>
31+
THREE.RepeatWrapping<br />
32+
THREE.ClampToEdgeWrapping<br />
33+
THREE.MirroredRepeatWrapping
34+
</div>
35+
36+
<h2>Filters</h2>
37+
<div>
38+
THREE.NearestFilter<br />
39+
THREE.NearestMipMapNearestFilter<br />
40+
THREE.NearestMipMapLinearFilter<br />
41+
THREE.LinearFilter<br />
42+
THREE.LinearMipMapNearestFilter<br />
43+
THREE.LinearMipMapLinearFilter
44+
</div>
45+
46+
<h2>Data Types</h2>
47+
<div>
48+
THREE.UnsignedByteType<br />
49+
THREE.ByteType<br />
50+
THREE.ShortType<br />
51+
THREE.UnsignedShortType<br />
52+
THREE.IntType<br />
53+
THREE.UnsignedIntType<br />
54+
THREE.FloatType
55+
</div>
56+
57+
<h2>Pixel Types</h2>
58+
<div>
59+
THREE.UnsignedShort4444Type<br />
60+
THREE.UnsignedShort5551Type<br />
61+
THREE.UnsignedShort565Type
62+
</div>
63+
64+
<h2>Pixel Formats</h2>
65+
<div>
66+
THREE.AlphaFormat<br />
67+
THREE.RGBFormat<br />
68+
THREE.RGBAFormat<br />
69+
THREE.LuminanceFormat<br />
70+
THREE.LuminanceAlphaFormat
71+
</div>
72+
73+
<h2>Compressed Texture Formats</h2>
74+
<div>
75+
THREE.RGB_S3TC_DXT1_Format<br />
76+
THREE.RGBA_S3TC_DXT1_Format<br />
77+
THREE.RGBA_S3TC_DXT3_Format<br />
78+
THREE.RGBA_S3TC_DXT5_Format
79+
</div>
80+
81+
82+
<h2>Source</h2>
83+
84+
[link:https://github.com/mrdoob/three.js/blob/master/src/Three.js src/Three.js]
85+
</body>
86+
</html>

‎docs/list.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ var list = {
77
},
88

99
"Reference": {
10+
"Constants": [
11+
[ "CustomBlendingEquation", "api/constants/CustomBlendingEquations"],
12+
[ "GLState", "api/constants/GLState"],
13+
[ "Materials", "api/constants/Materials"],
14+
[ "ShadowingTypes", "api/constants/ShadowingTypes"],
15+
[ "Textures", "api/constants/Textures"]
16+
],
17+
1018
"Cameras": [
1119
[ "Camera", "api/cameras/Camera" ],
1220
[ "OrthographicCamera", "api/cameras/OrthographicCamera" ],

0 commit comments

Comments
 (0)