Commit Graph

76 Commits

Author SHA1 Message Date
aeabd3dcb9 Merge pull request #64740 from Calinou/doc-anisotropic-filter-3.x
Improve documentation related to anisotropic filtering (3.x)
2022-08-23 09:16:55 +02:00
812caa5f44 Merge pull request #58601 from Calinou/material-triplanar-sharpness-clamp-3.x 2022-08-22 22:21:59 +02:00
d2ef3bf8a6 Improve documentation related to anisotropic filtering 2022-08-22 18:40:40 +02:00
ef7502e1d4 Merge pull request #50540 from Calinou/material-hide-triplanar-subproperties-when-disabled-3.x 2022-08-05 19:39:19 +02:00
0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
dc6d8d6098 Backport Label3D node implementation and Sprite*3D material render priority. 2022-05-23 09:14:41 +03:00
4e6dfac969 Improve documentation related to 3D material vertex lighting 2022-03-31 18:11:18 +02:00
b087538119 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-03-16 23:01:02 +01:00
967821f719 Clamp SpatialMaterial triplanar sharpness to values that never look broken 2022-02-27 18:58:22 +01:00
a28955ac46 Fix normal map description
(cherry picked from commit d856074488)
2022-01-12 17:34:56 +01:00
defb801120 i18n: Sync classref translations with current 3.x codebase 2022-01-07 13:34:14 +01:00
9937f7f50d Document the expected format of anisotropy flowmaps in SpatialMaterial 2021-12-31 17:29:03 +01:00
3ac2999f22 Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
4c710780d4 Implement async shader compilation plus caching for GL ES 3
Async. compilation via ubershader is currently available in the scene and particles shaders only.

Bonus:
- Use `#if defined()` syntax for not true conditionals, so they don't unnecessarily take a bit in the version flagset.
- Remove unused `ENABLE_CLIP_ALPHA` from scene shader.
- Remove unused `PARTICLES_COPY` from the particles shader.
- Remove unused uniform related code.
- Shader language/compiler: use ordered hash maps for deterministic code generation (needed for caching).
2021-11-09 12:19:12 +01:00
14c366ddd7 Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
c7eb3d25e7 doc: Fix style inconsistencies for [b]Note:[/b] paragraphs
(cherry picked from commit 788b3aa27a)
2021-10-06 09:29:32 +02:00
ebdbace62a Document that tangents are required for normal mapping in SpatialMaterial 2021-10-01 19:05:58 +02:00
33d23281cb Allow clearcoat, anisotropy and refraction in SpatialMaterial in GLES2
These SpatialMaterial features work just fine in GLES2,
but they were not exposed in the inspector when GLES2 was used.
2021-08-22 02:18:36 +02:00
f0b37b1519 doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
f5836b40d4 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.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:20:19 +02:00
c2e93a5e4d Hide triplanar sharpness when triplanar is disabled in SpatialMaterial
The Triplanar Sharpness property has no effect when Triplanar
is disabled.
2021-07-17 06:47:15 +02:00
8df0e61cc2 Document that clearcoat/rim lighting is not visible on unshaded materials 2021-04-28 17:40:14 +02:00
c3272997cd doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
015973df04 doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
1aba997d75 doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
d72dcf5b24 Document that SpatialMaterial doesn't support depth mapping + triplanar
See #44322.
2020-12-12 17:11:50 +01:00
4287af5148 doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
52b3324e58 doc: Improve distance_fade documentation
Changed the documentation of distance_fade_max_distance and min
to be consistent with the behavior of the code as well as the user
documentation. Also noted the behavior of swapping max_distance and
min_distance (where max_distance < min_distance).

Fixes #36051.

Co-authored-by: Clay John <claynjohn@gmail.com>
(cherry picked from commit 90d1eda90e)
2020-09-29 13:57:58 +02:00
00e4be1926 Document the BaseMaterial3D billboard mode not being suited for VR
See #41567.

(cherry picked from commit ecc47ce235)
2020-09-29 13:57:57 +02:00
2293cf61c6 Document the expected normal map coordinate system where relevant
(cherry picked from commit d8808fba85)
2020-05-05 13:41:29 +02:00
31506ebe85 updated description of metallic in SpatialMaterial 2020-02-12 15:05:49 +01:00
658e44ee01 doc: Sync classref with current source
Fix a few typos.
2020-01-28 10:58:48 +01:00
2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
6b66957b85 Finish documenting CSG* and *probes 2020-01-23 13:54:17 +01:00
ba177ccaec doc: Misc updates for AnimationNode* and others
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
2020-01-23 12:37:33 +01:00
f2ece82480 Finish up docs for materials 2020-01-21 19:28:32 -08:00
07e289963c doc: Sync classref with current source 2019-07-22 12:27:52 +02:00
efd55631e2 doc: Sync classref with current source 2019-07-15 20:45:30 +02:00
542489a866 DocData: Re-expose parametric setters and getters
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.

For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00
a78373ddc2 doc: Remove null default values that can't be determined
Applying #30187.
2019-06-30 13:58:07 +02:00
b9aa13e591 doc: Remove hardcoded default values from descriptions
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
c6cea6e9b3 doc: Add default values to all properties
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-30 13:58:07 +02:00
f7f6115f76 Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
86ed7a9884 doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00
3a365c1fc0 doc: Sync classref with current source 2019-05-28 18:08:13 +02:00
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
daa9092ed3 doc: Sync classref with current source 2018-11-20 09:34:45 +01:00
0babb60c74 doc: Sync classref with current source 2018-11-10 20:21:34 +07:00