godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Viewport Usage enumeration 

Mention that 3D effects are not available when using USAGE_2D
This commit is contained in:
Yetizone 2020-08-20 14:29:30 +03:00
parent 9bf5a0b791
commit 5bc06c7014
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/Viewport.xml
View File

@ -415,10 +415,10 @@
Use 16x Multisample Antialiasing. Likely unsupported on medium and low-end hardware.
</constant>
<constant name="USAGE_2D" value="0" enum="Usage">
Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes.
Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes. Note that 3D rendering effects such as glow and HDR are not available when using this mode.
</constant>
<constant name="USAGE_2D_NO_SAMPLING" value="1" enum="Usage">
Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the [enum Usage] types, this requires the least VRAM.
Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the [enum Usage] types, this requires the least VRAM. Note that 3D rendering effects such as glow and HDR are not available when using this mode.
</constant>
<constant name="USAGE_3D" value="2" enum="Usage">
Allocates full buffers for drawing 3D scenes and all 3D effects including buffers needed for 2D scenes and effects.