class_gltfbufferview.rst 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  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/GLTFBufferView.xml.
  6. .. _class_GLTFBufferView:
  7. GLTFBufferView
  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 **GLTFBufferView** 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:`buffer<class_GLTFBufferView_property_buffer>` | ``-1`` |
  21. +-------------------------+---------------------------------------------------------------+-----------+
  22. | :ref:`int<class_int>` | :ref:`byte_length<class_GLTFBufferView_property_byte_length>` | ``0`` |
  23. +-------------------------+---------------------------------------------------------------+-----------+
  24. | :ref:`int<class_int>` | :ref:`byte_offset<class_GLTFBufferView_property_byte_offset>` | ``0`` |
  25. +-------------------------+---------------------------------------------------------------+-----------+
  26. | :ref:`int<class_int>` | :ref:`byte_stride<class_GLTFBufferView_property_byte_stride>` | ``-1`` |
  27. +-------------------------+---------------------------------------------------------------+-----------+
  28. | :ref:`bool<class_bool>` | :ref:`indices<class_GLTFBufferView_property_indices>` | ``false`` |
  29. +-------------------------+---------------------------------------------------------------+-----------+
  30. .. rst-class:: classref-section-separator
  31. ----
  32. .. rst-class:: classref-descriptions-group
  33. Property Descriptions
  34. ---------------------
  35. .. _class_GLTFBufferView_property_buffer:
  36. .. rst-class:: classref-property
  37. :ref:`int<class_int>` **buffer** = ``-1``
  38. .. rst-class:: classref-property-setget
  39. - void **set_buffer** **(** :ref:`int<class_int>` value **)**
  40. - :ref:`int<class_int>` **get_buffer** **(** **)**
  41. .. container:: contribute
  42. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  43. .. rst-class:: classref-item-separator
  44. ----
  45. .. _class_GLTFBufferView_property_byte_length:
  46. .. rst-class:: classref-property
  47. :ref:`int<class_int>` **byte_length** = ``0``
  48. .. rst-class:: classref-property-setget
  49. - void **set_byte_length** **(** :ref:`int<class_int>` value **)**
  50. - :ref:`int<class_int>` **get_byte_length** **(** **)**
  51. .. container:: contribute
  52. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  53. .. rst-class:: classref-item-separator
  54. ----
  55. .. _class_GLTFBufferView_property_byte_offset:
  56. .. rst-class:: classref-property
  57. :ref:`int<class_int>` **byte_offset** = ``0``
  58. .. rst-class:: classref-property-setget
  59. - void **set_byte_offset** **(** :ref:`int<class_int>` value **)**
  60. - :ref:`int<class_int>` **get_byte_offset** **(** **)**
  61. .. container:: contribute
  62. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  63. .. rst-class:: classref-item-separator
  64. ----
  65. .. _class_GLTFBufferView_property_byte_stride:
  66. .. rst-class:: classref-property
  67. :ref:`int<class_int>` **byte_stride** = ``-1``
  68. .. rst-class:: classref-property-setget
  69. - void **set_byte_stride** **(** :ref:`int<class_int>` value **)**
  70. - :ref:`int<class_int>` **get_byte_stride** **(** **)**
  71. .. container:: contribute
  72. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  73. .. rst-class:: classref-item-separator
  74. ----
  75. .. _class_GLTFBufferView_property_indices:
  76. .. rst-class:: classref-property
  77. :ref:`bool<class_bool>` **indices** = ``false``
  78. .. rst-class:: classref-property-setget
  79. - void **set_indices** **(** :ref:`bool<class_bool>` value **)**
  80. - :ref:`bool<class_bool>` **get_indices** **(** **)**
  81. .. container:: contribute
  82. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  83. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  84. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  85. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  86. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`