Add GradientTexture2D #2 #53234

Geometror · 2021-09-29T18:58:58Z

Co-authored-by:
Mariano Suligoy marianognu.easyrpg@gmail.com
Andrii Doroshenko xrayez@gmail.com

This PR is essentially rebased version of #42855 slightly modified. Thanks to @Xrayez and @MarianoGnu for their awesome work!
I created a new icon for the GradientTexture2D which fits better in the current icon style and ported goostengine/goost@c9ff44d over. In addition, high dynamic range is now supported via the use_hdr property (like with GradientTexture).
Although this is already implemented in Goost I believe this should be a part of the vanilla engine since it is really nice to work with and accelerates the workflow immensely in many cases/makes some things possible which couldn't be achieved without high efforts before. (useful for Light2D, backgrounds, particles, etc.)

Implements godotengine/godot-proposals#1677, closes godotengine/godot-proposals#3240 (discussed via chat that the texture is enough)

Some examples/use cases:

Here is an animated example (the text infill is also dynamic):

Feedback is welcome :)
Also: Any thoughts on whether GradientTexture should be renamed to GradientTexture1D?

groud

I did not go into the details of the implementation, but the API looks fine and the feature seems a good addition to me.

kleonc · 2021-09-29T19:49:09Z

scene/resources/texture.cpp

+					wd8[(x + (y * width)) * 4 + 0] = uint8_t(CLAMP(c.r * 255.0, 0, 255));
+					wd8[(x + (y * width)) * 4 + 1] = uint8_t(CLAMP(c.g * 255.0, 0, 255));
+					wd8[(x + (y * width)) * 4 + 2] = uint8_t(CLAMP(c.b * 255.0, 0, 255));
+					wd8[(x + (y * width)) * 4 + 3] = uint8_t(CLAMP(c.a * 255.0, 0, 255));


Casting like uint8_t(...) will trim the fractional part which means that with the current implementation only values >= 1.0 would result in 255 value (so for example 0.999 would result in 254). I doubt that's desired. So probably ~~it should be~~ (using round() as mentioned in the comment below would be better):

Suggested change

wd8[(x + (y * width)) * 4 + 0] = uint8_t(CLAMP(c.r * 255.0, 0, 255));

wd8[(x + (y * width)) * 4 + 1] = uint8_t(CLAMP(c.g * 255.0, 0, 255));

wd8[(x + (y * width)) * 4 + 2] = uint8_t(CLAMP(c.b * 255.0, 0, 255));

wd8[(x + (y * width)) * 4 + 3] = uint8_t(CLAMP(c.a * 255.0, 0, 255));

wd8[(x + (y * width)) * 4 + 0] = uint8_t(CLAMP(c.r * 256.0, 0, 255));

wd8[(x + (y * width)) * 4 + 1] = uint8_t(CLAMP(c.g * 256.0, 0, 255));

wd8[(x + (y * width)) * 4 + 2] = uint8_t(CLAMP(c.b * 256.0, 0, 255));

wd8[(x + (y * width)) * 4 + 3] = uint8_t(CLAMP(c.a * 256.0, 0, 255));

It would divide <0.0, 1.0> range into 256 equal length ranges (up to the precision errors) so for example values from range (more or less) <0.99609375, 1.0> would result in 255 value.

Yeah but this is how Image does it currently.

Perhaps have to use round() in those cases?: #47022 (comment) (it would be less efficient I presume).

I would keep it like that at least for now since it is consistent with Image and GradientTexture(1D) and discuss/tackle this problem in a future PR (for all occurrences).

Yeah but this is how Image does it currently.

Hmm, then maybe it's indeed a desired behavior? Not sure. But yeah, in this PR it can be made consistent with the rest of the code base then (and potential change could be made in a different PR).

Perhaps have to use round() in those cases?: #47022 (comment) (it would be less efficient I presume).

After rethinking using round() would indeed be better then what I proposed here, it would result in a smaller average absolute "conversion error". And performance wise I guess it shouldn't be a big difference, it's probably just an additional + 0.5 instruction before the truncation (but it probably should be benchmarked).

Anyway, I agree with both of you, it's out of scope of this PR.

fire

I did not go into details, but previous versions were approved by me.

fire · 2021-09-29T22:16:16Z

Your code/doc changes are incomplete and you should update the class reference with --doctool.

Geometror · 2021-09-29T22:37:51Z

Added the use_hdr property to allow for high dynamic range gradients (and for consistency, since GradientTexture (1D) has it).

AaronRecord · 2021-10-05T01:36:00Z

scene/resources/texture.cpp

+		image->create(width, height, false, (use_hdr) ? Image::FORMAT_RGBAF : Image::FORMAT_RGBA8);
+		Color color;
+		if (gradient->get_points_count() == 1) {
+			color = gradient->get_color(0);
+		} else {
+			color = Color(0, 0, 0, 1);
+		}
+		image->fill(color);


Suggested change

image->create(width, height, false, (use_hdr) ? Image::FORMAT_RGBAF : Image::FORMAT_RGBA8);

Color color;

if (gradient->get_points_count() == 1) {

color = gradient->get_color(0);

} else {

color = Color(0, 0, 0, 1);

}

image->fill(color);

image->create(width, height, false, use_hdr ? Image::FORMAT_RGBAF : Image::FORMAT_RGBA8);

if (gradient->get_points_count() == 1) {

image->fill(gradient->get_color(0));

}

Or if black is preferred over transparent:

