Commit Graph

51 Commits

Author SHA1 Message Date
b50d954cb0 Update many docs with recent rendering changes 2020-04-17 09:47:59 -07:00
d9a560d783 doc: Sync classref with current source 2020-04-03 10:11:23 +02:00
e5033d3952 doc: Sync classref with DisplayServer/Window changes 2020-03-31 11:56:58 +02:00
eaaee63b62 doc: Update classref with node renames
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
e103f21a40 Add LOTS of missing docs 2020-03-13 16:35:03 +01:00
0e3d625737 doc: Sync classref with current source
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.

Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08: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
afe39525fd Improve the Environment class documentation
Co-authored-by: Clay John <claynjohn@gmail.com>
2020-01-08 20:34:57 +01:00
4fbcc19853 Complete the Environment class documentation
This closes #34846.
2020-01-07 17:41:17 +01:00
4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
639c9b3a35 Only display Environment sky rotation in degrees in the Inspector
This makes it consistent with Spatial.
2019-11-26 18:57:29 +01:00
afaa68628a updated defaults and documentation for GLES2 glow 2019-10-01 07:55:04 -07:00
aa3ef8893b Removed clamping of the Linear tonemapping when KEEP_3D_LINEAR
Changed the behaviour of the Linear tonemapping operator to not clamp to [0, 1] range
in the case when KEEP_3D_LINEAR is defined. This allows to render values > 1.0 in
floating point texture targets (via Viewport) for further processing or saving high
dynamic range data into files. This only works when no color conversion is active.
2019-08-29 18:14:19 +02:00
bc1b2b96e1 Tweak the default fog depth end to use a fixed value
The previous value (0) was a special case in the fog shader.
It made the shader use the Camera's `far` value as the fog depth end
value, which led to an inconsistency in the fog rendering between
the editor and a running project. This is because the editor camera
uses a `far` property of 500 by default, whereas the Camera node's
`far` property is set to 100 by default.

The new fixed value is equal to the default `far` property in Camera,
which leads to a consistent appearance between the editor and a running
project.

This closes #31686.
2019-08-27 18:32:05 +02:00
d1a35b5a97 Invert and adjust the default fog height values
This makes height fog appear at the bottom of the scene
(instead of the top), which is generally the expected result.

This also tweaks the fog height setting hint to be more flexible.

This closes #30709.
2019-08-07 18:21:44 +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
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
02ea99129e Adding a new Camera Server implementation to Godot.
This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server.
Other parts of Godot can interact with this to obtain images from the camera as textures.
This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2019-06-15 21:30:32 +10:00
e1e3fcc908 doc: Fix DocData.merge_from copying old setters and getters
This is not necessary and means that some setters and getters
can end up wrong if they are changed in the bindings but DocData
does not update them when running --doctool.

Fixes #29425.

Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2019-06-03 13:03:05 +02:00
ab4705a807 Merge pull request #28125 from KoBeWi/code_true_code
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
b0846f60c9 Consistently wrap booleans in [code] 2019-04-17 17:13:00 +02:00
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
f3dd3c0830 Adding option to re-orient our sky 2018-12-15 19:41:34 +11:00
8fda8769d1 doc: Sync classref with current source 2018-12-04 21:57:07 +01:00
9b461af90c doc: Indentation fixups 2018-11-20 10:18:11 +01:00
daa9092ed3 doc: Sync classref with current source 2018-11-20 09:34:45 +01:00
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch
Fixes #23509.
2018-11-05 08:46:27 +01:00
391e46830f doc: Sync classref with current source
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
98b59cf2a3 Add support for tutorial links to makerst.py
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
c90f18e3f5 [DOCS] Environment: Whitespace fixes 2018-03-13 21:24:17 +01:00
3fa77b3172 doc: Remove status from hardcoded version string
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
3c7a39b40c doc: Update version string in header 2018-02-19 10:46:33 +01:00
f2e3825616 doc: Fix references to online tutorials after godotengine/godot-docs#1015 2018-01-25 09:03:59 +01:00
d516aab8fa doc: Sync with current source
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
6c46787749 doc: Replace some more "val" with "value" + sync 2018-01-17 10:43:23 +01:00
03475ba197 Filled tutorial field in most relevent classes.
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
7dfba3cda9 doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00
92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +01:00
bc75fae579 doc: Update header version for 3.0-beta 2017-11-24 09:16:52 +01:00
967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
552ed07cfd classref: Sync with current source
[ci skip]
2017-10-24 19:22:43 +02:00
b1f2c31a36 doc: Sync classref with current source
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
75d95fca79 Partial documentation for Environment resource. 2017-09-23 16:18:35 +02:00
a4005221f5 doc: Sync classref with current source
[ci skip]
2017-09-13 08:53:01 +02:00