mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
72 lines
3.4 KiB
ReStructuredText
72 lines
3.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture3D.xml.
|
|
|
|
.. _class_CompressedTexture3D:
|
|
|
|
CompressedTexture3D
|
|
===================
|
|
|
|
**Inherits:** :ref:`Texture3D<class_Texture3D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Texture with 3 dimensions, optionally compressed.
|
|
|
|
Description
|
|
-----------
|
|
|
|
``CompressedTexture3D`` is the VRAM-compressed counterpart of :ref:`ImageTexture3D<class_ImageTexture3D>`. The file extension for ``CompressedTexture3D`` files is ``.ctex3d``. This file format is internal to Godot; it is created by importing other image formats with the import system.
|
|
|
|
\ ``CompressedTexture3D`` uses VRAM compression, which allows to reduce memory usage on the GPU when rendering the texture. This also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
|
|
|
|
See :ref:`Texture3D<class_Texture3D>` for a general description of 3D textures.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------+----------------------------------------------------------------+--------+
|
|
| :ref:`String<class_String>` | :ref:`load_path<class_CompressedTexture3D_property_load_path>` | ``""`` |
|
|
+-----------------------------+----------------------------------------------------------------+--------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------+-------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_CompressedTexture3D_method_load>` **(** :ref:`String<class_String>` path **)** |
|
|
+---------------------------------------+-------------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CompressedTexture3D_property_load_path:
|
|
|
|
- :ref:`String<class_String>` **load_path**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+-----------------+
|
|
| *Setter* | load(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_load_path() |
|
|
+-----------+-----------------+
|
|
|
|
The ``CompressedTexture3D``'s file path to a ``.ctex3d`` file.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_CompressedTexture3D_method_load:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Loads the texture from the specified ``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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|