asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Expose Color's to_linear() and to_srgb() to scripting

Browse source
This commit is contained in:
Hugo Locurcio 2022-03-24 01:24:00 +01:00 committed by Rémi Verschelde
parent 01f34495bf
commit 1c343cd54d
3 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
core/variant/variant_call.cpp
View file

@ -1656,6 +1656,8 @@ static void _register_variant_builtin_methods() {
bind_method(Color, darkened, sarray("amount"), varray());
bind_method(Color, blend, sarray("over"), varray());
bind_method(Color, get_luminance, sarray(), varray());
bind_method(Color, to_linear, sarray(), varray());
bind_method(Color, to_srgb, sarray(), varray());
bind_method(Color, is_equal_approx, sarray("to"), varray());

13
doc/classes/Color.xml
View file

@ -183,6 +183,7 @@
<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.
[b]Note:[/b] [method get_luminance] relies on the colour being in the linear color space to return an accurate relative luminance value. If the color is in the sRGB color space, use [method to_linear] to convert it to the linear color space first.
</description>
</method>
<method name="get_named_color" qualifiers="static">
@ -404,6 +405,12 @@
[/codeblocks]
</description>
</method>
<method name="to_linear" qualifiers="const">
<return type="Color" />
<description>
Returns the color converted to the linear color space. This assumes the original color is in the sRGB color space. See also [method to_srgb] which performs the opposite operation.
</description>
</method>
<method name="to_rgba32" qualifiers="const">
<return type="int" />
<description>
@ -436,6 +443,12 @@
[/codeblocks]
</description>
</method>
<method name="to_srgb" qualifiers="const">
<return type="Color" />
<description>
Returns the color converted to the [url=https://en.wikipedia.org/wiki/SRGB]sRGB[/url] color space. This assumes the original color is in the linear color space. See also [method to_linear] which performs the opposite operation.
</description>
</method>
</methods>
<members>
<member name="a" type="float" setter="" getter="" default="1.0">

18
tests/core/math/test_color.h
View file

@ -144,6 +144,24 @@ TEST_CASE("[Color] Conversion methods") {
"The string representation should match the expected value.");
}
TEST_CASE("[Color] Linear <-> sRGB conversion") {
const Color color = Color(0.35, 0.5, 0.6, 0.7);
const Color color_linear = color.to_linear();
const Color color_srgb = color.to_srgb();
CHECK_MESSAGE(
color_linear.is_equal_approx(Color(0.100481, 0.214041, 0.318547, 0.7)),
"The color converted to linear color space should match the expected value.");
CHECK_MESSAGE(
color_srgb.is_equal_approx(Color(0.62621, 0.735357, 0.797738, 0.7)),
"The color converted to sRGB color space should match the expected value.");
CHECK_MESSAGE(
color_linear.to_srgb().is_equal_approx(Color(0.35, 0.5, 0.6, 0.7)),
"The linear color converted back to sRGB color space should match the expected value.");
CHECK_MESSAGE(
color_srgb.to_linear().is_equal_approx(Color(0.35, 0.5, 0.6, 0.7)),
"The sRGB color converted back to linear color space should match the expected value.");
}
TEST_CASE("[Color] Named colors") {
CHECK_MESSAGE(
Color::named("red").is_equal_approx(Color::hex(0xFF0000FF)),