Suggested change

image->create(width, height, false, (use_hdr) ? Image::FORMAT_RGBAF : Image::FORMAT_RGBA8);

Color color;

if (gradient->get_points_count() == 1) {

color = gradient->get_color(0);

} else {

color = Color(0, 0, 0, 1);

}

image->fill(color);

image->create(width, height, false, use_hdr ? Image::FORMAT_RGBAF : Image::FORMAT_RGBA8);

image->fill(gradient->get_points_count() == 1 ? gradient->get_color(0) : Color(0, 0, 0, 1));

Just a suggestion

Changed it to your two-line-approach, however I kept the braces around the condition of the ternary operator since that seems to be an unwritten rule of Godot's code style guidelines.

Co-authored-by: Mariano Javier Suligoy <marianognu.easyrpg@gmail.com> Co-authored-by: Andrii Doroshenko <xrayez@gmail.com>

Chaosus · 2021-10-29T15:59:46Z

Thanks!

kleonc · 2021-11-03T12:44:41Z

Anything against backporting it to 3.x?

AaronRecord · 2021-11-03T13:37:45Z

Anything against backporting it to 3.x?

Probably not, it doesn't change any existing code and I don't think it relies on any 4.0 exclusive features

TackerTacker · 2022-01-14T09:02:54Z

Would it be possible to have textured gradients?
A gradient where you use textures instead of a colors.

Xrayez · 2022-01-14T12:02:05Z

You can use GradientTexture2D to apply a color gradient over a texture by blending them (via shaders or built-in materials), apart from that the GradientTexture2D handles color gradients only.

If you have a concrete example to show, feel free to create a discussion at https://github.com/godot-extended-libraries/godot-ideas

Geometror requested review from a team as code owners September 29, 2021 18:58

Geometror force-pushed the gradient-texture-2d branch from 619cd5d to 43cf288 Compare September 29, 2021 19:07

Calinou added enhancement topic:core labels Sep 29, 2021

Calinou added this to the 4.0 milestone Sep 29, 2021

groud approved these changes Sep 29, 2021

View reviewed changes

kleonc reviewed Sep 29, 2021

View reviewed changes

Geometror force-pushed the gradient-texture-2d branch from 43cf288 to e118505 Compare September 29, 2021 21:29

fire approved these changes Sep 29, 2021

View reviewed changes

Geometror force-pushed the gradient-texture-2d branch from e118505 to d3b9023 Compare September 29, 2021 22:35

kleonc approved these changes Oct 2, 2021

View reviewed changes

AaronRecord reviewed Oct 5, 2021

View reviewed changes

Geometror force-pushed the gradient-texture-2d branch 3 times, most recently from 7920eaa to 72944fe Compare October 12, 2021 14:02

Add GradientTexture2D

cd37af4

Co-authored-by: Mariano Javier Suligoy <marianognu.easyrpg@gmail.com> Co-authored-by: Andrii Doroshenko <xrayez@gmail.com>

Geometror force-pushed the gradient-texture-2d branch from 72944fe to cd37af4 Compare October 12, 2021 14:22

AaronRecord mentioned this pull request Oct 19, 2021

Add a way to use a mathematically defined PointLight2D texture godotengine/godot-proposals#3444

Closed

Chaosus merged commit bc17197 into godotengine:master Oct 29, 2021

AaronRecord mentioned this pull request Nov 10, 2021

Backport GradientTexture2D to 3.x #54824

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GradientTexture2D #2 #53234

Add GradientTexture2D #2 #53234

Geometror commented Sep 29, 2021 •

edited

Loading

groud left a comment

kleonc Sep 29, 2021 •

edited

Loading

Xrayez Sep 29, 2021

Geometror Oct 2, 2021

kleonc Oct 2, 2021

fire left a comment

fire commented Sep 29, 2021

Geometror commented Sep 29, 2021

AaronRecord Oct 5, 2021 •

edited

Loading

Geometror Oct 9, 2021 •

edited

Loading

Chaosus commented Oct 29, 2021

kleonc commented Nov 3, 2021

AaronRecord commented Nov 3, 2021

TackerTacker commented Jan 14, 2022

Xrayez commented Jan 14, 2022

Add GradientTexture2D #2 #53234

Add GradientTexture2D #2 #53234

Conversation

Geometror commented Sep 29, 2021 • edited Loading

groud left a comment

Choose a reason for hiding this comment

kleonc Sep 29, 2021 • edited Loading

Choose a reason for hiding this comment

Xrayez Sep 29, 2021

Choose a reason for hiding this comment

Geometror Oct 2, 2021

Choose a reason for hiding this comment

kleonc Oct 2, 2021

Choose a reason for hiding this comment

fire left a comment

Choose a reason for hiding this comment

fire commented Sep 29, 2021

Geometror commented Sep 29, 2021

AaronRecord Oct 5, 2021 • edited Loading

Choose a reason for hiding this comment

Geometror Oct 9, 2021 • edited Loading

Choose a reason for hiding this comment

Chaosus commented Oct 29, 2021

kleonc commented Nov 3, 2021

AaronRecord commented Nov 3, 2021

TackerTacker commented Jan 14, 2022

Xrayez commented Jan 14, 2022

Geometror commented Sep 29, 2021 •

edited

Loading

kleonc Sep 29, 2021 •

edited

Loading

AaronRecord Oct 5, 2021 •

edited

Loading

Geometror Oct 9, 2021 •

edited

Loading