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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualServer" inherits="Object" category="Core" version="3.0-rc1">
<brief_description>
Server for anything visible.
</brief_description>
<description>
Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display.
The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="black_bars_set_images">
<return type="void">
</return>
<argument index="0" name="left" type="RID">
</argument>
<argument index="1" name="top" type="RID">
</argument>
<argument index="2" name="right" type="RID">
</argument>
<argument index="3" name="bottom" type="RID">
</argument>
<description>
Sets images to be rendered in the window margin.
</description>
</method>
<method name="black_bars_set_margins">
<return type="void">
</return>
<argument index="0" name="left" type="int">
</argument>
<argument index="1" name="top" type="int">
</argument>
<argument index="2" name="right" type="int">
</argument>
<argument index="3" name="bottom" type="int">
</argument>
<description>
Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered.
</description>
</method>
<method name="canvas_create">
<return type="RID">
</return>
<description>
Creates a canvas and returns the assigned [RID].
</description>
</method>
<method name="canvas_item_add_circle">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="pos" type="Vector2">
</argument>
<argument index="2" name="radius" type="float">
</argument>
<argument index="3" name="color" type="Color">
</argument>
<description>
Adds a circle command to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_clip_ignore">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="ignore" type="bool">
</argument>
<description>
If ignore is [code]true[/code], the VisualServer does not perform clipping.
</description>
</method>
<method name="canvas_item_add_line">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="from" type="Vector2">
</argument>
<argument index="2" name="to" type="Vector2">
</argument>
<argument index="3" name="color" type="Color">
</argument>
<argument index="4" name="width" type="float" default="1.0">
</argument>
<argument index="5" name="antialiased" type="bool" default="false">
</argument>
<description>
Adds a line command to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_mesh">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="mesh" type="RID">
</argument>
<argument index="2" name="skeleton" type="RID">
</argument>
<description>
Adds a [Mesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment.
</description>
</method>
<method name="canvas_item_add_multimesh">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="mesh" type="RID">
</argument>
<argument index="2" name="skeleton" type="RID">
</argument>
<description>
Adds a [MultiMesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment.
</description>
</method>
<method name="canvas_item_add_nine_patch">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<argument index="2" name="source" type="Rect2">
</argument>
<argument index="3" name="texture" type="RID">
</argument>
<argument index="4" name="topleft" type="Vector2">
</argument>
<argument index="5" name="bottomright" type="Vector2">
</argument>
<argument index="6" name="x_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0">
</argument>
<argument index="7" name="y_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0">
</argument>
<argument index="8" name="draw_center" type="bool" default="true">
</argument>
<argument index="9" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="10" name="normal_map" type="RID">
</argument>
<description>
Adds a nine patch image to the [CanvasItem]'s draw commands.
See [NinePatchRect] for more explanation.
</description>
</method>
<method name="canvas_item_add_particles">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="particles" type="RID">
</argument>
<argument index="2" name="texture" type="RID">
</argument>
<argument index="3" name="normal_map" type="RID">
</argument>
<argument index="4" name="h_frames" type="int">
</argument>
<argument index="5" name="v_frames" type="int">
</argument>
<description>
Adds a particles system to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_polygon">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="points" type="PoolVector2Array">
</argument>
<argument index="2" name="colors" type="PoolColorArray">
</argument>
<argument index="3" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
</argument>
<argument index="4" name="texture" type="RID">
</argument>
<argument index="5" name="normal_map" type="RID">
</argument>
<argument index="6" name="antialiased" type="bool" default="false">
</argument>
<description>
Adds a polygon to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_polyline">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="points" type="PoolVector2Array">
</argument>
<argument index="2" name="colors" type="PoolColorArray">
</argument>
<argument index="3" name="width" type="float" default="1.0">
</argument>
<argument index="4" name="antialiased" type="bool" default="false">
</argument>
<description>
Adds a polyline, which is a line from mutliple points with a width, to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_primitive">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="points" type="PoolVector2Array">
</argument>
<argument index="2" name="colors" type="PoolColorArray">
</argument>
<argument index="3" name="uvs" type="PoolVector2Array">
</argument>
<argument index="4" name="texture" type="RID">
</argument>
<argument index="5" name="width" type="float" default="1.0">
</argument>
<argument index="6" name="normal_map" type="RID">
</argument>
<description>
Adds a primitive to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_rect">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<description>
Adds a rectangle to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_set_transform">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description>
Adds a [Transform2D] command to the [CanvasItem]'s draw commands.
This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item.
</description>
</method>
<method name="canvas_item_add_texture_rect">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<argument index="2" name="texture" type="RID">
</argument>
<argument index="3" name="tile" type="bool" default="false">
</argument>
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="5" name="transpose" type="bool" default="false">
</argument>
<argument index="6" name="normal_map" type="RID">
</argument>
<description>
Adds a textured rect to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_texture_rect_region">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<argument index="2" name="texture" type="RID">
</argument>
<argument index="3" name="src_rect" type="Rect2">
</argument>
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="5" name="transpose" type="bool" default="false">
</argument>
<argument index="6" name="normal_map" type="RID">
</argument>
<argument index="7" name="clip_uv" type="bool" default="true">
</argument>
<description>
Adds a texture rect with region setting to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_add_triangle_array">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="indices" type="PoolIntArray">
</argument>
<argument index="2" name="points" type="PoolVector2Array">
</argument>
<argument index="3" name="colors" type="PoolColorArray">
</argument>
<argument index="4" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
</argument>
<argument index="5" name="texture" type="RID">
</argument>
<argument index="6" name="count" type="int" default="-1">
</argument>
<argument index="7" name="normal_map" type="RID">
</argument>
<description>
Adds a triangle array to the [CanvasItem]'s draw commands.
</description>
</method>
<method name="canvas_item_clear">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<description>
Clears the [CanvasItem] and removes all commands in it.
</description>
</method>
<method name="canvas_item_create">
<return type="RID">
</return>
<description>
Creates a new [CanvasItem] and returns its [RID].
</description>
</method>
<method name="canvas_item_set_clip">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="clip" type="bool">
</argument>
<description>
Sets clipping for the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_copy_to_backbuffer">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<argument index="2" name="rect" type="Rect2">
</argument>
<description>
Sets the [CanvasItem] to copy a rect to the backbuffer.
</description>
</method>
<method name="canvas_item_set_custom_rect">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="use_custom_rect" type="bool">
</argument>
<argument index="2" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )">
</argument>
<description>
Defines a custom drawing rectangle for the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_distance_field_mode">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="canvas_item_set_draw_behind_parent">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Sets [CanvasItem] to be drawn behind its parent.
</description>
</method>
<method name="canvas_item_set_draw_index">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="index" type="int">
</argument>
<description>
Sets the index for the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_light_mask">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="mask" type="int">
</argument>
<description>
The light mask. See [LightOccluder2D] for more information on light masks.
</description>
</method>
<method name="canvas_item_set_material">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="material" type="RID">
</argument>
<description>
Sets a new material to the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_modulate">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the color that modulates the [CanvasItem] and its children.
</description>
</method>
<method name="canvas_item_set_parent">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="parent" type="RID">
</argument>
<description>
Sets the parent for the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_self_modulate">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the color that modulates the [CanvasItem] without children.
</description>
</method>
<method name="canvas_item_set_sort_children_by_y">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Sets if [CanvasItem]'s children should be sorted by y-position.
</description>
</method>
<method name="canvas_item_set_transform">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description>
Sets the [CanvasItem]'s [Transform2D].
</description>
</method>
<method name="canvas_item_set_use_parent_material">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Sets if the [CanvasItem] uses its parent's material.
</description>
</method>
<method name="canvas_item_set_visible">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="visible" type="bool">
</argument>
<description>
Sets if the canvas item (including its children) is visible.
</description>
</method>
<method name="canvas_item_set_z_as_relative_to_parent">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
If this is enabled, the z-index of the parent will be added to the children's z-index.
</description>
</method>
<method name="canvas_item_set_z_index">
<return type="void">
</return>
<argument index="0" name="item" type="RID">
</argument>
<argument index="1" name="z_index" type="int">
</argument>
<description>
Sets the [CanvasItem]'s z-index, i.e. its draw order (lower indexes are drawn first).
</description>
</method>
<method name="canvas_light_attach_to_canvas">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="canvas" type="RID">
</argument>
<description>
Attaches the canvas light to the canvas. Removes it from its previous canvas.
</description>
</method>
<method name="canvas_light_create">
<return type="RID">
</return>
<description>
Creates a canvas light.
</description>
</method>
<method name="canvas_light_occluder_attach_to_canvas">
<return type="void">
</return>
<argument index="0" name="occluder" type="RID">
</argument>
<argument index="1" name="canvas" type="RID">
</argument>
<description>
Attaches a light occluder to the canvas. Removes it from its previous canvas.
</description>
</method>
<method name="canvas_light_occluder_create">
<return type="RID">
</return>
<description>
Creates a light occluder.
</description>
</method>
<method name="canvas_light_occluder_set_enabled">
<return type="void">
</return>
<argument index="0" name="occluder" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Enables or disables light occluder.
</description>
</method>
<method name="canvas_light_occluder_set_light_mask">
<return type="void">
</return>
<argument index="0" name="occluder" type="RID">
</argument>
<argument index="1" name="mask" type="int">
</argument>
<description>
The light mask. See [LightOccluder2D] for more information on light masks
</description>
</method>
<method name="canvas_light_occluder_set_polygon">
<return type="void">
</return>
<argument index="0" name="occluder" type="RID">
</argument>
<argument index="1" name="polygon" type="RID">
</argument>
<description>
Sets a light occluder's polygon.
</description>
</method>
<method name="canvas_light_occluder_set_transform">
<return type="void">
</return>
<argument index="0" name="occluder" type="RID">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description>
Sets a light occluder's [Transform2D].
</description>
</method>
<method name="canvas_light_set_color">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the color for a light.
</description>
</method>
<method name="canvas_light_set_enabled">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Enables or disables a canvas light.
</description>
</method>
<method name="canvas_light_set_energy">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="energy" type="float">
</argument>
<description>
Sets a canvas light's energy.
</description>
</method>
<method name="canvas_light_set_height">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="height" type="float">
</argument>
<description>
Sets a canvas light's height.
</description>
</method>
<method name="canvas_light_set_item_cull_mask">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="mask" type="int">
</argument>
<description>
The light mask. See [LightOccluder2D] for more information on light masks
</description>
</method>
<method name="canvas_light_set_item_shadow_cull_mask">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="mask" type="int">
</argument>
<description>
The shadow mask. binary about wich layers this canvas light affects wich canvas item's shadows. See [LightOccluder2D] for more information on light masks.
</description>
</method>
<method name="canvas_light_set_layer_range">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="min_layer" type="int">
</argument>
<argument index="2" name="max_layer" type="int">
</argument>
<description>
The layer range that gets rendered with this light.
</description>
</method>
<method name="canvas_light_set_mode">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode">
</argument>
<description>
The mode of the light, see CANVAS_LIGHT_MODE_* constants.
</description>
</method>
<method name="canvas_light_set_scale">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="scale" type="float">
</argument>
<description>
</description>
</method>
<method name="canvas_light_set_shadow_buffer_size">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="size" type="int">
</argument>
<description>
Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
</description>
</method>
<method name="canvas_light_set_shadow_color">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the color of the canvas light's shadow.
</description>
</method>
<method name="canvas_light_set_shadow_enabled">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Enables or disables the canvas light's shadow.
</description>
</method>
<method name="canvas_light_set_shadow_filter">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter">
</argument>
<description>
Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER_* constants.
</description>
</method>
<method name="canvas_light_set_shadow_gradient_length">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="length" type="float">
</argument>
<description>
Sets the length of the shadow's gradient.
</description>
</method>
<method name="canvas_light_set_shadow_smooth">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="smooth" type="float">
</argument>
<description>
Smoothens the shadow. The lower, the more smooth.
</description>
</method>
<method name="canvas_light_set_texture">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="texture" type="RID">
</argument>
<description>
</description>
</method>
<method name="canvas_light_set_texture_offset">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="offset" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="canvas_light_set_transform">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description>
Sets the canvas light's [Transform2D].
</description>
</method>
<method name="canvas_light_set_z_range">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="min_z" type="int">
</argument>
<argument index="2" name="max_z" type="int">
</argument>
<description>
</description>
</method>
<method name="canvas_occluder_polygon_create">
<return type="RID">
</return>
<description>
Creates a new light occluder polygon.
</description>
</method>
<method name="canvas_occluder_polygon_set_cull_mode">
<return type="void">
</return>
<argument index="0" name="occluder_polygon" type="RID">
</argument>
<argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode">
</argument>
<description>
Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE_* constants.
</description>
</method>
<method name="canvas_occluder_polygon_set_shape">
<return type="void">
</return>
<argument index="0" name="occluder_polygon" type="RID">
</argument>
<argument index="1" name="shape" type="PoolVector2Array">
</argument>
<argument index="2" name="closed" type="bool">
</argument>
<description>
Sets the shape of the occluder polygon.
</description>
</method>
<method name="canvas_occluder_polygon_set_shape_as_lines">
<return type="void">
</return>
<argument index="0" name="occluder_polygon" type="RID">
</argument>
<argument index="1" name="shape" type="PoolVector2Array">
</argument>
<description>
Sets the shape of the occluder polygon as lines.
</description>
</method>
<method name="canvas_set_item_mirroring">
<return type="void">
</return>
<argument index="0" name="canvas" type="RID">
</argument>
<argument index="1" name="item" type="RID">
</argument>
<argument index="2" name="mirroring" type="Vector2">
</argument>
<description>
A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2].
</description>
</method>
<method name="canvas_set_modulate">
<return type="void">
</return>
<argument index="0" name="canvas" type="RID">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Modulates all colors in the given canvas.
</description>
</method>
<method name="draw">
<return type="void">
</return>
<argument index="0" name="swap_buffers" type="bool" default="true">
</argument>
<description>
Draws a frame.
</description>
</method>
<method name="finish">
<return type="void">
</return>
<description>
Removes buffers and clears testcubes.
</description>
</method>
<method name="force_draw">
<return type="void">
</return>
<argument index="0" name="swap_buffers" type="bool" default="true">
</argument>
<description>
Draws a frame. Same as [method draw].
</description>
</method>
<method name="force_sync">
<return type="void">
</return>
<description>
Syncronizes threads.
</description>
</method>
<method name="free">
<return type="void">
</return>
<argument index="0" name="rid" type="RID">
</argument>
<description>
Tries to free an object in the VisualServer.
</description>
</method>
<method name="get_render_info">
<return type="int">
</return>
<argument index="0" name="info" type="int" enum="VisualServer.RenderInfo">
</argument>
<description>
Returns a certain information, see RENDER_INFO_* for options.
</description>
</method>
<method name="get_test_cube">
<return type="RID">
</return>
<description>
Returns the id of the test cube. Creates one if none exists.
</description>
</method>
<method name="get_test_texture">
<return type="RID">
</return>
<description>
Returns the id of the test texture. Creates one if none exists.
</description>
</method>
<method name="get_white_texture">
<return type="RID">
</return>
<description>
Returns the id of a white texture. Creates one if none exists.
</description>
</method>
<method name="has_changed" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens.
</description>
</method>
<method name="has_feature" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="feature" type="int" enum="VisualServer.Features">
</argument>
<description>
</description>
</method>
<method name="has_os_feature" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="feature" type="String">
</argument>
<description>
Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
</description>
</method>
<method name="init">
<return type="void">
</return>
<description>
Initializes the visual server.
</description>
</method>
<method name="make_sphere_mesh">
<return type="RID">
</return>
<argument index="0" name="latitudes" type="int">
</argument>
<argument index="1" name="longitudes" type="int">
</argument>
<argument index="2" name="radius" type="float">
</argument>
<description>
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
</description>
</method>
<method name="material_create">
<return type="RID">
</return>
<description>
Returns an empty material.
</description>
</method>
<method name="material_get_param" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="parameter" type="String">
</argument>
<description>
Returns the value of a certain material's parameter.
</description>
</method>
<method name="material_get_shader" qualifiers="const">
<return type="RID">
</return>
<argument index="0" name="shader_material" type="RID">
</argument>
<description>
Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
</description>
</method>
<method name="material_set_line_width">
<return type="void">
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="width" type="float">
</argument>
<description>
Sets a materials line width.
</description>
</method>
<method name="material_set_next_pass">
<return type="void">
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="next_material" type="RID">
</argument>
<description>
Sets an objects next material.
</description>
</method>
<method name="material_set_param">
<return type="void">
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="parameter" type="String">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
<description>
Sets a materials parameter.
</description>
</method>
<method name="material_set_render_priority">
<return type="void">
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="priority" type="int">
</argument>
<description>
Sets a material's render priority.
</description>
</method>
<method name="material_set_shader">
<return type="void">
</return>
<argument index="0" name="shader_material" type="RID">
</argument>
<argument index="1" name="shader" type="RID">
</argument>
<description>
Sets a shader material's shader.
</description>
</method>
<method name="mesh_add_surface_from_arrays">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="primtive" type="int" enum="VisualServer.PrimitiveType">
</argument>
<argument index="2" name="arrays" type="Array">
</argument>
<argument index="3" name="blend_shapes" type="Array" default="[ ]">
</argument>
<argument index="4" name="compress_format" type="int" default="97792">
</argument>
<description>
Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types.
</description>
</method>
<method name="mesh_clear">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<description>
Removes all surfaces from a mesh.
</description>
</method>
<method name="mesh_create">
<return type="RID">
</return>
<description>
Creates a new mesh.
</description>
</method>
<method name="mesh_get_blend_shape_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<description>
Returns a mesh's blend shape count.
</description>
</method>
<method name="mesh_get_blend_shape_mode" qualifiers="const">
<return type="int" enum="VisualServer.BlendShapeMode">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<description>
Returns a mesh's blend shape mode.
</description>
</method>
<method name="mesh_get_custom_aabb" qualifiers="const">
<return type="AABB">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<description>
Returns a mesh's custom aabb.
</description>
</method>
<method name="mesh_get_surface_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<description>
Returns a mesh's number of surfaces.
</description>
</method>
<method name="mesh_remove_surface">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="index" type="int">
</argument>
<description>
Removes a mesh's surface.
</description>
</method>
<method name="mesh_set_blend_shape_count">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="amount" type="int">
</argument>
<description>
Sets a mesh's blend shape count.
</description>
</method>
<method name="mesh_set_blend_shape_mode">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="mode" type="int" enum="VisualServer.BlendShapeMode">
</argument>
<description>
Sets a mesh's blend shape mode.
</description>
</method>
<method name="mesh_set_custom_aabb">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="aabb" type="AABB">
</argument>
<description>
Sets a mesh's custom aabb.
</description>
</method>
<method name="mesh_surface_get_aabb" qualifiers="const">
<return type="AABB">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's aabb.
</description>
</method>
<method name="mesh_surface_get_array" qualifiers="const">
<return type="PoolByteArray">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's vertex buffer.
</description>
</method>
<method name="mesh_surface_get_array_index_len" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's amount of indices.
</description>
</method>
<method name="mesh_surface_get_array_len" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's amount of vertices.
</description>
</method>
<method name="mesh_surface_get_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's buffer arrays.
</description>
</method>
<method name="mesh_surface_get_blend_shape_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's arrays for blend shapes
</description>
</method>
<method name="mesh_surface_get_format" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns the format of a mesh's surface.
</description>
</method>
<method name="mesh_surface_get_index_array" qualifiers="const">
<return type="PoolByteArray">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's index buffer.
</description>
</method>
<method name="mesh_surface_get_material" qualifiers="const">
<return type="RID">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns a mesh's surface's material.
</description>
</method>
<method name="mesh_surface_get_primitive_type" qualifiers="const">
<return type="int" enum="VisualServer.PrimitiveType">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns the primitive type of a mesh's surface.
</description>
</method>
<method name="mesh_surface_get_skeleton_aabb" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Returns the aabb of a mesh's surface's skeleton.
</description>
</method>
<method name="mesh_surface_set_material">
<return type="void">
</return>
<argument index="0" name="mesh" type="RID">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<argument index="2" name="material" type="RID">
</argument>
<description>
Sets a mesh's surface's material.
</description>
</method>
<method name="request_frame_drawn_callback">
<return type="void">
</return>
<argument index="0" name="where" type="Object">
</argument>
<argument index="1" name="method" type="String">
</argument>
<argument index="2" name="userdata" type="Variant">
</argument>
<description>
Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn.
The callback method must use only 1 argument which will be called with 'userdata'.
</description>
</method>
<method name="set_boot_image">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="scale" type="bool">
</argument>
<description>
Sets a boot image. The color defines the background color and if scale is [code]true[/code], the image will be scaled to fit the screen size.
</description>
</method>
<method name="set_debug_generate_wireframes">
<return type="void">
</return>
<argument index="0" name="generate" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_default_clear_color">
<return type="void">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="shader_create">
<return type="RID">
</return>
<description>
Creates an empty shader.
</description>
</method>
<method name="shader_get_code" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="shader" type="RID">
</argument>
<description>
Returns a shader's code.
</description>
</method>
<method name="shader_get_default_texture_param" qualifiers="const">
<return type="RID">
</return>
<argument index="0" name="shader" type="RID">
</argument>
<argument index="1" name="name" type="String">
</argument>
<description>
Returns a default texture from a shader searched by name.
</description>
</method>
<method name="shader_get_param_list" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="shader" type="RID">
</argument>
<description>
Returns the parameters of a shader.
</description>
</method>
<method name="shader_set_code">
<return type="void">
</return>
<argument index="0" name="shader" type="RID">
</argument>
<argument index="1" name="code" type="String">
</argument>
<description>
Sets a shader's code.
</description>
</method>
<method name="shader_set_default_texture_param">
<return type="void">
</return>
<argument index="0" name="shader" type="RID">
</argument>
<argument index="1" name="name" type="String">
</argument>
<argument index="2" name="texture" type="RID">
</argument>
<description>
Sets a shader's default texture. Overwrites the texture given by name.
</description>
</method>
<method name="sky_create">
<return type="RID">
</return>
<description>
Creates an empty sky.
</description>
</method>
<method name="sky_set_texture">
<return type="void">
</return>
<argument index="0" name="sky" type="RID">
</argument>
<argument index="1" name="cube_map" type="RID">
</argument>
<argument index="2" name="radiance_size" type="int">
</argument>
<description>
Sets a sky's texture.
</description>
</method>
<method name="sync">
<return type="void">
</return>
<description>
</description>
</method>
<method name="texture_allocate">
<return type="void">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<argument index="1" name="width" type="int">
</argument>
<argument index="2" name="height" type="int">
</argument>
<argument index="3" name="format" type="int" enum="Image.Format">
</argument>
<argument index="4" name="flags" type="int" default="7">
</argument>
<description>
Allocates space for a texture's image or video.
</description>
</method>
<method name="texture_create">
<return type="RID">
</return>
<description>
Creates an empty texture.
</description>
</method>
<method name="texture_create_from_image">
<return type="RID">
</return>
<argument index="0" name="image" type="Image">
</argument>
<argument index="1" name="flags" type="int" default="7">
</argument>
<description>
Creates a texture, allocates the space for an image, and fills in the image.
</description>
</method>
<method name="texture_debug_usage">
<return type="Array">
</return>
<description>
Returns a list of all the textures and their information.
</description>
</method>
<method name="texture_get_data" qualifiers="const">
<return type="Image">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0">
</argument>
<description>
Returns a copy of a texture's image unless it's a CubeMap, in wich case it returns the [RID] of the image at one of the cubes sides.
</description>
</method>
<method name="texture_get_flags" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<description>
Returns the flags of a texture.
</description>
</method>
<method name="texture_get_format" qualifiers="const">
<return type="int" enum="Image.Format">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<description>
Returns the format of the texture's image.
</description>
</method>
<method name="texture_get_height" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<description>
Returns the texture's height.
</description>
</method>
<method name="texture_get_path" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<description>
Returns the texture's path.
</description>
</method>
<method name="texture_get_texid" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<description>
Returns the opengl id of the texture's image.
</description>
</method>
<method name="texture_get_width" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<description>
Returns the texture's width.
</description>
</method>
<method name="texture_set_data">
<return type="void">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<argument index="1" name="image" type="Image">
</argument>
<argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0">
</argument>
<description>
Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.
</description>
</method>
<method name="texture_set_flags">
<return type="void">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<argument index="1" name="flags" type="int">
</argument>
<description>
Sets the texture's flags. See [enum TextureFlags] for options
</description>
</method>
<method name="texture_set_path">
<return type="void">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<argument index="1" name="path" type="String">
</argument>
<description>
Sets the texture's path.
</description>
</method>
<method name="texture_set_shrink_all_x2_on_set_data">
<return type="void">
</return>
<argument index="0" name="shrink" type="bool">
</argument>
<description>
If [code]true[/code], sets internal processes to shrink all image data to half the size.
</description>
</method>
<method name="texture_set_size_override">
<return type="void">
</return>
<argument index="0" name="texture" type="RID">
</argument>
<argument index="1" name="width" type="int">
</argument>
<argument index="2" name="height" type="int">
</argument>
<description>
Overwrites the texture's width and height.
</description>
</method>
<method name="textures_keep_original">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code], the image will be stored in the texture's images array if overwritten.
</description>
</method>
<method name="viewport_attach_camera">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="camera" type="RID">
</argument>
<description>
Sets a viewport's camera.
</description>
</method>
<method name="viewport_attach_canvas">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="canvas" type="RID">
</argument>
<description>
Sets a viewport's canvas.
</description>
</method>
<method name="viewport_attach_to_screen">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )">
</argument>
<argument index="2" name="screen" type="int" default="0">
</argument>
<description>
Attaches a viewport to a screen.
</description>
</method>
<method name="viewport_create">
<return type="RID">
</return>
<description>
Creates an empty viewport.
</description>
</method>
<method name="viewport_detach">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<description>
Detaches the viewport from the screen.
</description>
</method>
<method name="viewport_get_render_info">
<return type="int">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo">
</argument>
<description>
Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO* constants.
</description>
</method>
<method name="viewport_get_texture" qualifiers="const">
<return type="RID">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<description>
Returns the viewport's last rendered frame.
</description>
</method>
<method name="viewport_remove_canvas">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="canvas" type="RID">
</argument>
<description>
Detaches a viewport from a canvas and vice versa.
</description>
</method>
<method name="viewport_set_active">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="active" type="bool">
</argument>
<description>
If [code]true[/code], sets the viewport active, else sets it inactive.
</description>
</method>
<method name="viewport_set_canvas_layer">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="canvas" type="RID">
</argument>
<argument index="2" name="layer" type="int">
</argument>
<description>
Sets the renderlayer for a viewport's canvas.
</description>
</method>
<method name="viewport_set_canvas_transform">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="canvas" type="RID">
</argument>
<argument index="2" name="offset" type="Transform2D">
</argument>
<description>
Sets the transformation of a viewport's canvas.
</description>
</method>
<method name="viewport_set_clear_mode">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode">
</argument>
<description>
Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE_* constants for options.
</description>
</method>
<method name="viewport_set_debug_draw">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw">
</argument>
<description>
Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW_* constants for options.
</description>
</method>
<method name="viewport_set_disable_3d">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description>
If [code]true[/code] a viewport's 3D rendering should be disabled.
</description>
</method>
<method name="viewport_set_disable_environment">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description>
If [code]true[/code] rendering of a viewport's environment should be disabled.
</description>
</method>
<method name="viewport_set_global_canvas_transform">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description>
Sets the viewport's global transformation matrix.
</description>
</method>
<method name="viewport_set_hdr">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
If [code]true[/code] the viewport should render to hdr.
</description>
</method>
<method name="viewport_set_hide_canvas">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="hidden" type="bool">
</argument>
<description>
If [code]true[/code] the viewport's canvas should not be rendered.
</description>
</method>
<method name="viewport_set_hide_scenario">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="hidden" type="bool">
</argument>
<description>
</description>
</method>
<method name="viewport_set_msaa">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA">
</argument>
<description>
Sets the anti-aliasing mode. see [enum ViewportMSAA] for options.
</description>
</method>
<method name="viewport_set_parent_viewport">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="parent_viewport" type="RID">
</argument>
<description>
Sets the viewport's parent to another viewport.
</description>
</method>
<method name="viewport_set_scenario">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="scenario" type="RID">
</argument>
<description>
Sets a viewport's scenario.
The scenario contains information about the [enum ScenarioDebugMode], environment information, reflection atlas etc.
</description>
</method>
<method name="viewport_set_shadow_atlas_quadrant_subdivision">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="quadrant" type="int">
</argument>
<argument index="2" name="subdivision" type="int">
</argument>
<description>
Sets the shadow atlas quadrant's subdivision.
</description>
</method>
<method name="viewport_set_shadow_atlas_size">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="size" type="int">
</argument>
<description>
Sets the size of the shadow atlas's images.
</description>
</method>
<method name="viewport_set_size">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="width" type="int">
</argument>
<argument index="2" name="height" type="int">
</argument>
<description>
Sets the viewport's width and height.
</description>
</method>
<method name="viewport_set_transparent_background">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
If [code]true[/code] the viewport should render its background as transparent.
</description>
</method>
<method name="viewport_set_update_mode">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode">
</argument>
<description>
Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE_* constants for options.
</description>
</method>
<method name="viewport_set_usage">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage">
</argument>
<description>
Sets what should be rendered in the viewport. See VIEWPORT_USAGE_* constants for options.
</description>
</method>
<method name="viewport_set_use_arvr">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="use_arvr" type="bool">
</argument>
<description>
If [code]true[/code] the viewport should use augmented or virtual reality technologies. See [ARVRInterface].
</description>
</method>
<method name="viewport_set_vflip">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
If [code]true[/code] the viewport's rendering should be flipped vertically.
</description>
</method>
</methods>
<signals>
<signal name="frame_drawn_in_thread">
<description>
</description>
</signal>
</signals>
<constants>
<constant name="NO_INDEX_ARRAY" value="-1">
Marks an error that shows that the index array is empty.
</constant>
<constant name="ARRAY_WEIGHTS_SIZE" value="4">
</constant>
<constant name="CANVAS_ITEM_Z_MIN" value="-4096">
The minimum Z-layer for canvas items.
</constant>
<constant name="CANVAS_ITEM_Z_MAX" value="4096">
The maximum Z-layer for canvas items.
</constant>
<constant name="MAX_GLOW_LEVELS" value="7">
</constant>
<constant name="MAX_CURSORS" value="8">
</constant>
<constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128">
The minimum renderpriority of all materials.
</constant>
<constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127">
The maximum renderpriority of all materials.
</constant>
<constant name="CUBEMAP_LEFT" value="0" enum="CubeMapSide">
Marks the left side of a cubemap.
</constant>
<constant name="CUBEMAP_RIGHT" value="1" enum="CubeMapSide">
Marks the right side of a cubemap.
</constant>
<constant name="CUBEMAP_BOTTOM" value="2" enum="CubeMapSide">
Marks the bottom side of a cubemap.
</constant>
<constant name="CUBEMAP_TOP" value="3" enum="CubeMapSide">
Marks the top side of a cubemap.
</constant>
<constant name="CUBEMAP_FRONT" value="4" enum="CubeMapSide">
Marks the front side of a cubemap.
</constant>
<constant name="CUBEMAP_BACK" value="5" enum="CubeMapSide">
Marks the back side of a cubemap.
</constant>
<constant name="TEXTURE_FLAG_MIPMAPS" value="1" enum="TextureFlags">
Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
</constant>
<constant name="TEXTURE_FLAG_REPEAT" value="2" enum="TextureFlags">
Repeat (instead of clamp to edge).
</constant>
<constant name="TEXTURE_FLAG_FILTER" value="4" enum="TextureFlags">
Turn on magnifying filter, to enable smooth zooming in of the texture.
</constant>
<constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8" enum="TextureFlags">
Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
</constant>
<constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16" enum="TextureFlags">
Converts texture to SRGB color space.
</constant>
<constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags">
Repeat texture with alternate sections mirrored.
</constant>
<constant name="TEXTURE_FLAG_CUBEMAP" value="2048" enum="TextureFlags">
Texture is a cubemap.
</constant>
<constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096" enum="TextureFlags">
Texture is a video surface.
</constant>
<constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags">
Default flags. Generate mipmaps, repeat, and filter are enabled.
</constant>
<constant name="SHADER_SPATIAL" value="0" enum="ShaderMode">
Shader is a 3D shader.
</constant>
<constant name="SHADER_CANVAS_ITEM" value="1" enum="ShaderMode">
Shader is a 2D shader.
</constant>
<constant name="SHADER_PARTICLES" value="2" enum="ShaderMode">
Shader is a particle shader.
</constant>
<constant name="SHADER_MAX" value="3" enum="ShaderMode">
Marks maximum of the shader types array. used internally.
</constant>
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Array is a vertex array.
</constant>
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Array is a normal array.
</constant>
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Array is a tangent array.
</constant>
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Array is a color array.
</constant>
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
Array is a uv coordinates array.
</constant>
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Array is a uv coordinates array for the second uv coordinates.
</constant>
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
Array contains bone information.
</constant>
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
Array is weight information.
</constant>
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
Array is index array.
</constant>
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
Marks the maximum of the array types. Used internally.
</constant>
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Flag used to mark a vertex array.
</constant>
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat">
Flag used to mark a normal array.
</constant>
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat">
Flag used to mark a tangent array.
</constant>
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat">
Flag used to mark a color array.
</constant>
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat">
Flag used to mark a uv coordinates array.
</constant>
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat">
Flag used to mark a uv coordinates array for the second uv coordinates.
</constant>
<constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat">
Flag used to mark a bone information array.
</constant>
<constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat">
Flag used to mark a weights array.
</constant>
<constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat">
Flag used to mark a index array.
</constant>
<constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat">
Flag used to mark a compressed (half float) vertex array.
</constant>
<constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat">
Flag used to mark a compressed (half float) normal array.
</constant>
<constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat">
Flag used to mark a compressed (half float) tangent array.
</constant>
<constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat">
Flag used to mark a compressed (half float) color array.
</constant>
<constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat">
Flag used to mark a compressed (half float) uv coordinates array.
</constant>
<constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat">
Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates.
</constant>
<constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat">
Flag used to mark a compressed (half float) weight array.
</constant>
<constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat">
Flag used to mark that the array contains 2D vertices.
</constant>
<constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat">
Flag used to mark that the array uses 16 bit bones instead of 8 bit.
</constant>
<constant name="ARRAY_COMPRESS_DEFAULT" value="97792" enum="ArrayFormat">
Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly.
</constant>
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Primitive to draw consists of points.
</constant>
<constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType">
Primitive to draw consists of lines.
</constant>
<constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType">
Primitive to draw consists of a line strip from start to end.
</constant>
<constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType">
Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex).
</constant>
<constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType">
Primitive to draw consists of triangles.
</constant>
<constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType">
Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle).
</constant>
<constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType">
Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle).
</constant>
<constant name="PRIMITIVE_MAX" value="7" enum="PrimitiveType">
Marks the primitive types endpoint. used internally.
</constant>
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
</constant>
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
</constant>
<constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType">
Is a directional (sun) light.
</constant>
<constant name="LIGHT_OMNI" value="1" enum="LightType">
is an omni light.
</constant>
<constant name="LIGHT_SPOT" value="2" enum="LightType">
is an spot light.
</constant>
<constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam">
The light's energy.
</constant>
<constant name="LIGHT_PARAM_SPECULAR" value="2" enum="LightParam">
The light's influence on specularity.
</constant>
<constant name="LIGHT_PARAM_RANGE" value="3" enum="LightParam">
The light's range.
</constant>
<constant name="LIGHT_PARAM_ATTENUATION" value="4" enum="LightParam">
The light's attenuation.
</constant>
<constant name="LIGHT_PARAM_SPOT_ANGLE" value="5" enum="LightParam">
The spotlight's angle.
</constant>
<constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="6" enum="LightParam">
The spotlight's attenuation.
</constant>
<constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="7" enum="LightParam">
Scales the shadow color.
</constant>
<constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="8" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="9" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="10" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="11" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="12" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="13" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_MAX" value="15" enum="LightParam">
The light parameters endpoint. Used internally.
</constant>
<constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode">
</constant>
<constant name="VIEWPORT_UPDATE_ONCE" value="1" enum="ViewportUpdateMode">
</constant>
<constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2" enum="ViewportUpdateMode">
</constant>
<constant name="VIEWPORT_UPDATE_ALWAYS" value="3" enum="ViewportUpdateMode">
</constant>
<constant name="VIEWPORT_CLEAR_ALWAYS" value="0" enum="ViewportClearMode">
The viewport is always cleared before drawing.
</constant>
<constant name="VIEWPORT_CLEAR_NEVER" value="1" enum="ViewportClearMode">
The viewport is never cleared before drawing.
</constant>
<constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2" enum="ViewportClearMode">
The viewport is cleared once, then the clear mode is set to [VIEWPORT_CLEAR_NEVER].
</constant>
<constant name="VIEWPORT_MSAA_DISABLED" value="0" enum="ViewportMSAA">
Multisample antialiasing is disabled.
</constant>
<constant name="VIEWPORT_MSAA_2X" value="1" enum="ViewportMSAA">
Multisample antialiasing is set to 2X.
</constant>
<constant name="VIEWPORT_MSAA_4X" value="2" enum="ViewportMSAA">
Multisample antialiasing is set to 4X.
</constant>
<constant name="VIEWPORT_MSAA_8X" value="3" enum="ViewportMSAA">
Multisample antialiasing is set to 8X.
</constant>
<constant name="VIEWPORT_MSAA_16X" value="4" enum="ViewportMSAA">
Multisample antialiasing is set to 16X.
</constant>
<constant name="VIEWPORT_USAGE_2D" value="0" enum="ViewportUsage">
The Viewport does not render 3D but samples.
</constant>
<constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1" enum="ViewportUsage">
The Viewport does not render 3D and does not sample.
</constant>
<constant name="VIEWPORT_USAGE_3D" value="2" enum="ViewportUsage">
The Viewport renders 3D with effects.
</constant>
<constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3" enum="ViewportUsage">
The Viewport renders 3D but without effects.
</constant>
<constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_MAX" value="6" enum="ViewportRenderInfo">
Marks end of VIEWPORT_RENDER_INFO* constants. Used internally.
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw">
Debug draw is disabled. Default setting.
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1" enum="ViewportDebugDraw">
Debug draw sets objects to unshaded.
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2" enum="ViewportDebugDraw">
Overwrites clear color to [code](0,0,0,0)[/code].
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3" enum="ViewportDebugDraw">
Debug draw draws objects in wireframe.
</constant>
<constant name="SCENARIO_DEBUG_DISABLED" value="0" enum="ScenarioDebugMode">
</constant>
<constant name="SCENARIO_DEBUG_WIREFRAME" value="1" enum="ScenarioDebugMode">
</constant>
<constant name="SCENARIO_DEBUG_OVERDRAW" value="2" enum="ScenarioDebugMode">
</constant>
<constant name="SCENARIO_DEBUG_SHADELESS" value="3" enum="ScenarioDebugMode">
</constant>
<constant name="INSTANCE_NONE" value="0" enum="InstanceType">
The instance does not have a type.
</constant>
<constant name="INSTANCE_MESH" value="1" enum="InstanceType">
The instance is a mesh.
</constant>
<constant name="INSTANCE_MULTIMESH" value="2" enum="InstanceType">
The instance is a multimesh.
</constant>
<constant name="INSTANCE_IMMEDIATE" value="3" enum="InstanceType">
The instance is an immediate geometry.
</constant>
<constant name="INSTANCE_PARTICLES" value="4" enum="InstanceType">
The instance is a particle emitter.
</constant>
<constant name="INSTANCE_LIGHT" value="5" enum="InstanceType">
The instance is a light.
</constant>
<constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType">
</constant>
<constant name="INSTANCE_GI_PROBE" value="7" enum="InstanceType">
</constant>
<constant name="INSTANCE_LIGHTMAP_CAPTURE" value="8" enum="InstanceType">
</constant>
<constant name="INSTANCE_MAX" value="9" enum="InstanceType">
The max value for INSTANCE_* constants, used internally.
</constant>
<constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType">
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
</constant>
<constant name="NINE_PATCH_STRETCH" value="0" enum="NinePatchAxisMode">
The nine patch gets stretched where needed.
</constant>
<constant name="NINE_PATCH_TILE" value="1" enum="NinePatchAxisMode">
The nine patch gets filled with tiles where needed.
</constant>
<constant name="NINE_PATCH_TILE_FIT" value="2" enum="NinePatchAxisMode">
The nine patch gets filled with tiles where needed and stretches them a bit if needed.
</constant>
<constant name="CANVAS_LIGHT_MODE_ADD" value="0" enum="CanvasLightMode">
Adds light color additive to the canvas.
</constant>
<constant name="CANVAS_LIGHT_MODE_SUB" value="1" enum="CanvasLightMode">
Adds light color subtractive to the canvas.
</constant>
<constant name="CANVAS_LIGHT_MODE_MIX" value="2" enum="CanvasLightMode">
The light adds color depending on transparency.
</constant>
<constant name="CANVAS_LIGHT_MODE_MASK" value="3" enum="CanvasLightMode">
The light adds color depending on mask.
</constant>
<constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter">
</constant>
<constant name="CANVAS_LIGHT_FILTER_PCF3" value="1" enum="CanvasLightShadowFilter">
</constant>
<constant name="CANVAS_LIGHT_FILTER_PCF5" value="2" enum="CanvasLightShadowFilter">
</constant>
<constant name="CANVAS_LIGHT_FILTER_PCF7" value="3" enum="CanvasLightShadowFilter">
</constant>
<constant name="CANVAS_LIGHT_FILTER_PCF9" value="4" enum="CanvasLightShadowFilter">
</constant>
<constant name="CANVAS_LIGHT_FILTER_PCF13" value="5" enum="CanvasLightShadowFilter">
</constant>
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0" enum="CanvasOccluderPolygonCullMode">
Culling of the canvas occluder is disabled.
</constant>
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1" enum="CanvasOccluderPolygonCullMode">
Culling of the canvas occluder is clockwise.
</constant>
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode">
Culling of the canvas occluder is counterclockwise.
</constant>
<constant name="INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo">
The amount of objects in the frame.
</constant>
<constant name="INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
The amount of vertices in the frame.
</constant>
<constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
The amount of modified materials in the frame.
</constant>
<constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo">
The amount of shader rebinds in the frame.
</constant>
<constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo">
The amount of surface changes in the frame.
</constant>
<constant name="INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo">
The amount of draw calls in frame.
</constant>
<constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6" enum="RenderInfo">
</constant>
<constant name="INFO_VIDEO_MEM_USED" value="7" enum="RenderInfo">
The amount of vertex memory and texture memory used.
</constant>
<constant name="INFO_TEXTURE_MEM_USED" value="8" enum="RenderInfo">
The amount of texture memory used.
</constant>
<constant name="INFO_VERTEX_MEM_USED" value="9" enum="RenderInfo">
The amount of vertex memory used.
</constant>
<constant name="FEATURE_SHADERS" value="0" enum="Features">
</constant>
<constant name="FEATURE_MULTITHREADED" value="1" enum="Features">
</constant>
</constants>
</class>
|