Add Godot's named colors as constants #601
Conversation
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-601 |
godot-core/src/builtin/color.rs
Outdated
|
|
||
| /// Opaque white. | ||
| pub const WHITE: Color = Self::from_rgba(1.0, 1.0, 1.0, 1.0); | ||
| include! {"color_constants.rs"} |
There was a problem hiding this comment.
I think that's the more common usage, also suggested by docs:
| include! {"color_constants.rs"} | |
| include!("color_constants.rs"); |
But I think here we don't even need include, a regular module would also work?
With the mod color_constants; being declared in mod.rs...
Not sure if we can influence this, but if somehow possible, it would be nice to list the constants after the methods in the docs, so that people see the more common used information on top. If needed, we can resort to include! but after the other impl.
You can use the bot's link as a check for the docs, it will be updated with a latency of a few minutes on each push 🙂
fpdotmonkey
force-pushed
the
color-constants
branch
from
85298e1
to
bf71aec
Compare
All named colors were included using values from Godot's color constant docs except for `TRANSPARENT`, which is instead `TRANSPARENT_WHITE`. This is to be more explicit, which here is useful when users are working with gradients or modulations of color. This creates a conflict with `Color::from_string`, which is documented with the colors. `from_string`'s documentation still references Godot's own color constants doc since that represents ground truth. This is executed as a set of hard-coded values because I wasn't keen on spending the time to learn the code gen system. This may later be redone with code gen. Signed-off-by: Jan Haller <bromeon@gmail.com>
Bromeon
force-pushed
the
color-constants
branch
from
bf71aec
to
ee66121
Compare
|
Thanks a lot! There was a small misunderstanding: |
All named colors were included using values from Godot's color constant docs except for
TRANSPARENT, which is insteadTRANSPARENT_WHITE. This is to be more explicit, which here is useful when users are working with gradients or modulations of color. This creates a conflict withColor::from_string, which is documented with the colors.from_string's documentation still references Godot's own color constants doc since that represents ground truth.This is executed as a set of hard-coded values because I wasn't keen on spending the time to learn the code gen system. This may later be redone with code gen.