Commit Graph
140 Commits
Author SHA1 Message Date
谢天 6177568e15 Update spatial_shader.rst to delete outdated light shader usage 2024-01-23 10:44:11 +08:00
Hugo Locurcio 95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
谢天 d8f2ce6d6f Update spatial_shader.rst to mention godot use the same VIEW vector for both perspective and orthogonal cameras. 2024-01-03 11:52:08 +08:00
谢天 1c2a030049 Update textureQueryLevels to mention it returns 1 when the texture is unassigned 2023-12-22 14:32:13 +01:00
Hugo Locurcio 59842e9c35 Fix per-instance shader parameter classref link in Shading language 2023-12-16 22:08:28 +01:00
AveMo ebf5a78578 Removed reference to 'DEPTH' in CanvasItem shaders (#8616)
* Remove 'DEPTH' constant from CanvasItem shaders

* Re-added Origin mention
2023-12-13 17:10:56 +01:00
Max Hilbrunner 37a5a9b4f7 Merge pull request #8506 from clayjohn/shaders-CI-particles
Update shader reference pages for canvas_item shaders and particle shaders for 4.2
2023-11-23 13:08:04 +01:00
clayjohn da93553be2 Update shader reference pages for canvas_item shaders and particle shaders for 4.2 2023-11-21 11:43:36 -07:00
tetrapod ab5bba9dfe Removed specular_phong and specular_blinn from spatial_shader.rst 2023-11-19 22:29:25 -08:00
Pikario b65d7cab1b Update the default diffuse mode 2023-11-13 23:34:58 +01:00
kleonc be0806bbc0 Document VERTEX_ID, INSTANCE_ID built-ins for canvas_item vertex shader 2023-11-02 12:35:45 +01:00
Hugo Locurcio 2b3c3c3ef4 Document source_color shader hint being relevant for 2D HDR 2023-11-01 19:25:04 +01:00
Hugo Locurcio 9773552257 Emphasize the importance of mipmaps for textureLod() in Screen-reading shaders
This also mentions that reading the normal/roughness buffer is only
currently supported in Forward+.
2023-10-26 02:32:37 +02:00
Jan Thomä c490d5ede6 fix: vertex coordinates are in canvas space 2023-10-19 17:37:03 +02:00
Max Hilbrunner 20a6f9ea14 Merge pull request #8069 from kb173/master
Add instructions on sky shader optimization
2023-10-03 23:57:21 +02:00
Hex-4andA Thousand Ships 37a96ba407 Close #7690 (add info for shader hints and default values) (#8117)
* add comment for default values

* Add a line telling where the default value goes

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-10-02 10:57:16 +02:00
LandscapeLab Office d1fc885543 Add instructions on sky shader optimization 2023-09-27 14:16:05 +02:00
Rémi Verschelde adbab1482c Merge pull request #6979 from JohanAR/shaderpp_concat
Add concatenation to shader preprocessor
2023-09-27 10:51:36 +02:00
Max Hilbrunner a766184cf1 Merge pull request #8015 from thygrrr/shader-example-lighting-fix
Update spatial_shader.rst
2023-09-27 03:04:25 +02:00
0fe7ff833e Fixed typos in several doc files (#8002)
* Fixed typos in
- c_sharp_differences.rst
- debugger_panel.rst
- gdextension_cpp_example.rst
- gui_using_fonts.rst
- openxr_hand_tracking.rst
- overview_of_debugging_tools.rst
- setting_up_xr.rst
- shading_language.rst
- the_profiler.rst
- your_second_3d_shader.rst

* Update tutorials/shaders/shader_reference/shading_language.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

* PR Feedback

---------

Co-authored-by: Luna <2650849-Lunalicious@users.noreply.gitlab.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-09-25 00:41:33 +02:00
Thygrrr bd7eb30f29 Update spatial_shader.rst
The reference page suggests a very unfortunate lighting function that modulades the color values in ALBEDO again. This does not seem representative of the shading model.

Also, it omitted LIGHT_COLOR; repalcing the ALBEDO term with LIGHT_COLOR gives a much more expected diffuse lighting example.
2023-09-23 13:00:40 +02:00
Max Hilbrunner 8b4cc3b229 Merge pull request #7897 from TidB/master
Fix SIZE built-in in fog shader reference
2023-09-13 04:16:06 +02:00
TidB 4d22f09704 Fix SIZE built-in in fog shader reference
It has been renamed from EXTENTS; while its description was completely unrelated (copied from the sky shader reference)
2023-09-09 14:39:15 +02:00
Milan Gruner ed7b0374cc Add documentation for render mode fog_disabled and Disable Fog in BaseMaterial3D 2023-09-05 21:44:20 +02:00
Johan Aires Rastén d3f86dc941 Add concatenation to shader preprocessor 2023-08-16 16:42:09 +02:00
Max Hilbrunner 1442ace7a5 Merge pull request #7560 from cridenour/patch-1 2023-07-18 13:43:49 +02:00
Max Hilbrunner fa01e18ae3 Merge pull request #7655 from Calinou/fix-backticks 2023-07-18 13:21:11 +02:00
Bruno ca634145ac Update particle_shader.rst 2023-07-18 00:31:49 -06:00
BrunoandClay John f2bfa933a2 Update tutorials/shaders/shader_reference/particle_shader.rst
Co-authored-by: Clay John <claynjohn@gmail.com>
2023-07-17 22:59:00 -06:00
Bruno a88b6888b7 add USERDATA* built in reference 2023-07-17 00:43:33 -06:00
Hugo Locurcio df904137db Fix incorrect usage of backticks in various pages 2023-07-14 19:31:01 +02:00
Matthew d3d680729e Merge pull request #7561 from Calinou/spatial-shader-light-color-pi-multiplier
Document `LIGHT_COLOR` being multiplied by `PI` in Spatial shader
2023-07-05 20:10:53 -04:00
ffernn 2076e147c2 Added sky and fog shaders the the "Built-in variables" section 2023-06-28 17:47:02 +10:00
Hugo Locurcio f57bdb3758 Document LIGHT_COLOR being multiplied by PI in Spatial shader 2023-06-26 10:12:28 +02:00
Chris Ridenour 2bea88b4ea Fix OBJECT_POSITION description to match engine behavior. 2023-06-25 23:34:26 -04:00
Curry a86f24f098 Update spatial_shader.rst
Changes WORLD_NORMAL_MATRIX to MODEL_NORMAL_MATRIX
2023-06-14 04:25:16 +10:00
bitsawer b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2023-05-29 17:53:09 +03:00
Alex EsandMax Hilbrunner c3cda2cf50 Update descriptions and types for CanvasItem built-ins (#7283)
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-05-17 10:29:18 +02:00
Johan Aires Rastén d3f0ec6c3a Add SPECULAR_AMOUNT spatial light shader built-in 2023-05-04 09:45:05 +02:00
Johan 930ad1f77b Add LIGHT_IS_DIRECTIONAL built-in for spatial shaders (#7194) 2023-04-26 10:23:20 -07:00
Max Hilbrunner 628d4f94d2 Complete render modes list in shaders docs 2023-04-14 03:19:55 +02:00
Bastiaan Olij e36ef29eba Add descriptions of multiview build-ins and EYE_OFFSET to shader reference 2023-04-14 02:47:57 +02:00
Alfonso Arbona Gimeno a9076972a7 Fix small typos in the particle shader doc
A word was missing a letter and a description had a wrongly capitalized word. Now it matches the rest of the document
2023-04-09 04:43:06 +00:00
Tom McLeanandClay John 78b978c9bd Fix references to DEPTH_TEXTURE and SCREEN_TEXTURE (#7119)
* Fix references to DEPTH_TEXTURE

---------

Co-authored-by: Clay John <claynjohn@gmail.com>
2023-04-07 18:32:25 +02:00
Hugo Locurcio 96eb7d05ff Document SDFGI sharp reflections only working on opaque materials
Transparent materials only use rough reflections, likely for
performance reasons.
2023-03-24 21:08:25 +01:00
Max Hilbrunner 292804554e Merge pull request #6974 from hmans/improve-shader-include-docs
Improve shader #include documentation
2023-03-19 02:11:35 +01:00
clayjohn 0c8c8feb72 Explain the start and process functions for particle shaders
Add references in the particle shader doc and the migration guide
2023-03-17 12:28:23 -07:00
Hendrik Mans 57a1bce6e2 Fix typo ("blackslash") on shader preprocessor page 2023-03-13 11:33:10 +01:00
Hendrik Mans 6360ebc73c Improve shader #include documentation 2023-03-13 11:29:37 +01:00
Hugo LocurcioandMax Hilbrunner 17e6a5f7bb Mention function overloading not being supported in Shading language (#6940)
* Mention function overloading not being supported in Shading language

This also adds a performance note for `discard`.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-03-13 02:25:17 +01:00