forked from mrdoob/three.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWebGLRenderTarget.html
More file actions
130 lines (97 loc) · 3.54 KB
/
WebGLRenderTarget.html
File metadata and controls
130 lines (97 loc) · 3.54 KB
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>
<div class="desc">A render target is a buffer where the video card draws pixels for a scene that is being rendered in the background. It is used in different effects. </div>
<h2>Constructor</h2>
<h3>[name]([page:Number width], [page:Number height], [page:Object options])</h3>
<div>
width -- The width of the renderTarget. <br />
height -- The height of the renderTarget.
</div>
<div>options is an optional object that holds texture parameters for an auto-generated target texture and depthBuffer/stencilBuffer booleans. For an explanation of the texture parameters see [page:Texture Texture].</div>
<div>
wrapS — [page:Number] default is *THREE.ClampToEdgeWrapping*. <br />
wrapT — [page:Number] default is *THREE.ClampToEdgeWrapping*. <br />
magFilter — [page:Number], default is *THREE.LinearFilter*. <br />
minFilter — [page:Number], default is *THREE.LinearFilter*. <br />
format — [page:Number], default is *THREE.RGBAFormat*. <br />
type — [page:Number], default is *THREE.UnsignedByteType*. <br />
anisotropy — [page:Number], default is *1*. <br />
encoding — [page:Number], default is *THREE.LinearEncoding*. <br />
depthBuffer — [page:Boolean], default is *true*. Set this to false if you don't need it. <br />
stencilBuffer — [page:Boolean], default is *true*. Set this to false if you don't need it.
</div>
<div>
Creates a new render target with a certain width and height.
</div>
<h2>Properties</h2>
<h3>[property:number uuid]</h3>
<div>
A unique number for this render target instance.
</div>
<h3>[property:number width]</h3>
<div>
The width of the render target.
</div>
<h3>[property:number height]</h3>
<div>
The height of the render target.
</div>
<h3>[property:Vector4 scissor]</h3>
<div>
A rectangular area inside the render target's viewport. Fragments that are outside the area will be discarded.
</div>
<h3>[property:boolean scissorTest]</h3>
<div>
Indicates whether the scissor test is active or not.
</div>
<h3>[property:Vector4 viewport]</h3>
<div>
The viewport of this render target.
</div>
<h3>[property:Texture texture]</h3>
<div>
This texture instance holds the rendered pixels. Use it as input for further processing.
</div>
<h3>[property:boolean depthBuffer]</h3>
<div>
Renders to the depth buffer. Default is true.
</div>
<h3>[property:boolean stencilBuffer]</h3>
<div>
Renders to the stencil buffer. Default is true.
</div>
<h3>[property:DepthTexture depthTexture]</h3>
<div>
If set, the scene depth will be rendered to this texture. Default is null.
</div>
<h2>Methods</h2>
<h3>[method:null setSize]( [page:Number width], [page:Number height] )</h3>
<div>
Sets the size of the render target.
</div>
<h3>[method:WebGLRenderTarget clone]()</h3>
<div>
Creates a copy of this render target.
</div>
<h3>[method:WebGLRenderTarget copy]( [page:WebGLRenderTarget source] )</h3>
<div>
Adopts the settings of the given render target.
</div>
<h3>[method:null dispose]()</h3>
<div>
Dispatches a dispose event.
</div>
<h3>[page:EventDispatcher EventDispatcher] methods are available on this class.</h3>
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</body>
</html>