class_texture3d.rst 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Texture3D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Texture3D:
  6. Texture3D
  7. =========
  8. **Inherits:** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Texture with 3 dimensions.
  10. Description
  11. -----------
  12. Texture3D is a 3-dimensional :ref:`Texture<class_Texture>` that has a width, height, and depth. See also :ref:`TextureArray<class_TextureArray>`.
  13. **Note:** ``Texture3D``\ s can only be sampled in shaders in the GLES3 backend. In GLES2, their data can be accessed via scripting, but there is no way to render them in a hardware-accelerated manner.
  14. Properties
  15. ----------
  16. +-------------------------------------+-------+----------------------------------------------------------------------------------------------------+
  17. | :ref:`Dictionary<class_Dictionary>` | data | ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0}`` *(parent override)* |
  18. +-------------------------------------+-------+----------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | flags | ``4`` *(parent override)* |
  20. +-------------------------------------+-------+----------------------------------------------------------------------------------------------------+
  21. Methods
  22. -------
  23. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`create<class_Texture3D_method_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` flags=4 **)** |
  25. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. Method Descriptions
  27. -------------------
  28. .. _class_Texture3D_method_create:
  29. - void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` flags=4 **)**
  30. Creates the Texture3D with specified ``width``, ``height``, and ``depth``. See :ref:`Format<enum_Image_Format>` for ``format`` options. See :ref:`Flags<enum_TextureLayered_Flags>` enumerator for ``flags`` options.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`