class_gltftexture.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFTexture.xml.
  6. .. _class_GLTFTexture:
  7. GLTFTexture
  8. ===========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to **GLTFTexture** within a script will cause an error in an exported project.
  14. .. rst-class:: classref-reftable-group
  15. Properties
  16. ----------
  17. .. table::
  18. :widths: auto
  19. +-----------------------+--------------------------------------------------------+--------+
  20. | :ref:`int<class_int>` | :ref:`sampler<class_GLTFTexture_property_sampler>` | ``-1`` |
  21. +-----------------------+--------------------------------------------------------+--------+
  22. | :ref:`int<class_int>` | :ref:`src_image<class_GLTFTexture_property_src_image>` | ``0`` |
  23. +-----------------------+--------------------------------------------------------+--------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_GLTFTexture_property_sampler:
  30. .. rst-class:: classref-property
  31. :ref:`int<class_int>` **sampler** = ``-1``
  32. .. rst-class:: classref-property-setget
  33. - void **set_sampler** **(** :ref:`int<class_int>` value **)**
  34. - :ref:`int<class_int>` **get_sampler** **(** **)**
  35. ID of the texture sampler to use when sampling the image. If -1, then the default texture sampler is used (linear filtering, and repeat wrapping in both axes).
  36. .. rst-class:: classref-item-separator
  37. ----
  38. .. _class_GLTFTexture_property_src_image:
  39. .. rst-class:: classref-property
  40. :ref:`int<class_int>` **src_image** = ``0``
  41. .. rst-class:: classref-property-setget
  42. - void **set_src_image** **(** :ref:`int<class_int>` value **)**
  43. - :ref:`int<class_int>` **get_src_image** **(** **)**
  44. .. container:: contribute
  45. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  49. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`