class_gltftexture.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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/4.1/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.1/modules/gltf/doc_classes/GLTFTexture.xml.
  6. .. _class_GLTFTexture:
  7. GLTFTexture
  8. ===========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. .. rst-class:: classref-reftable-group
  13. Properties
  14. ----------
  15. .. table::
  16. :widths: auto
  17. +-----------------------+--------------------------------------------------------+--------+
  18. | :ref:`int<class_int>` | :ref:`sampler<class_GLTFTexture_property_sampler>` | ``-1`` |
  19. +-----------------------+--------------------------------------------------------+--------+
  20. | :ref:`int<class_int>` | :ref:`src_image<class_GLTFTexture_property_src_image>` | ``-1`` |
  21. +-----------------------+--------------------------------------------------------+--------+
  22. .. rst-class:: classref-section-separator
  23. ----
  24. .. rst-class:: classref-descriptions-group
  25. Property Descriptions
  26. ---------------------
  27. .. _class_GLTFTexture_property_sampler:
  28. .. rst-class:: classref-property
  29. :ref:`int<class_int>` **sampler** = ``-1``
  30. .. rst-class:: classref-property-setget
  31. - void **set_sampler** **(** :ref:`int<class_int>` value **)**
  32. - :ref:`int<class_int>` **get_sampler** **(** **)**
  33. 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).
  34. .. rst-class:: classref-item-separator
  35. ----
  36. .. _class_GLTFTexture_property_src_image:
  37. .. rst-class:: classref-property
  38. :ref:`int<class_int>` **src_image** = ``-1``
  39. .. rst-class:: classref-property-setget
  40. - void **set_src_image** **(** :ref:`int<class_int>` value **)**
  41. - :ref:`int<class_int>` **get_src_image** **(** **)**
  42. The index of the image associated with this texture, see :ref:`GLTFState.get_images<class_GLTFState_method_get_images>`. If -1, then this texture does not have an image assigned.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  46. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  47. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  48. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  49. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`