summaryrefslogtreecommitdiff
path: root/doc/classes/Color.xml
blob: 7083157081790b31705c582c2a14c645b8bdff08 (plain)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Color" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Color in RGBA format using floats on the range of 0 to 1.
	</brief_description>
	<description>
		A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for opacity. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors).
		You can also create a color from standardized color names by using the string constructor or directly using the color constants defined here. The standardized color set is based on the [url=https://en.wikipedia.org/wiki/X11_color_names]X11 color names[/url].
		If you want to supply values in a range of 0 to 255, you should use [method @GDScript.Color8].
		[b]Note:[/b] In a boolean context, a Color will evaluate to [code]false[/code] if it's equal to [code]Color(0, 0, 0, 1)[/code] (opaque black). Otherwise, a Color will always evaluate to [code]true[/code].
		[url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png]Color constants cheatsheet[/url]
	</description>
	<tutorials>
		<link title="2D GD Paint Demo">https://godotengine.org/asset-library/asset/517</link>
		<link title="Tween Demo">https://godotengine.org/asset-library/asset/146</link>
		<link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/133</link>
	</tutorials>
	<constructors>
		<constructor name="Color">
			<return type="Color" />
			<description>
				Constructs a default-initialized [Color] with all components set to [code]0[/code].
			</description>
		</constructor>
		<constructor name="Color">
			<return type="Color" />
			<argument index="0" name="from" type="Color" />
			<argument index="1" name="alpha" type="float" />
			<description>
				Constructs a [Color] from an existing color, but with a custom alpha value.
				[codeblocks]
				[gdscript]
				var red = Color(Color.red, 0.2) # 20% opaque red.
				[/gdscript]
				[csharp]
				var red = new Color(Colors.Red, 0.2f); // 20% opaque red.
				[/csharp]
				[/codeblocks]
			</description>
		</constructor>
		<constructor name="Color">
			<return type="Color" />
			<argument index="0" name="from" type="Color" />
			<description>
				Constructs a [Color] as a copy of the given [Color].
			</description>
		</constructor>
		<constructor name="Color">
			<return type="Color" />
			<argument index="0" name="code" type="String" />
			<description>
				Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants.
			</description>
		</constructor>
		<constructor name="Color">
			<return type="Color" />
			<argument index="0" name="code" type="String" />
			<argument index="1" name="alpha" type="float" />
			<description>
				Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants.
			</description>
		</constructor>
		<constructor name="Color">
			<return type="Color" />
			<argument index="0" name="r" type="float" />
			<argument index="1" name="g" type="float" />
			<argument index="2" name="b" type="float" />
			<description>
				Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1.
				[codeblocks]
				[gdscript]
				var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)`
				[/gdscript]
				[csharp]
				var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`
				[/csharp]
				[/codeblocks]
			</description>
		</constructor>
		<constructor name="Color">
			<return type="Color" />
			<argument index="0" name="r" type="float" />
			<argument index="1" name="g" type="float" />
			<argument index="2" name="b" type="float" />
			<argument index="3" name="a" type="float" />
			<description>
				Constructs a [Color] from RGBA values, typically between 0 and 1.
				[codeblocks]
				[gdscript]
				var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)`
				[/gdscript]
				[csharp]
				var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)`
				[/csharp]
				[/codeblocks]
			</description>
		</constructor>
	</constructors>
	<methods>
		<method name="blend" qualifiers="const">
			<return type="Color" />
			<argument index="0" name="over" type="Color" />
			<description>
				Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values.
				[codeblocks]
				[gdscript]
				var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
				var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
				var blended_color = bg.blend(fg) # Brown with alpha of 75%
				[/gdscript]
				[csharp]
				var bg = new Color(0.0f, 1.0f, 0.0f, 0.5f); // Green with alpha of 50%
				var fg = new Color(1.0f, 0.0f, 0.0f, 0.5f); // Red with alpha of 50%
				Color blendedColor = bg.Blend(fg); // Brown with alpha of 75%
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="clamp" qualifiers="const">
			<return type="Color" />
			<argument index="0" name="min" type="Color" default="Color(0, 0, 0, 0)" />
			<argument index="1" name="max" type="Color" default="Color(1, 1, 1, 1)" />
			<description>
				Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
			</description>
		</method>
		<method name="darkened" qualifiers="const">
			<return type="Color" />
			<argument index="0" name="amount" type="float" />
			<description>
				Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
				[codeblocks]
				[gdscript]
				var green = Color(0.0, 1.0, 0.0)
				var darkgreen = green.darkened(0.2) # 20% darker than regular green
				[/gdscript]
				[csharp]
				var green = new Color(0.0f, 1.0f, 0.0f);
				Color darkgreen = green.Darkened(0.2f); // 20% darker than regular green
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="find_named_color" qualifiers="static">
			<return type="int" />
			<argument index="0" name="name" type="String" />
			<description>
			</description>
		</method>
		<method name="from_hsv" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="h" type="float" />
			<argument index="1" name="s" type="float" />
			<argument index="2" name="v" type="float" />
			<argument index="3" name="alpha" type="float" default="1.0" />
			<description>
				Constructs a color from an [url=https://en.wikipedia.org/wiki/HSL_and_HSV]HSV profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1.
				[codeblocks]
				[gdscript]
				var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8)
				[/gdscript]
				[csharp]
				var c = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f);
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="from_rgbe9995" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="rgbe" type="int" />
			<description>
			</description>
		</method>
		<method name="from_string" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="str" type="String" />
			<argument index="1" name="default" type="Color" />
			<description>
			</description>
		</method>
		<method name="get_luminance" qualifiers="const">
			<return type="float" />
			<description>
				Returns the luminance of the color in the [code][0.0, 1.0][/code] range.
				This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark.
			</description>
		</method>
		<method name="get_named_color" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="idx" type="int" />
			<description>
			</description>
		</method>
		<method name="get_named_color_count" qualifiers="static">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="get_named_color_name" qualifiers="static">
			<return type="String" />
			<argument index="0" name="idx" type="int" />
			<description>
			</description>
		</method>
		<method name="hex" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="hex" type="int" />
			<description>
			</description>
		</method>
		<method name="hex64" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="hex" type="int" />
			<description>
			</description>
		</method>
		<method name="html" qualifiers="static">
			<return type="Color" />
			<argument index="0" name="rgba" type="String" />
			<description>
				Returns a new color from [code]rgba[/code], an HTML hexadecimal color string. [code]rgba[/code] is not case sensitive, and may be prefixed with a '#' character.
				[code]rgba[/code] must be a valid three-digit or six-digit hexadecimal color string, and may contain an alpha channel value. If [code]rgba[/code] does not contain an alpha channel value, an alpha channel value of 1.0 is applied.
				If [code]rgba[/code] is invalid a Color(0.0, 0.0, 0.0, 1.0) is returned.
				[b]Note:[/b] This method is not implemented in C#, but the same functionality is provided in the class constructor.
				[codeblocks]
				[gdscript]
				var green = Color.html("#00FF00FF") # set green to Color(0.0, 1.0, 0.0, 1.0)
				var blue = Color.html("#0000FF") # set blue to Color(0.0, 0.0, 1.0, 1.0)
				[/gdscript]
				[csharp]
				var green = new Color("#00FF00FF"); // set green to Color(0.0, 1.0, 0.0, 1.0)
				var blue = new Color("#0000FF"); // set blue to Color(0.0, 0.0, 1.0, 1.0)
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="html_is_valid" qualifiers="static">
			<return type="bool" />
			<argument index="0" name="color" type="String" />
			<description>
				Returns [code]true[/code] if [code]color[/code] is a valid HTML hexadecimal color string. [code]color[/code] is not case sensitive, and may be prefixed with a '#' character.
				For a string to be valid it must be three-digit or six-digit hexadecimal, and may contain an alpha channel value.
				[codeblocks]
				[gdscript]
				var result = Color.html_is_valid("#55aaFF") # result is true
				result = Color.html_is_valid("#55AAFF20") # result is true
				result = Color.html_is_valid("55AAFF") # result is true
				result = Color.html_is_valid("#F2C") # result is true
				result = Color.html_is_valid("#AABBC) # result is false
				result = Color.html_is_valid("#55aaFF5") # result is false
				[/gdscript]
				[csharp]
				var result = Color.HtmlIsValid("#55AAFF"); // result is true
				result = Color.HtmlIsValid("#55AAFF20"); // result is true
				result = Color.HtmlIsValid("55AAFF); // result is true
				result = Color.HtmlIsValid("#F2C"); // result is true
				result = Color.HtmlIsValid("#AABBC"); // result is false
				result = Color.HtmlIsValid("#55aaFF5"); // result is false
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="inverted" qualifiers="const">
			<return type="Color" />
			<description>
				Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code].
				[codeblocks]
				[gdscript]
				var color = Color(0.3, 0.4, 0.9)
				var inverted_color = color.inverted() # Equivalent to `Color(0.7, 0.6, 0.1)`
				[/gdscript]
				[csharp]
				var color = new Color(0.3f, 0.4f, 0.9f);
				Color invertedColor = color.Inverted(); // Equivalent to `new Color(0.7f, 0.6f, 0.1f)`
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="is_equal_approx" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="to" type="Color" />
			<description>
				Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
			</description>
		</method>
		<method name="lerp" qualifiers="const">
			<return type="Color" />
			<argument index="0" name="to" type="Color" />
			<argument index="1" name="weight" type="float" />
			<description>
				Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1.
				[codeblocks]
				[gdscript]
				var c1 = Color(1.0, 0.0, 0.0)
				var c2 = Color(0.0, 1.0, 0.0)
				var lerp_color = c1.lerp(c2, 0.5) # Equivalent to `Color(0.5, 0.5, 0.0)`
				[/gdscript]
				[csharp]
				var c1 = new Color(1.0f, 0.0f, 0.0f);
				var c2 = new Color(0.0f, 1.0f, 0.0f);
				Color lerpColor = c1.Lerp(c2, 0.5f); // Equivalent to `new Color(0.5f, 0.5f, 0.0f)`
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="lightened" qualifiers="const">
			<return type="Color" />
			<argument index="0" name="amount" type="float" />
			<description>
				Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
				[codeblocks]
				[gdscript]
				var green = Color(0.0, 1.0, 0.0)
				var lightgreen = green.lightened(0.2) # 20% lighter than regular green
				[/gdscript]
				[csharp]
				var green = new Color(0.0f, 1.0f, 0.0f);
				Color lightgreen = green.Lightened(0.2f); // 20% lighter than regular green
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_abgr32" qualifiers="const">
			<return type="int" />
			<description>
				Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format.
				[codeblocks]
				[gdscript]
				var color = Color(1, 0.5, 0.2)
				print(color.to_abgr32()) # Prints 4281565439
				[/gdscript]
				[csharp]
				var color = new Color(1.0f, 0.5f, 0.2f);
				GD.Print(color.ToAbgr32()); // Prints 4281565439
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_abgr64" qualifiers="const">
			<return type="int" />
			<description>
				Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format.
				[codeblocks]
				[gdscript]
				var color = Color(1, 0.5, 0.2)
				print(color.to_abgr64()) # Prints -225178692812801
				[/gdscript]
				[csharp]
				var color = new Color(1.0f, 0.5f, 0.2f);
				GD.Print(color.ToAbgr64()); // Prints -225178692812801
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_argb32" qualifiers="const">
			<return type="int" />
			<description>
				Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
				[codeblocks]
				[gdscript]
				var color = Color(1, 0.5, 0.2)
				print(color.to_argb32()) # Prints 4294934323
				[/gdscript]
				[csharp]
				var color = new Color(1.0f, 0.5f, 0.2f);
				GD.Print(color.ToArgb32()); // Prints 4294934323
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_argb64" qualifiers="const">
			<return type="int" />
			<description>
				Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
				[codeblocks]
				[gdscript]
				var color = Color(1, 0.5, 0.2)
				print(color.to_argb64()) # Prints -2147470541
				[/gdscript]
				[csharp]
				var color = new Color(1.0f, 0.5f, 0.2f);
				GD.Print(color.ToArgb64()); // Prints -2147470541
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_html" qualifiers="const">
			<return type="String" />
			<argument index="0" name="with_alpha" type="bool" default="true" />
			<description>
				Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: [code]ff34f822[/code]).
				Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format).
				[codeblocks]
				[gdscript]
				var color = Color(1, 1, 1, 0.5)
				var with_alpha = color.to_html() # Returns "ffffff7f"
				var without_alpha = color.to_html(false) # Returns "ffffff"
				[/gdscript]
				[csharp]
				var color = new Color(1, 1, 1, 0.5f);
				String withAlpha = color.ToHtml(); // Returns "ffffff7f"
				String withoutAlpha = color.ToHtml(false); // Returns "ffffff"
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_rgba32" qualifiers="const">
			<return type="int" />
			<description>
				Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
				[codeblocks]
				[gdscript]
				var color = Color(1, 0.5, 0.2)
				print(color.to_rgba32()) # Prints 4286526463
				[/gdscript]
				[csharp]
				var color = new Color(1, 0.5f, 0.2f);
				GD.Print(color.ToRgba32()); // Prints 4286526463
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="to_rgba64" qualifiers="const">
			<return type="int" />
			<description>
				Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
				[codeblocks]
				[gdscript]
				var color = Color(1, 0.5, 0.2)
				print(color.to_rgba64()) # Prints -140736629309441
				[/gdscript]
				[csharp]
				var color = new Color(1, 0.5f, 0.2f);
				GD.Print(color.ToRgba64()); // Prints -140736629309441
				[/csharp]
				[/codeblocks]
			</description>
		</method>
	</methods>
	<members>
		<member name="a" type="float" setter="" getter="" default="1.0">
			The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque.
		</member>
		<member name="a8" type="int" setter="" getter="" default="255">
			Wrapper for [member a] that uses the range 0 to 255 instead of 0 to 1.
		</member>
		<member name="b" type="float" setter="" getter="" default="0.0">
			The color's blue component, typically on the range of 0 to 1.
		</member>
		<member name="b8" type="int" setter="" getter="" default="0">
			Wrapper for [member b] that uses the range 0 to 255 instead of 0 to 1.
		</member>
		<member name="g" type="float" setter="" getter="" default="0.0">
			The color's green component, typically on the range of 0 to 1.
		</member>
		<member name="g8" type="int" setter="" getter="" default="0">
			Wrapper for [member g] that uses the range 0 to 255 instead of 0 to 1.
		</member>
		<member name="h" type="float" setter="" getter="" default="0.0">
			The HSV hue of this color, on the range 0 to 1.
		</member>
		<member name="r" type="float" setter="" getter="" default="0.0">
			The color's red component, typically on the range of 0 to 1.
		</member>
		<member name="r8" type="int" setter="" getter="" default="0">
			Wrapper for [member r] that uses the range 0 to 255 instead of 0 to 1.
		</member>
		<member name="s" type="float" setter="" getter="" default="0.0">
			The HSV saturation of this color, on the range 0 to 1.
		</member>
		<member name="v" type="float" setter="" getter="" default="0.0">
			The HSV value (brightness) of this color, on the range 0 to 1.
		</member>
	</members>
	<constants>
		<constant name="ALICE_BLUE" value="Color(0.94, 0.97, 1, 1)">
			Alice blue color.
		</constant>
		<constant name="ANTIQUE_WHITE" value="Color(0.98, 0.92, 0.84, 1)">
			Antique white color.
		</constant>
		<constant name="AQUA" value="Color(0, 1, 1, 1)">
			Aqua color.
		</constant>
		<constant name="AQUAMARINE" value="Color(0.5, 1, 0.83, 1)">
			Aquamarine color.
		</constant>
		<constant name="AZURE" value="Color(0.94, 1, 1, 1)">
			Azure color.
		</constant>
		<constant name="BEIGE" value="Color(0.96, 0.96, 0.86, 1)">
			Beige color.
		</constant>
		<constant name="BISQUE" value="Color(1, 0.89, 0.77, 1)">
			Bisque color.
		</constant>
		<constant name="BLACK" value="Color(0, 0, 0, 1)">
			Black color.
		</constant>
		<constant name="BLANCHED_ALMOND" value="Color(1, 0.92, 0.8, 1)">
			Blanched almond color.
		</constant>
		<constant name="BLUE" value="Color(0, 0, 1, 1)">
			Blue color.
		</constant>
		<constant name="BLUE_VIOLET" value="Color(0.54, 0.17, 0.89, 1)">
			Blue violet color.
		</constant>
		<constant name="BROWN" value="Color(0.65, 0.16, 0.16, 1)">
			Brown color.
		</constant>
		<constant name="BURLYWOOD" value="Color(0.87, 0.72, 0.53, 1)">
			Burlywood color.
		</constant>
		<constant name="CADET_BLUE" value="Color(0.37, 0.62, 0.63, 1)">
			Cadet blue color.
		</constant>
		<constant name="CHARTREUSE" value="Color(0.5, 1, 0, 1)">
			Chartreuse color.
		</constant>
		<constant name="CHOCOLATE" value="Color(0.82, 0.41, 0.12, 1)">
			Chocolate color.
		</constant>
		<constant name="CORAL" value="Color(1, 0.5, 0.31, 1)">
			Coral color.
		</constant>
		<constant name="CORNFLOWER_BLUE" value="Color(0.39, 0.58, 0.93, 1)">
			Cornflower blue color.
		</constant>
		<constant name="CORNSILK" value="Color(1, 0.97, 0.86, 1)">
			Cornsilk color.
		</constant>
		<constant name="CRIMSON" value="Color(0.86, 0.08, 0.24, 1)">
			Crimson color.
		</constant>
		<constant name="CYAN" value="Color(0, 1, 1, 1)">
			Cyan color.
		</constant>
		<constant name="DARK_BLUE" value="Color(0, 0, 0.55, 1)">
			Dark blue color.
		</constant>
		<constant name="DARK_CYAN" value="Color(0, 0.55, 0.55, 1)">
			Dark cyan color.
		</constant>
		<constant name="DARK_GOLDENROD" value="Color(0.72, 0.53, 0.04, 1)">
			Dark goldenrod color.
		</constant>
		<constant name="DARK_GRAY" value="Color(0.66, 0.66, 0.66, 1)">
			Dark gray color.
		</constant>
		<constant name="DARK_GREEN" value="Color(0, 0.39, 0, 1)">
			Dark green color.
		</constant>
		<constant name="DARK_KHAKI" value="Color(0.74, 0.72, 0.42, 1)">
			Dark khaki color.
		</constant>
		<constant name="DARK_MAGENTA" value="Color(0.55, 0, 0.55, 1)">
			Dark magenta color.
		</constant>
		<constant name="DARK_OLIVE_GREEN" value="Color(0.33, 0.42, 0.18, 1)">
			Dark olive green color.
		</constant>
		<constant name="DARK_ORANGE" value="Color(1, 0.55, 0, 1)">
			Dark orange color.
		</constant>
		<constant name="DARK_ORCHID" value="Color(0.6, 0.2, 0.8, 1)">
			Dark orchid color.
		</constant>
		<constant name="DARK_RED" value="Color(0.55, 0, 0, 1)">
			Dark red color.
		</constant>
		<constant name="DARK_SALMON" value="Color(0.91, 0.59, 0.48, 1)">
			Dark salmon color.
		</constant>
		<constant name="DARK_SEA_GREEN" value="Color(0.56, 0.74, 0.56, 1)">
			Dark sea green color.
		</constant>
		<constant name="DARK_SLATE_BLUE" value="Color(0.28, 0.24, 0.55, 1)">
			Dark slate blue color.
		</constant>
		<constant name="DARK_SLATE_GRAY" value="Color(0.18, 0.31, 0.31, 1)">
			Dark slate gray color.
		</constant>
		<constant name="DARK_TURQUOISE" value="Color(0, 0.81, 0.82, 1)">
			Dark turquoise color.
		</constant>
		<constant name="DARK_VIOLET" value="Color(0.58, 0, 0.83, 1)">
			Dark violet color.
		</constant>
		<constant name="DEEP_PINK" value="Color(1, 0.08, 0.58, 1)">
			Deep pink color.
		</constant>
		<constant name="DEEP_SKY_BLUE" value="Color(0, 0.75, 1, 1)">
			Deep sky blue color.
		</constant>
		<constant name="DIM_GRAY" value="Color(0.41, 0.41, 0.41, 1)">
			Dim gray color.
		</constant>
		<constant name="DODGER_BLUE" value="Color(0.12, 0.56, 1, 1)">
			Dodger blue color.
		</constant>
		<constant name="FIREBRICK" value="Color(0.7, 0.13, 0.13, 1)">
			Firebrick color.
		</constant>
		<constant name="FLORAL_WHITE" value="Color(1, 0.98, 0.94, 1)">
			Floral white color.
		</constant>
		<constant name="FOREST_GREEN" value="Color(0.13, 0.55, 0.13, 1)">
			Forest green color.
		</constant>
		<constant name="FUCHSIA" value="Color(1, 0, 1, 1)">
			Fuchsia color.
		</constant>
		<constant name="GAINSBORO" value="Color(0.86, 0.86, 0.86, 1)">
			Gainsboro color.
		</constant>
		<constant name="GHOST_WHITE" value="Color(0.97, 0.97, 1, 1)">
			Ghost white color.
		</constant>
		<constant name="GOLD" value="Color(1, 0.84, 0, 1)">
			Gold color.
		</constant>
		<constant name="GOLDENROD" value="Color(0.85, 0.65, 0.13, 1)">
			Goldenrod color.
		</constant>
		<constant name="GRAY" value="Color(0.75, 0.75, 0.75, 1)">
			Gray color.
		</constant>
		<constant name="GREEN" value="Color(0, 1, 0, 1)">
			Green color.
		</constant>
		<constant name="GREEN_YELLOW" value="Color(0.68, 1, 0.18, 1)">
			Green yellow color.
		</constant>
		<constant name="HONEYDEW" value="Color(0.94, 1, 0.94, 1)">
			Honeydew color.
		</constant>
		<constant name="HOT_PINK" value="Color(1, 0.41, 0.71, 1)">
			Hot pink color.
		</constant>
		<constant name="INDIAN_RED" value="Color(0.8, 0.36, 0.36, 1)">
			Indian red color.
		</constant>
		<constant name="INDIGO" value="Color(0.29, 0, 0.51, 1)">
			Indigo color.
		</constant>
		<constant name="IVORY" value="Color(1, 1, 0.94, 1)">
			Ivory color.
		</constant>
		<constant name="KHAKI" value="Color(0.94, 0.9, 0.55, 1)">
			Khaki color.
		</constant>
		<constant name="LAVENDER" value="Color(0.9, 0.9, 0.98, 1)">
			Lavender color.
		</constant>
		<constant name="LAVENDER_BLUSH" value="Color(1, 0.94, 0.96, 1)">
			Lavender blush color.
		</constant>
		<constant name="LAWN_GREEN" value="Color(0.49, 0.99, 0, 1)">
			Lawn green color.
		</constant>
		<constant name="LEMON_CHIFFON" value="Color(1, 0.98, 0.8, 1)">
			Lemon chiffon color.
		</constant>
		<constant name="LIGHT_BLUE" value="Color(0.68, 0.85, 0.9, 1)">
			Light blue color.
		</constant>
		<constant name="LIGHT_CORAL" value="Color(0.94, 0.5, 0.5, 1)">
			Light coral color.
		</constant>
		<constant name="LIGHT_CYAN" value="Color(0.88, 1, 1, 1)">
			Light cyan color.
		</constant>
		<constant name="LIGHT_GOLDENROD" value="Color(0.98, 0.98, 0.82, 1)">
			Light goldenrod color.
		</constant>
		<constant name="LIGHT_GRAY" value="Color(0.83, 0.83, 0.83, 1)">
			Light gray color.
		</constant>
		<constant name="LIGHT_GREEN" value="Color(0.56, 0.93, 0.56, 1)">
			Light green color.
		</constant>
		<constant name="LIGHT_PINK" value="Color(1, 0.71, 0.76, 1)">
			Light pink color.
		</constant>
		<constant name="LIGHT_SALMON" value="Color(1, 0.63, 0.48, 1)">
			Light salmon color.
		</constant>
		<constant name="LIGHT_SEA_GREEN" value="Color(0.13, 0.7, 0.67, 1)">
			Light sea green color.
		</constant>
		<constant name="LIGHT_SKY_BLUE" value="Color(0.53, 0.81, 0.98, 1)">
			Light sky blue color.
		</constant>
		<constant name="LIGHT_SLATE_GRAY" value="Color(0.47, 0.53, 0.6, 1)">
			Light slate gray color.
		</constant>
		<constant name="LIGHT_STEEL_BLUE" value="Color(0.69, 0.77, 0.87, 1)">
			Light steel blue color.
		</constant>
		<constant name="LIGHT_YELLOW" value="Color(1, 1, 0.88, 1)">
			Light yellow color.
		</constant>
		<constant name="LIME" value="Color(0, 1, 0, 1)">
			Lime color.
		</constant>
		<constant name="LIME_GREEN" value="Color(0.2, 0.8, 0.2, 1)">
			Lime green color.
		</constant>
		<constant name="LINEN" value="Color(0.98, 0.94, 0.9, 1)">
			Linen color.
		</constant>
		<constant name="MAGENTA" value="Color(1, 0, 1, 1)">
			Magenta color.
		</constant>
		<constant name="MAROON" value="Color(0.69, 0.19, 0.38, 1)">
			Maroon color.
		</constant>
		<constant name="MEDIUM_AQUAMARINE" value="Color(0.4, 0.8, 0.67, 1)">
			Medium aquamarine color.
		</constant>
		<constant name="MEDIUM_BLUE" value="Color(0, 0, 0.8, 1)">
			Medium blue color.
		</constant>
		<constant name="MEDIUM_ORCHID" value="Color(0.73, 0.33, 0.83, 1)">
			Medium orchid color.
		</constant>
		<constant name="MEDIUM_PURPLE" value="Color(0.58, 0.44, 0.86, 1)">
			Medium purple color.
		</constant>
		<constant name="MEDIUM_SEA_GREEN" value="Color(0.24, 0.7, 0.44, 1)">
			Medium sea green color.
		</constant>
		<constant name="MEDIUM_SLATE_BLUE" value="Color(0.48, 0.41, 0.93, 1)">
			Medium slate blue color.
		</constant>
		<constant name="MEDIUM_SPRING_GREEN" value="Color(0, 0.98, 0.6, 1)">
			Medium spring green color.
		</constant>
		<constant name="MEDIUM_TURQUOISE" value="Color(0.28, 0.82, 0.8, 1)">
			Medium turquoise color.
		</constant>
		<constant name="MEDIUM_VIOLET_RED" value="Color(0.78, 0.08, 0.52, 1)">
			Medium violet red color.
		</constant>
		<constant name="MIDNIGHT_BLUE" value="Color(0.1, 0.1, 0.44, 1)">
			Midnight blue color.
		</constant>
		<constant name="MINT_CREAM" value="Color(0.96, 1, 0.98, 1)">
			Mint cream color.
		</constant>
		<constant name="MISTY_ROSE" value="Color(1, 0.89, 0.88, 1)">
			Misty rose color.
		</constant>
		<constant name="MOCCASIN" value="Color(1, 0.89, 0.71, 1)">
			Moccasin color.
		</constant>
		<constant name="NAVAJO_WHITE" value="Color(1, 0.87, 0.68, 1)">
			Navajo white color.
		</constant>
		<constant name="NAVY_BLUE" value="Color(0, 0, 0.5, 1)">
			Navy blue color.
		</constant>
		<constant name="OLD_LACE" value="Color(0.99, 0.96, 0.9, 1)">
			Old lace color.
		</constant>
		<constant name="OLIVE" value="Color(0.5, 0.5, 0, 1)">
			Olive color.
		</constant>
		<constant name="OLIVE_DRAB" value="Color(0.42, 0.56, 0.14, 1)">
			Olive drab color.
		</constant>
		<constant name="ORANGE" value="Color(1, 0.65, 0, 1)">
			Orange color.
		</constant>
		<constant name="ORANGE_RED" value="Color(1, 0.27, 0, 1)">
			Orange red color.
		</constant>
		<constant name="ORCHID" value="Color(0.85, 0.44, 0.84, 1)">
			Orchid color.
		</constant>
		<constant name="PALE_GOLDENROD" value="Color(0.93, 0.91, 0.67, 1)">
			Pale goldenrod color.
		</constant>
		<constant name="PALE_GREEN" value="Color(0.6, 0.98, 0.6, 1)">
			Pale green color.
		</constant>
		<constant name="PALE_TURQUOISE" value="Color(0.69, 0.93, 0.93, 1)">
			Pale turquoise color.
		</constant>
		<constant name="PALE_VIOLET_RED" value="Color(0.86, 0.44, 0.58, 1)">
			Pale violet red color.
		</constant>
		<constant name="PAPAYA_WHIP" value="Color(1, 0.94, 0.84, 1)">
			Papaya whip color.
		</constant>
		<constant name="PEACH_PUFF" value="Color(1, 0.85, 0.73, 1)">
			Peach puff color.
		</constant>
		<constant name="PERU" value="Color(0.8, 0.52, 0.25, 1)">
			Peru color.
		</constant>
		<constant name="PINK" value="Color(1, 0.75, 0.8, 1)">
			Pink color.
		</constant>
		<constant name="PLUM" value="Color(0.87, 0.63, 0.87, 1)">
			Plum color.
		</constant>
		<constant name="POWDER_BLUE" value="Color(0.69, 0.88, 0.9, 1)">
			Powder blue color.
		</constant>
		<constant name="PURPLE" value="Color(0.63, 0.13, 0.94, 1)">
			Purple color.
		</constant>
		<constant name="REBECCA_PURPLE" value="Color(0.4, 0.2, 0.6, 1)">
			Rebecca purple color.
		</constant>
		<constant name="RED" value="Color(1, 0, 0, 1)">
			Red color.
		</constant>
		<constant name="ROSY_BROWN" value="Color(0.74, 0.56, 0.56, 1)">
			Rosy brown color.
		</constant>
		<constant name="ROYAL_BLUE" value="Color(0.25, 0.41, 0.88, 1)">
			Royal blue color.
		</constant>
		<constant name="SADDLE_BROWN" value="Color(0.55, 0.27, 0.07, 1)">
			Saddle brown color.
		</constant>
		<constant name="SALMON" value="Color(0.98, 0.5, 0.45, 1)">
			Salmon color.
		</constant>
		<constant name="SANDY_BROWN" value="Color(0.96, 0.64, 0.38, 1)">
			Sandy brown color.
		</constant>
		<constant name="SEA_GREEN" value="Color(0.18, 0.55, 0.34, 1)">
			Sea green color.
		</constant>
		<constant name="SEASHELL" value="Color(1, 0.96, 0.93, 1)">
			Seashell color.
		</constant>
		<constant name="SIENNA" value="Color(0.63, 0.32, 0.18, 1)">
			Sienna color.
		</constant>
		<constant name="SILVER" value="Color(0.75, 0.75, 0.75, 1)">
			Silver color.
		</constant>
		<constant name="SKY_BLUE" value="Color(0.53, 0.81, 0.92, 1)">
			Sky blue color.
		</constant>
		<constant name="SLATE_BLUE" value="Color(0.42, 0.35, 0.8, 1)">
			Slate blue color.
		</constant>
		<constant name="SLATE_GRAY" value="Color(0.44, 0.5, 0.56, 1)">
			Slate gray color.
		</constant>
		<constant name="SNOW" value="Color(1, 0.98, 0.98, 1)">
			Snow color.
		</constant>
		<constant name="SPRING_GREEN" value="Color(0, 1, 0.5, 1)">
			Spring green color.
		</constant>
		<constant name="STEEL_BLUE" value="Color(0.27, 0.51, 0.71, 1)">
			Steel blue color.
		</constant>
		<constant name="TAN" value="Color(0.82, 0.71, 0.55, 1)">
			Tan color.
		</constant>
		<constant name="TEAL" value="Color(0, 0.5, 0.5, 1)">
			Teal color.
		</constant>
		<constant name="THISTLE" value="Color(0.85, 0.75, 0.85, 1)">
			Thistle color.
		</constant>
		<constant name="TOMATO" value="Color(1, 0.39, 0.28, 1)">
			Tomato color.
		</constant>
		<constant name="TRANSPARENT" value="Color(1, 1, 1, 0)">
			Transparent color (white with zero alpha).
		</constant>
		<constant name="TURQUOISE" value="Color(0.25, 0.88, 0.82, 1)">
			Turquoise color.
		</constant>
		<constant name="VIOLET" value="Color(0.93, 0.51, 0.93, 1)">
			Violet color.
		</constant>
		<constant name="WEB_GRAY" value="Color(0.5, 0.5, 0.5, 1)">
			Web gray color.
		</constant>
		<constant name="WEB_GREEN" value="Color(0, 0.5, 0, 1)">
			Web green color.
		</constant>
		<constant name="WEB_MAROON" value="Color(0.5, 0, 0, 1)">
			Web maroon color.
		</constant>
		<constant name="WEB_PURPLE" value="Color(0.5, 0, 0.5, 1)">
			Web purple color.
		</constant>
		<constant name="WHEAT" value="Color(0.96, 0.87, 0.7, 1)">
			Wheat color.
		</constant>
		<constant name="WHITE" value="Color(1, 1, 1, 1)">
			White color.
		</constant>
		<constant name="WHITE_SMOKE" value="Color(0.96, 0.96, 0.96, 1)">
			White smoke color.
		</constant>
		<constant name="YELLOW" value="Color(1, 1, 0, 1)">
			Yellow color.
		</constant>
		<constant name="YELLOW_GREEN" value="Color(0.6, 0.8, 0.2, 1)">
			Yellow green color.
		</constant>
	</constants>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<argument index="0" name="right" type="Color" />
			<description>
				Returns [code]true[/code] if the colors are not equal.
				[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
			</description>
		</operator>
		<operator name="operator *">
			<return type="Color" />
			<argument index="0" name="right" type="Color" />
			<description>
				Multiplies each component of the [Color] by the components of the given [Color].
			</description>
		</operator>
		<operator name="operator *">
			<return type="Color" />
			<argument index="0" name="right" type="float" />
			<description>
				Multiplies each component of the [Color] by the given [float].
			</description>
		</operator>
		<operator name="operator *">
			<return type="Color" />
			<argument index="0" name="right" type="int" />
			<description>
				Multiplies each component of the [Color] by the given [int].
			</description>
		</operator>
		<operator name="operator +">
			<return type="Color" />
			<argument index="0" name="right" type="Color" />
			<description>
				Adds each component of the [Color] with the components of the given [Color].
			</description>
		</operator>
		<operator name="operator -">
			<return type="Color" />
			<argument index="0" name="right" type="Color" />
			<description>
				Subtracts each component of the [Color] by the components of the given [Color].
			</description>
		</operator>
		<operator name="operator /">
			<return type="Color" />
			<argument index="0" name="right" type="Color" />
			<description>
				Divides each component of the [Color] by the components of the given [Color].
			</description>
		</operator>
		<operator name="operator /">
			<return type="Color" />
			<argument index="0" name="right" type="float" />
			<description>
				Divides each component of the [Color] by the given [float].
			</description>
		</operator>
		<operator name="operator /">
			<return type="Color" />
			<argument index="0" name="right" type="int" />
			<description>
				Divides each component of the [Color] by the given [int].
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<argument index="0" name="right" type="Color" />
			<description>
				Returns [code]true[/code] if the colors are exactly equal.
				[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
			</description>
		</operator>
		<operator name="operator []">
			<return type="float" />
			<argument index="0" name="index" type="int" />
			<description>
				Access color components using their index. [code]c[0][/code] is equivalent to [code]c.r[/code], [code]c[1][/code] is equivalent to [code]c.g[/code], [code]c[2][/code] is equivalent to [code]c.b[/code], and [code]c[3][/code] is equivalent to [code]c.a[/code].
			</description>
		</operator>
		<operator name="operator unary+">
			<return type="Color" />
			<description>
				Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable.
			</description>
		</operator>
		<operator name="operator unary-">
			<return type="Color" />
			<description>
				Inverts the given color. This is equivalent to [code]Color.WHITE - c[/code] or [code]Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)[/code].
			</description>
		</operator>
	</operators>
</class>