46e40969a2
Replace the term "color space" with "color encoding". Add additional detail to Color class description. State clearly that Color is expected to use the nonlinear sRGB transfer function.
2025-09-15 18:11:53 -04:00
15de1d6c35
Use Grisu2 algorithm in String::num_scientific to fix serializing
2025-05-22 09:13:16 -07:00
f6515161e1
Add color space alpha notes to Color documentation
2025-04-09 01:25:05 -07:00
4e48b19e1f
Add Color.from_rgba8 and deprecate Color8
2024-12-27 11:26:59 +01:00
85c5a4f058
Merge pull request #98499 from tetrapod00/docs-dotnet-constructor-differences
...
Docs: Add notes about C# differences in Variant constructors
2024-11-11 14:18:22 -06:00
30d87229ed
Merge pull request #82845 from Hysterelius/master
...
Color: Expose OKHSL properties
2024-11-11 14:18:04 -06:00
2126df2dfd
Color: Expose OKHSL properties
2024-11-11 20:41:57 +01:00
c51cdaf006
Docs: Add note about C# differences in Variant constructors
2024-10-27 13:24:26 -07:00
7cc0df6b46
Document alternatives to some static Color methods
2024-07-28 17:30:02 +02:00
aa9bd34d68
mention inverse of hex functions in Color.xml
2024-06-16 08:38:02 +02:00
c83718624f
Update links to outdated asset library demos
...
Update links to outdated asset library demos
Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com >
2024-04-07 16:59:43 +02:00
24c9d442e9
[Doc] Fix some incorrect uses of a/an
2024-03-13 21:20:28 +01:00
f781571d07
Add keywords to improve search in the class reference
2024-02-22 16:16:49 +01:00
0e977e087c
Fix docs for Color class regarding bits per component.
...
This fixes godot-docs#8906 ( https://github.com/godotengine/godot-docs/issues/8906 )
2024-02-05 12:55:58 -05:00
d026b37abd
Fix various typos in classref
2023-08-22 18:05:50 +08:00
81064cc239
Doctool: Remove version attribute from XML header
...
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b
Bump version to 4.2-dev
...
Keep on waitin'
2023-07-05 22:07:03 +02:00
779ac20bb9
Clarify doc for Color.hex and C# Color()
...
The "alpha channel first" seems misleading to me. It doesn't match with
the examples, so remove it. Add a more detailed specification of the
expected number format in hex.
2023-05-30 15:15:04 +02:00
04562662d3
Overhaul the top sections of the class reference (Core classes)
2023-05-19 07:04:48 +02:00
f83a90192f
Revert "Add API for HSL conversion"
...
This reverts commit 0b7fd664c1
2023-05-10 17:45:56 -03:00
0b7fd664c1
Add API for HSL conversion
...
Math ported pretty much 1:1 from https://en.wikipedia.org/wiki/HSL_and_HSV
Style doesn't match the existing HSV code exactly, but should be close enough.
2023-05-09 17:43:10 +02:00
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
43f62a588b
More class reference fixes
...
Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 10:42:44 +08:00
8d0078873a
Fix incorrect format in Color documentation
2023-02-14 10:27:43 +01:00
7eb8325180
Fix C# examples in documentation
...
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
5b1df48c6c
Convert en_GB spelling to en_US with codespell
2023-01-23 11:02:20 +01:00
d843a7ab97
C#: Synchronize Color with Core
...
- Add `Luminance` readonly property.
- Add `LinearToSrgb` and `SrgbToLinear` static methods.
- Add `FromOkHsl` static method.
- Add `FromRgbe9995` static method.
- Add `FromString` static method.
- Expose `FromHtml` static method.
- Expose `HtmlIsValid` static method.
- Add and update some Color documentation.
2022-12-16 03:04:05 +01:00
6c6c8c2bc7
Tweak Color Documentation
2022-12-05 17:15:59 +01:00
f7c611ab71
Style: Misc docs and comment style and language fixes
...
- Removed empty paragraphs in XML.
- Consistently use bold style for "Example:", on a new line.
- Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`).
- Fix invalid usage of backticks for inline code in BBCode.
- Fix some American/British English spelling inconsistencies.
- Other minor fixes spotted along the way, including typo fixes with codespell.
- Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-02 19:01:18 +01:00
653e8f5c86
Remove internal functions of named colors from the public API
2022-10-21 11:21:43 +03:00
1b7aee3c8d
Fill random docs
2022-10-07 20:10:18 +02:00
d32803fdd6
[doc] Use "param" instead of "code" to refer to parameters (7)
2022-08-12 13:19:48 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
c8ce7e34e2
i18n: Misc fixes translation strings
...
Adds some translator comments to solve some questions raised on Weblate.
2022-06-08 12:57:54 +02:00
1b776a6e7a
Allow picking similar colours using OKHSL.
2022-06-07 05:53:27 -07:00
46ef52162e
Color: Rename to_srgb/to_linear to include base color space
...
This helps reduce confusion around sRGB <> Linear conversions by making
both input and output color spaces explicit.
2022-04-13 11:45:52 +02:00
1c343cd54d
Expose Color's to_linear() and to_srgb() to scripting
2022-03-28 12:17:55 +02:00
8ed8a7a22b
doc: Sync missing Color value update after #59229
...
Missed in CI as the Mono build where this is checked is temporarily disabled.
2022-03-17 19:53:10 +01:00
32f2c47356
Remove generating of null comparison operators from documentation
2022-03-14 22:35:23 +03:00
b68dd2e189
Add an XML schema for documentation
...
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.
Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
d5ea8547d6
Correct C# code example in Color class reference
...
Correct C# example code for html method in the Color class reference.
2022-02-09 20:26:51 +11:00
acd562be5d
Add method descriptions to Color Class Reference
...
Add definitions and code examples for the html and html_is_valid methods
2022-02-08 16:37:11 +11:00
3ec5a5fb5c
Alpha channel indicates opacity, not transparency
2021-12-24 16:52:15 +08:00
1fb59d13c2
Fix font preview text color on light background
2021-12-18 00:34:28 +08:00
471e7cbfc7
Merge pull request #54581 from aaronfranke/operator-docs
2021-11-16 14:10:09 +01:00
e2e9b08cc7
Color: Bind from_hsv as static method
2021-11-11 11:50:02 +01:00
813466b3c8
Add documentation to operators for math types
...
Co-authored-by: Raul Santos <raulsntos@gmail.com >
2021-11-04 14:44:55 -05:00
6772ebcea0
Move the docs for constructors and operators out of methods section
2021-10-29 12:34:57 -05:00
455e142d37
Allow comparing equality between builtin types and null
2021-09-17 12:33:52 -03:00
7adf4cc9b5
doc: Use self-closing tags for return and argument
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
