stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (7d9923b2e)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-11-17 21:03:53 +01:00
parent c2d9bd8436
commit 34089af20f
256 changed files with 8630 additions and 715 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_compressedtexturelayered.rst
+21
View File
@@ -14,7 +14,24 @@ CompressedTextureLayered
**Inherited By:** :ref:`CompressedCubemap<class_CompressedCubemap>`, :ref:`CompressedCubemapArray<class_CompressedCubemapArray>`, :ref:`CompressedTexture2DArray<class_CompressedTexture2DArray>`
Base class for texture arrays that can optionally be compressed.
Description
-----------
A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. :ref:`CompressedTexture2D<class_CompressedTexture2D>` can use one of 4 compresson methods:
- Uncompressed (uncompressed on the GPU)
- Lossless (WebP or PNG, uncompressed on the GPU)
- Lossy (WebP, uncompressed on the GPU)
- VRAM Compressed (compressed on the GPU)
Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
Properties
----------
@@ -45,6 +62,8 @@ Property Descriptions
| *Getter* | get_load_path() |
+-----------+-----------------+
The path the texture should be loaded from.
Method Descriptions
-------------------
@@ -52,6 +71,8 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
Loads the texture at ``path``.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`