-
Notifications
You must be signed in to change notification settings - Fork 193
/
Copy pathsrc_render_GLRenderManager.ts.html
1107 lines (859 loc) · 40.5 KB
/
src_render_GLRenderManager.ts.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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>src\render\GLRenderManager.ts - Kiwi.js</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="Kiwi.js"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Kiwi.Animations.Animation.html">Kiwi.Animations.Animation</a></li>
<li><a href="../classes/Kiwi.Animations.Sequence.html">Kiwi.Animations.Sequence</a></li>
<li><a href="../classes/Kiwi.Animations.Tween.html">Kiwi.Animations.Tween</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Back.html">Kiwi.Animations.Tweens.Easing.Back</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Bounce.html">Kiwi.Animations.Tweens.Easing.Bounce</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Circular.html">Kiwi.Animations.Tweens.Easing.Circular</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Cubic.html">Kiwi.Animations.Tweens.Easing.Cubic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Elastic.html">Kiwi.Animations.Tweens.Easing.Elastic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Exponential.html">Kiwi.Animations.Tweens.Easing.Exponential</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Linear.html">Kiwi.Animations.Tweens.Easing.Linear</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quadratic.html">Kiwi.Animations.Tweens.Easing.Quadratic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quartic.html">Kiwi.Animations.Tweens.Easing.Quartic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Quintic.html">Kiwi.Animations.Tweens.Easing.Quintic</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.Easing.Sinusoidal.html">Kiwi.Animations.Tweens.Easing.Sinusoidal</a></li>
<li><a href="../classes/Kiwi.Animations.Tweens.TweenManager.html">Kiwi.Animations.Tweens.TweenManager</a></li>
<li><a href="../classes/Kiwi.Camera.html">Kiwi.Camera</a></li>
<li><a href="../classes/Kiwi.CameraManager.html">Kiwi.CameraManager</a></li>
<li><a href="../classes/Kiwi.Component.html">Kiwi.Component</a></li>
<li><a href="../classes/Kiwi.ComponentManager.html">Kiwi.ComponentManager</a></li>
<li><a href="../classes/Kiwi.Components.AnimationManager.html">Kiwi.Components.AnimationManager</a></li>
<li><a href="../classes/Kiwi.Components.ArcadePhysics.html">Kiwi.Components.ArcadePhysics</a></li>
<li><a href="../classes/Kiwi.Components.Box.html">Kiwi.Components.Box</a></li>
<li><a href="../classes/Kiwi.Components.Input.html">Kiwi.Components.Input</a></li>
<li><a href="../classes/Kiwi.Components.Sound.html">Kiwi.Components.Sound</a></li>
<li><a href="../classes/Kiwi.Entity.html">Kiwi.Entity</a></li>
<li><a href="../classes/Kiwi.Files.AudioFile.html">Kiwi.Files.AudioFile</a></li>
<li><a href="../classes/Kiwi.Files.DataFile.html">Kiwi.Files.DataFile</a></li>
<li><a href="../classes/Kiwi.Files.DataLibrary.html">Kiwi.Files.DataLibrary</a></li>
<li><a href="../classes/Kiwi.Files.File.html">Kiwi.Files.File</a></li>
<li><a href="../classes/Kiwi.Files.FileStore.html">Kiwi.Files.FileStore</a></li>
<li><a href="../classes/Kiwi.Files.Loader.html">Kiwi.Files.Loader</a></li>
<li><a href="../classes/Kiwi.Files.TextureFile.html">Kiwi.Files.TextureFile</a></li>
<li><a href="../classes/Kiwi.Game.html">Kiwi.Game</a></li>
<li><a href="../classes/Kiwi.GameManager.html">Kiwi.GameManager</a></li>
<li><a href="../classes/Kiwi.GameObjects.Sprite.html">Kiwi.GameObjects.Sprite</a></li>
<li><a href="../classes/Kiwi.GameObjects.StaticImage.html">Kiwi.GameObjects.StaticImage</a></li>
<li><a href="../classes/Kiwi.GameObjects.TextField.html">Kiwi.GameObjects.TextField</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMap.html">Kiwi.GameObjects.Tilemap.TileMap</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayer.html">Kiwi.GameObjects.Tilemap.TileMapLayer</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayerIsometric.html">Kiwi.GameObjects.Tilemap.TileMapLayerIsometric</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileMapLayerOrthogonal.html">Kiwi.GameObjects.Tilemap.TileMapLayerOrthogonal</a></li>
<li><a href="../classes/Kiwi.GameObjects.Tilemap.TileType.html">Kiwi.GameObjects.Tilemap.TileType</a></li>
<li><a href="../classes/Kiwi.Geom.AABB.html">Kiwi.Geom.AABB</a></li>
<li><a href="../classes/Kiwi.Geom.Circle.html">Kiwi.Geom.Circle</a></li>
<li><a href="../classes/Kiwi.Geom.Intersect.html">Kiwi.Geom.Intersect</a></li>
<li><a href="../classes/Kiwi.Geom.IntersectResult.html">Kiwi.Geom.IntersectResult</a></li>
<li><a href="../classes/Kiwi.Geom.Line.html">Kiwi.Geom.Line</a></li>
<li><a href="../classes/Kiwi.Geom.Matrix.html">Kiwi.Geom.Matrix</a></li>
<li><a href="../classes/Kiwi.Geom.Point.html">Kiwi.Geom.Point</a></li>
<li><a href="../classes/Kiwi.Geom.Ray.html">Kiwi.Geom.Ray</a></li>
<li><a href="../classes/Kiwi.Geom.Rectangle.html">Kiwi.Geom.Rectangle</a></li>
<li><a href="../classes/Kiwi.Geom.Transform.html">Kiwi.Geom.Transform</a></li>
<li><a href="../classes/Kiwi.Geom.Vector2.html">Kiwi.Geom.Vector2</a></li>
<li><a href="../classes/Kiwi.Group.html">Kiwi.Group</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.Counter.html">Kiwi.HUD.HUDComponents.Counter</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.Time.html">Kiwi.HUD.HUDComponents.Time</a></li>
<li><a href="../classes/Kiwi.HUD.HUDComponents.WidgetInput.html">Kiwi.HUD.HUDComponents.WidgetInput</a></li>
<li><a href="../classes/Kiwi.HUD.HUDDisplay.html">Kiwi.HUD.HUDDisplay</a></li>
<li><a href="../classes/Kiwi.HUD.HUDManager.html">Kiwi.HUD.HUDManager</a></li>
<li><a href="../classes/Kiwi.HUD.HUDWidget.html">Kiwi.HUD.HUDWidget</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Bar.html">Kiwi.HUD.Widget.Bar</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.BasicScore.html">Kiwi.HUD.Widget.BasicScore</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Button.html">Kiwi.HUD.Widget.Button</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Icon.html">Kiwi.HUD.Widget.Icon</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.IconBar.html">Kiwi.HUD.Widget.IconBar</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Menu.html">Kiwi.HUD.Widget.Menu</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.MenuItem.html">Kiwi.HUD.Widget.MenuItem</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.TextField.html">Kiwi.HUD.Widget.TextField</a></li>
<li><a href="../classes/Kiwi.HUD.Widget.Time.html">Kiwi.HUD.Widget.Time</a></li>
<li><a href="../classes/Kiwi.IChild.html">Kiwi.IChild</a></li>
<li><a href="../classes/Kiwi.Input.Finger.html">Kiwi.Input.Finger</a></li>
<li><a href="../classes/Kiwi.Input.InputManager.html">Kiwi.Input.InputManager</a></li>
<li><a href="../classes/Kiwi.Input.Key.html">Kiwi.Input.Key</a></li>
<li><a href="../classes/Kiwi.Input.Keyboard.html">Kiwi.Input.Keyboard</a></li>
<li><a href="../classes/Kiwi.Input.Keycodes.html">Kiwi.Input.Keycodes</a></li>
<li><a href="../classes/Kiwi.Input.Mouse.html">Kiwi.Input.Mouse</a></li>
<li><a href="../classes/Kiwi.Input.MouseCursor.html">Kiwi.Input.MouseCursor</a></li>
<li><a href="../classes/Kiwi.Input.Pointer.html">Kiwi.Input.Pointer</a></li>
<li><a href="../classes/Kiwi.Input.Touch.html">Kiwi.Input.Touch</a></li>
<li><a href="../classes/Kiwi.PluginManager.html">Kiwi.PluginManager</a></li>
<li><a href="../classes/Kiwi.Renderers.CanvasRenderer.html">Kiwi.Renderers.CanvasRenderer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLArrayBuffer.html">Kiwi.Renderers.GLArrayBuffer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLBlendMode.html">Kiwi.Renderers.GLBlendMode</a></li>
<li><a href="../classes/Kiwi.Renderers.GLElementArrayBuffer.html">Kiwi.Renderers.GLElementArrayBuffer</a></li>
<li><a href="../classes/Kiwi.Renderers.GLRenderManager.html">Kiwi.Renderers.GLRenderManager</a></li>
<li><a href="../classes/Kiwi.Renderers.GLTextureManager.html">Kiwi.Renderers.GLTextureManager</a></li>
<li><a href="../classes/Kiwi.Renderers.GLTextureWrapper.html">Kiwi.Renderers.GLTextureWrapper</a></li>
<li><a href="../classes/Kiwi.Renderers.Renderer.html">Kiwi.Renderers.Renderer</a></li>
<li><a href="../classes/Kiwi.Renderers.TextureAtlasRenderer.html">Kiwi.Renderers.TextureAtlasRenderer</a></li>
<li><a href="../classes/Kiwi.Shaders.ShaderManager.html">Kiwi.Shaders.ShaderManager</a></li>
<li><a href="../classes/Kiwi.Shaders.ShaderPair.html">Kiwi.Shaders.ShaderPair</a></li>
<li><a href="../classes/Kiwi.Shaders.TextureAtlasShader.html">Kiwi.Shaders.TextureAtlasShader</a></li>
<li><a href="../classes/Kiwi.Signal.html">Kiwi.Signal</a></li>
<li><a href="../classes/Kiwi.SignalBinding.html">Kiwi.SignalBinding</a></li>
<li><a href="../classes/Kiwi.Sound.Audio.html">Kiwi.Sound.Audio</a></li>
<li><a href="../classes/Kiwi.Sound.AudioLibrary.html">Kiwi.Sound.AudioLibrary</a></li>
<li><a href="../classes/Kiwi.Sound.AudioManager.html">Kiwi.Sound.AudioManager</a></li>
<li><a href="../classes/Kiwi.Stage.html">Kiwi.Stage</a></li>
<li><a href="../classes/Kiwi.State.html">Kiwi.State</a></li>
<li><a href="../classes/Kiwi.StateConfig.html">Kiwi.StateConfig</a></li>
<li><a href="../classes/Kiwi.StateManager.html">Kiwi.StateManager</a></li>
<li><a href="../classes/Kiwi.System.Bootstrap.html">Kiwi.System.Bootstrap</a></li>
<li><a href="../classes/Kiwi.System.Device.html">Kiwi.System.Device</a></li>
<li><a href="../classes/Kiwi.Textures.SingleImage.html">Kiwi.Textures.SingleImage</a></li>
<li><a href="../classes/Kiwi.Textures.SpriteSheet.html">Kiwi.Textures.SpriteSheet</a></li>
<li><a href="../classes/Kiwi.Textures.TextureAtlas.html">Kiwi.Textures.TextureAtlas</a></li>
<li><a href="../classes/Kiwi.Textures.TextureLibrary.html">Kiwi.Textures.TextureLibrary</a></li>
<li><a href="../classes/Kiwi.Time.Clock.html">Kiwi.Time.Clock</a></li>
<li><a href="../classes/Kiwi.Time.ClockManager.html">Kiwi.Time.ClockManager</a></li>
<li><a href="../classes/Kiwi.Time.MasterClock.html">Kiwi.Time.MasterClock</a></li>
<li><a href="../classes/Kiwi.Time.Timer.html">Kiwi.Time.Timer</a></li>
<li><a href="../classes/Kiwi.Time.TimerEvent.html">Kiwi.Time.TimerEvent</a></li>
<li><a href="../classes/Kiwi.Utils.Canvas.html">Kiwi.Utils.Canvas</a></li>
<li><a href="../classes/Kiwi.Utils.Color.html">Kiwi.Utils.Color</a></li>
<li><a href="../classes/Kiwi.Utils.Common.html">Kiwi.Utils.Common</a></li>
<li><a href="../classes/Kiwi.Utils.GameMath.html">Kiwi.Utils.GameMath</a></li>
<li><a href="../classes/Kiwi.Utils.Log.html">Kiwi.Utils.Log</a></li>
<li><a href="../classes/Kiwi.Utils.RandomDataGenerator.html">Kiwi.Utils.RandomDataGenerator</a></li>
<li><a href="../classes/Kiwi.Utils.RequestAnimationFrame.html">Kiwi.Utils.RequestAnimationFrame</a></li>
<li><a href="../classes/Kiwi.Utils.Version.html">Kiwi.Utils.Version</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Animations.html">Animations</a></li>
<li><a href="../modules/Components.html">Components</a></li>
<li><a href="../modules/Easing.html">Easing</a></li>
<li><a href="../modules/Files.html">Files</a></li>
<li><a href="../modules/GameObjects.html">GameObjects</a></li>
<li><a href="../modules/Geom.html">Geom</a></li>
<li><a href="../modules/HUD.html">HUD</a></li>
<li><a href="../modules/HUDComponents.html">HUDComponents</a></li>
<li><a href="../modules/Input.html">Input</a></li>
<li><a href="../modules/Kiwi.html">Kiwi</a></li>
<li><a href="../modules/Renderers.html">Renderers</a></li>
<li><a href="../modules/Shaders.html">Shaders</a></li>
<li><a href="../modules/Sound.html">Sound</a></li>
<li><a href="../modules/System.html">System</a></li>
<li><a href="../modules/Textures.html">Textures</a></li>
<li><a href="../modules/Tilemap.html">Tilemap</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/Tweens.html">Tweens</a></li>
<li><a href="../modules/Utils.html">Utils</a></li>
<li><a href="../modules/Utils..html">Utils.</a></li>
<li><a href="../modules/Widget.html">Widget</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1 class="file-heading">File: src\render\GLRenderManager.ts</h1>
<div class="file">
<pre class="code prettyprint linenums">
/**
* @module Kiwi
* @submodule Renderers
* @main Renderers
* @namespace Kiwi.Renderers
*/
module Kiwi.Renderers {
/**
* Manages all rendering using WebGL.
* Directly manages renderer objects, including factory methods
* for their creation.
* Creates manager objects for shaders and textures.
* Manages gl state at game initialisation, at state start and end,
* and per frame.
* Runs the recursive scene graph rendering sequence every frame.
* @class GLRenderManager
* @extends IRenderer
* @constructor
* @param game {Kiwi.Game} The game that this renderer belongs to.
* @return {Kiwi.Renderers.GLRenderManager}
*/
export class GLRenderManager implements IRenderManager {
constructor(game: Kiwi.Game) {
this._game = game;
this._currentBlendMode = new Kiwi.Renderers.GLBlendMode(this._game.stage.gl, {mode:"DEFAULT"} );
}
/**
* Initialises all WebGL rendering services
* @method boot
* @public
*/
public boot() {
this._textureManager = new GLTextureManager();
this._shaderManager = new Kiwi.Shaders.ShaderManager();
//this.filters = new Kiwi.Filters.GLFilterManager(this._game, this._shaderManager);
this._init();
}
/**
* The type of object that this is.
* @method objType
* @return {string} "GLRenderManager"
* @public
*/
public objType() {
return "GLRenderManager";
}
/**
* The game that this renderer is used with.
* @property _game
* @type Game
* @private
*/
private _game: Kiwi.Game;
/**
* The texture manager object used to allocate GL Textures.
* @property _textureManager
* @type Kiwi.Renderes.GLTextureManager
* @private
*/
private _textureManager: GLTextureManager;
/**
* The shader manager object used to allocate GL Shaders.
* @property _shaderManager
* @type Kiwi.Renderes.GLShaderManager
* @private
*/
private _shaderManager: Kiwi.Shaders.ShaderManager;
//public filters: Kiwi.Filters.GLFilterManager;
/**
* The stage resolution in pixels
* @property _stageResolution
* @type Float32Array
* @private
*/
private _stageResolution: Float32Array;
/**
* The renderer object that is in use during a rendering batch.
* @property _currentRenderer
* @type Kiwi.Renderers.Renderer
* @private
*/
private _currentRenderer: Renderer = null;
/**
* The current blend mode.
* @property _currentBlendMode
* @type Kiwi.Renderers.GLBlendMode
* @private
* @since 1.1.0
*/
private _currentBlendMode: GLBlendMode;
/**
* Tally of number of entities rendered per frame
* @property _entityCount
* @type number
* @default 0
* @private
*/
private _entityCount: number = 0;
/**
* Tally of number of draw calls per frame
* @property numDrawCalls
* @type number
* @default 0
* @public
*/
public numDrawCalls: number = 0;
/**
* Maximum allowable sprites to render per frame.
* Note: Not currently used - candidate for deletion
* @property _maxItems
* @type number
* @default 1000
* @private
*/
private _maxItems: number = 1000;
/**
* Camera matrix used on graphics card
* @property camMatrix
* @type Float32Array
* @public
*/
public camMatrix: Float32Array;
/**
* Geometry data used to create `camMatrix`
* @property _camMatrixOffset
* @type Kiwi.Geom.Matrix
* @private
*/
private _camMatrixOffset: Kiwi.Geom.Matrix;
/**
* The most recently bound texture atlas.
* @property _currentTextureAtlas
* @type TextureAtlas
* @private
*/
private _currentTextureAtlas: Kiwi.Textures.TextureAtlas = null;
/**
* Adds a texture to the Texture Manager.
* @method addTexture
* @param {WebGLRenderingContext} gl
* @param {Kiwi.Textures.TextureAtlas} atlas
* @public
*/
public addTexture(gl: WebGLRenderingContext, atlas: Kiwi.Textures.TextureAtlas) {
this._textureManager.uploadTexture(gl, atlas);
}
/**
* An array of renderers.
*
* Shared renderers are used for batch rendering.
* Multiple gameobjects can use the same renderer instance and add
* rendering info to a batch rather than rendering individually.
* This means only one draw call is necessary to render a number of
* objects. The most common use of this is standard 2d sprite rendering,
* and the TextureAtlasRenderer is added by default as a shared
* renderer. Sprites, StaticImages and Tilemaps (core gameobjects)
* can all use the same renderer/shader combination and be drawn as
* part of the same batch.
*
* Custom gameobjects can also choose to use a shared renderer, fo example in the case that a custom gameobject's rendering requirements matched the TextureAtlasRenderer
* capabilities.
*
* @property _sharedRenderers
* @type Array
* @private
*/
private _sharedRenderers: any = {};
/**
* Adds a renderer to the sharedRenderer array.
*
* The rendererID is a string that must match a renderer property
* of the Kiwi.Renderers object. If a match is found and an instance
* does not already exist, then a renderer is instantiated and added
* to the array.
* @method addSharedRenderer
* @param {string} rendererID
* @param {object} params
* @return {boolean} success
* @public
*/
public addSharedRenderer(rendererID:string,params:any = null):boolean {
//does renderer exist?
if (Kiwi.Renderers[rendererID]) {
//already added?
if (!(rendererID in this._sharedRenderers)) {
this._sharedRenderers[rendererID] = new Kiwi.Renderers[rendererID](this._game.stage.gl,this._shaderManager,params);
return true;
}
}
return false;
}
/**
* Adds a cloned renderer to the sharedRenderer array.
* The rendererID is a string that must match a renderer property of
* the Kiwi.Renderers object. The cloneID is the name for the
* cloned renderer.
*
* If a match is found and an instance does not already exist,
* then a renderer is instantiated and added to the array.
*
* Cloned shared renderers are useful if some items in your scene
* will use a special shader or blend mode, but others will not.
* You can subsequently access the clones with a normal
* `requestSharedRenderer()` call. You should use this instead of
* `requestRendererInstance()` whenever possible, because shared
* renderers are more efficient than instances.
*
* @method addSharedRendererClone
* @param {string} rendererID
* @param {string} cloneID
* @param {object} params
* @return {boolean} success
* @public
* @since 1.1.0
*/
public addSharedRendererClone(rendererID: string, cloneID: string, params: any = null): boolean {
if (typeof params === "undefined") { params = null; }
//does renderer exist?
if (Kiwi.Renderers[rendererID]) {
//already added?
if (!(cloneID in this._sharedRenderers)) {
this._sharedRenderers[cloneID] = new Kiwi.Renderers[rendererID](this._game.stage.gl, this._shaderManager, params);
return true;
}
}
return false;
}
/**
* Requests a shared renderer. A game object that wants to use a shared
* renderer uses this method to obtain a reference to the shared
* renderer instance.
* @method requestSharedRenderer
* @param {string} rendererID
* @param {object} params
* @return {Kiwi.Renderers.Renderer} A shared renderer
* or null if none found.
* @public
*/
public requestSharedRenderer(rendererID: string,params:any = null): Kiwi.Renderers.Renderer {
var renderer: Kiwi.Renderers.Renderer = this._sharedRenderers[rendererID];
if (renderer) {
return renderer;
} else {
if (this.addSharedRenderer(rendererID,params)) {
return this._sharedRenderers[rendererID];
} else {
Kiwi.Log.log("No renderer called " + rendererID, '#renderer', '#webgl');
}
}
//failed request
return null;
}
/**
* Requests a new renderer instance. This factory method is the only
* way gameobjects should instantiate their own renderer.
*
* The rendererID is a string that must match a renderer property
* of the Kiwi.Renderers object. If a match is found then a renderer
* is instantiated and returned. Gameobjects which have rendering
* requirements that do not suit batch rendering use this technique.
* @method requestRendererInstance
* @param {string} rendererID The name of the requested renderer
* @param {object} params
* @return {Kiwi.Renderers.Renderer} A renderer or null if none found.
* @public
*/
public requestRendererInstance(rendererID: string, params: any = null): Kiwi.Renderers.Renderer {
if (rendererID in Kiwi.Renderers) {
var renderer = new Kiwi.Renderers[rendererID](this._game.stage.gl, this._shaderManager, params);
return renderer
} else {
Kiwi.Log.log("No renderer with id " + rendererID + " exists", '#renderer', '#webgl');
}
return null; //fail
}
/*
public get filtersEnabled(): boolean {
return this._filtersEnabled;
}
public set filtersEnabled(val: boolean) {
this._filtersEnabled = val;
}
private _filtersEnabled: boolean = false;
/**
* Performs initialisation required for single game instance -
* happens once, at bootup. Sets global GL state.
* Initialises managers for shaders and textures.
* Instantiates the default shared renderer (`TextureAtlasRenderer`)
* @method _init
* @private
*/
private _init() {
Kiwi.Log.log("Initialising WebGL", '#renderer', '#webgl');
var gl: WebGLRenderingContext = this._game.stage.gl;
//init stage and viewport
this._stageResolution = new Float32Array([this._game.stage.width, this._game.stage.height]);
// Manually override scaling under CocoonJS
if( this._game.deviceTargetOption === Kiwi.TARGET_COCOON ) {
this.scaleViewport( gl, this._game.stage.scaleType, window.innerWidth, window.innerHeight );
}
else {
this.scaleViewport( gl, Kiwi.Stage.SCALE_NONE, this._game.stage.width, this._game.stage.height );
}
//set default gl state
gl.enable(gl.BLEND);
this._switchBlendMode(gl, this._currentBlendMode);
//shader manager
this._shaderManager.init(gl, "TextureAtlasShader");
//camera matrix
this.camMatrix = new Float32Array( [ 1, 0, 0, 0, 1, 0, 0, 0, 1 ] );
this._camMatrixOffset = new Kiwi.Geom.Matrix();
//stage res needs update on stage resize
this._game.stage.onResize.add(function (width, height) {
this._stageResolution = new Float32Array([width, height]);
if (this.currentRenderer) this._currentRenderer.updateStageResolution(gl, this._stageResolution);
//this.filters.updateFilterResolution(gl,width, height);
// Manually override scaling under CocoonJS
if( this._game.deviceTargetOption === Kiwi.TARGET_COCOON ) {
this.scaleViewport( gl, this._game.stage.scaleType, window.innerWidth, window.innerHeight );
}
else {
this.scaleViewport( gl, Kiwi.Stage.SCALE_NONE, width, height );
}
},this);
/* if (this.filtersEnabled && !this.filters.isEmpty) {
this.filters.enableFrameBuffers(gl);
}*/
}
/**
* Scales the viewport according to a scale mode and space dimensions.
*
* This is used internally for compatibility with CocoonJS and should not be called.
* @method scaleViewport
* @param gl {WebGLRenderingContext}
* @param mode {number} Scale mode; should be either
* Kiwi.Stage.SCALE_FIT, Kiwi.Stage.SCALE_STRETCH, or
* Kiwi.Stage.SCALE_NONE. Defaults to Kiwi.Stage.SCALE_NONE
* @param width {number} Width of the target space
* @param height {number} Height of the target space
* @public
* @since 1.1.1
*/
public scaleViewport( gl:WebGLRenderingContext, mode:number, width:number, height:number ) {
var offset = new Kiwi.Geom.Point(0, 0);
switch( mode ) {
case Kiwi.Stage.SCALE_FIT:
// Compute aspect ratios
var arStage = this._game.stage.width / this._game.stage.height;
var arSpace = width / height;
if(arStage < arSpace) {
// Width is too wide
var newWidth = height * arStage;
offset.x = (width - newWidth) / 2;
// Compress target space
width = newWidth;
}
else {
// Height is too wide
var newHeight = width / arStage;
offset.y = (height - newHeight) / 2;
// Compress target space
height = newHeight;
}
break;
case Kiwi.Stage.SCALE_STRETCH:
break;
case Kiwi.Stage.SCALE_NONE:
width = this._game.stage.width;
height = this._game.stage.height;
break;
default:
break;
}
gl.viewport(offset.x, offset.y, width, height);
}
/**
* Performs initialisation required when switching to a different state.
* Called when a state has been switched to.
* The textureManager is told to clear its contents from video memory,
* then rebuild its cache of textures from the state's texture library.
* @method initState
* @public
*/
public initState(state: Kiwi.State) {
this._textureManager.clearTextures(this._game.stage.gl);
this._textureManager.uploadTextureLibrary(this._game.stage.gl, state.textureLibrary);
}
/**
* Performs cleanup required before switching to a different state.
* Called whwn a state is about to be switched from.
* The textureManager is told to empty its cache.
* @method endState
* @param state {Kiwi.State}
* @public
*/
public endState(state: Kiwi.State) {
this._textureManager.clearTextures(this._game.stage.gl);
Kiwi.Log.log("Ending WebGL on State", '#renderer', '#webgl');
}
/**
* Manages rendering of the scene graph - called once per frame.
* Sets up per frame gl uniforms such as the view matrix and
* camera offset. Clears the current renderer ready for a new batch.
* Initiates recursive render of scene graph starting at the root.
* @method render
* @param camera {Camera}
* @public
*/
public render(camera: Kiwi.Camera) {
var gl: WebGLRenderingContext = this._game.stage.gl;
//clear stage every frame
var col = this._game.stage.normalizedColor;
// Colour must be multiplied by alpha to create consistent results.
// This is probably due to browsers implementing an inferior
// blendfunc: ONE, ONE_MINUS_SRC_ALPHA is most common, and gives
// bad results with alphas. When this is used on a partially
// transparent game canvas, it does not blend correctly.
// Without being able to override the browser's own object renderer,
// this is a necessary kludge. The "clean" solution is as follows:
// gl.clearColor(col.r, col.g, col.b, col.a);
gl.clearColor(col.r * col.a, col.g * col.a, col.b * col.a, col.a);
gl.clear(gl.COLOR_BUFFER_BIT);
// Reset current renderer.
// This prevents runtime created shaders from being uploaded
// and the render manager failing to notice, causing crashes.
this._currentRenderer = null;
// Stop drawing if there is nothing to draw
if (this._game.states.current.members.length == 0) {
return;
}
// Reset stats
this.numDrawCalls = 0;
this._textureManager.numTextureWrites = 0;
this._entityCount = 0;
// Set cam matrix uniform
var cm: Kiwi.Geom.Matrix = camera.transform.getConcatenatedMatrix();
var ct: Kiwi.Geom.Transform = camera.transform;
this._camMatrixOffset.identity();
this._camMatrixOffset.translate(
-ct.anchorPointX, -ct.anchorPointY );
this._camMatrixOffset.prependMatrix( cm );
// Overwrite cam matrix properties rather than recreating matrix.
// This is necessary to keep the cam matrix synchronised
// with other renderers: if there is only one render batch,
// then `enable` will only pass the cam matrix on the first frame,
// and subsequent camera movements will not be passed to the shader.
this.camMatrix[ 0 ] = this._camMatrixOffset.a;
this.camMatrix[ 1 ] = this._camMatrixOffset.b;
this.camMatrix[ 3 ] = this._camMatrixOffset.c;
this.camMatrix[ 4 ] = this._camMatrixOffset.d;
this.camMatrix[ 6 ] = this._camMatrixOffset.tx;
this.camMatrix[ 7 ] = this._camMatrixOffset.ty;
// Mandate blend mode in CocoonJS
// This must be called per-frame, because CocoonJS seems to
// interfere with blend modes on a per-frame basis.
if( this._game.deviceTargetOption == Kiwi.TARGET_COCOON ) {
this._switchBlendMode( gl, this._currentBlendMode );
}
this.collateRenderSequence();
this.collateBatches();
this.renderBatches(gl, camera);
/*if (this._filtersEnabled && !this.filters.isEmpty) {
this.filters.applyFilters(gl);
gl.useProgram(this._shaderManager.currentShader.shaderProgram);
gl.bindTexture(gl.TEXTURE_2D, this._currentTextureAtlas.glTextureWrapper.texture);
}*/
}
private _sequence: any[];
private _batches: any[];
/**
* Creates a new render sequence
* @method collateRenderSequence
* @public
*/
public collateRenderSequence() {
this._sequence = [];
var root: IChild = this._game.states.current;
this.collateChild(root);
}
/**
* Adds a child to the render sequence
* (may be a group with children of its own).
* @method collateChild
* @public
*/
public collateChild(child:IChild) {
// Do not render non-visible objects or their children
if( !child.visible) return;
if (child.childType() === Kiwi.GROUP) {
for (var i = 0; i < (<Kiwi.Group>child).members.length; i++) {
this.collateChild( (<Kiwi.Group>child).members[i]);
}
} else {
var entity: Entity = <Entity>child;
this._sequence.push({
entity: entity,
renderer: entity.glRenderer,
shader: entity.glRenderer.shaderPair,
isBatchRenderer: entity.glRenderer.isBatchRenderer,
texture: entity.atlas
});
}
}
/**
* Sorts the render sequence into batches.
* Each batch requires the same renderer/shader/texture combination.
* @method collateBatches
* @public
*/
public collateBatches() {
var currentRenderer: Renderer = null;
var currentShader: Shaders.ShaderPair = null;
var currentTexture: Textures.TextureAtlas = null;
this._batches = [];
var batchIndex:number;
for (var i = 0; i < this._sequence.length; i++) {
if (!this._sequence[i].isBatchRenderer ||
this._sequence[i].renderer !== currentRenderer ||
this._sequence[i].shader !== currentShader ||
this._sequence[i].texture !== currentTexture) {
//create a new batch
var batchIndex = this._batches.push(new Array()) - 1;
currentRenderer = this._sequence[i].renderer;
currentShader = this._sequence[i].shader;
currentTexture = this._sequence[i].texture;
}
this._batches[batchIndex].push(this._sequence[i]);
}
}
/**
* Renders all the batches
* @method renderBatches
* @param {WebGLRenderingContext} gl
* @param {Kiwi.Camera} camera
* @public
*/
public renderBatches(gl: WebGLRenderingContext, camera) {
for (var i = 0; i < this._batches.length; i++)
this.renderBatch( gl, this._batches[i], camera );
}
/**
* Renders a single batch
* @method renderBatch
* @param {WebGLRenderingContext} gl
* @param {object} batch
* @param {Kiwi.Camera} camera
* @public
*/
public renderBatch(gl, batch, camera) {
// Acquire renderer
var rendererSwitched = false;
if (batch[0].entity.glRenderer !== this._currentRenderer) {
rendererSwitched = true;
this._switchRenderer(gl, batch[0].entity);
}