-
Notifications
You must be signed in to change notification settings - Fork 0
/
PIXI.ObjectRenderer.html
285 lines (155 loc) · 7.22 KB
/
PIXI.ObjectRenderer.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
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>webdoc: ObjectRenderer</title>
<link type="text/css" rel="stylesheet" href="styles/index.css" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono:300,400,500,700&display=swap" />
<link type="text/css" rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.3/styles/googlecode.min.css">
<script crossorigin src="https://unpkg.com/react@16/umd/react.development.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
<script src="scripts/default-template.js"></script>
</head>
<body class="root">
<div class="docs">
<header class="header" id="header-mount-point"></header>
<article class="page">
<div class="page-explorer" id="explorer-mount-point"></div>
<div class="page-content">
<div class="document">
<div class="document__package">@webdoc/example</div>
<h1 class="document__title">PIXI.ObjectRenderer</h1>
<pre class="signature__container"><code class="signature">class ObjectRenderer extends <a href="PIXI.System.html">PIXI.System</a></code></pre>
<div class="document__brief"><p>Base for a common object renderer that can be used as a system renderer plugin.</p></div>
<div class="document__description"></div>
<div class="members">
<h2 class="members__category">Constructor</h2>
<div class="member" id="constructor">
<h3 class="member__title"></h3>
<pre class="signature__container"><code class="signature">new PIXI.ObjectRenderer(renderer: PIXI.Renderer) → {}</code></pre>
<div class="member__brief"></div>
<div class="member__description"></div>
<div class="table-wrapper">
<table class="member-parameters">
<caption class="member-parameters__caption">Parameters:</caption>
<thead class="member-parameters__head">
<tr class="member-parameter-header">
<th class="member-parameter-header__name">Name</th>
<th class="member-parameter-header__type">Type</th>
<th class="member-parameter-header__description">Description</th>
</tr>
</thead>
<tbody class="member-parameters__body">
<tr class="member-parameter">
<td class="member-parameter__name">
renderer
</td>
<td class="member-parameter__type">
PIXI.Renderer
</td>
<td class="member-parameter__description"><p>The renderer this manager works for.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="members">
<h2 class="members__category">Public Properties</h2>
<div class="member" id="renderer">
<h3 class="member__title">renderer</h3>
<pre class="signature__container"><code class="signature">renderer: PIXI.Renderer</code></pre>
<div class="member__brief"><p>The renderer this manager works for.</p></div>
<div class="member__description"></div>
</div>
</div>
<div class="members">
<h2 class="members__category">Public Methods</h2>
<div class="member" id="destroy">
<h3 class="member__title">destroy</h3>
<pre class="signature__container"><code class="signature">destroy() → {}</code></pre>
<div class="member__brief"></div>
<div class="member__description"><p>Generic destruction method that frees all resources. This
should be called by subclasses.</p></div>
</div>
<div class="member" id="flush">
<h3 class="member__title">flush</h3>
<pre class="signature__container"><code class="signature">flush() → {}</code></pre>
<div class="member__brief"></div>
<div class="member__description"><p>Stub method that should be used to empty the current
batch by rendering objects now.</p></div>
</div>
<div class="member" id="render">
<h3 class="member__title">render</h3>
<pre class="signature__container"><code class="signature">render(object: PIXI.DisplayObject) → {}</code></pre>
<div class="member__brief"></div>
<div class="member__description"><p>Keeps the object to render. It doesn't have to be
rendered immediately.</p></div>
<div class="table-wrapper">
<table class="member-parameters">
<caption class="member-parameters__caption">Parameters:</caption>
<thead class="member-parameters__head">
<tr class="member-parameter-header">
<th class="member-parameter-header__name">Name</th>
<th class="member-parameter-header__type">Type</th>
<th class="member-parameter-header__description">Description</th>
</tr>
</thead>
<tbody class="member-parameters__body">
<tr class="member-parameter">
<td class="member-parameter__name">
object
</td>
<td class="member-parameter__type">
PIXI.DisplayObject
</td>
<td class="member-parameter__description"><p>The object to render.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="member" id="start">
<h3 class="member__title">start</h3>
<pre class="signature__container"><code class="signature">start() → {}</code></pre>
<div class="member__brief"></div>
<div class="member__description"><p>Stub method that initializes any state required before
rendering starts. It is different from the <code>prerender</code>
signal, which occurs every frame, in that it is called
whenever an object requests <em>this</em> renderer specifically.</p></div>
</div>
<div class="member" id="stop">
<h3 class="member__title">stop</h3>
<pre class="signature__container"><code class="signature">stop() → {}</code></pre>
<div class="member__brief"></div>
<div class="member__description"><p>Stops the renderer. It should free up any state and
become dormant.</p></div>
</div>
</div>
</div>
</div>
<nav class="page-members-explorer">
<div class="page-members-explorer-category">
<h3 class="page-members-explorer-category__title">Public Properties</h3>
<ul class="page-members-explorer-category__items">
<li class="page-members-explorer__item"><a href="PIXI.ObjectRenderer.html#renderer">renderer</a></li>
</ul>
</div>
<div class="page-members-explorer-category">
<h3 class="page-members-explorer-category__title">Public Methods</h3>
<ul class="page-members-explorer-category__items">
<li class="page-members-explorer__item"><a href="PIXI.ObjectRenderer.html#destroy">destroy</a></li>
<li class="page-members-explorer__item"><a href="PIXI.ObjectRenderer.html#flush">flush</a></li>
<li class="page-members-explorer__item"><a href="PIXI.ObjectRenderer.html#render">render</a></li>
<li class="page-members-explorer__item"><a href="PIXI.ObjectRenderer.html#start">start</a></li>
<li class="page-members-explorer__item"><a href="PIXI.ObjectRenderer.html#stop">stop</a></li>
</ul>
</div>
</nav>
</article>
<footer class="footer" id="footer-mount-point"></footer>
<script src="scripts/linenumber.js"> </script>
</body>
</div>
</html>