virtualx-engine-docs/_sources/classes/class_gltfbufferview.rst.txt

146 lines
5 KiB
Text
Raw Normal View History

2024-10-23 18:41:33 +02:00
:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFBufferView.xml.
.. _class_GLTFBufferView:
GLTFBufferView
==============
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
.. rst-class:: classref-introduction-group
Description
-----------
**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.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------+---------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`buffer<class_GLTFBufferView_property_buffer>` | ``-1`` |
+-------------------------+---------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`byte_length<class_GLTFBufferView_property_byte_length>` | ``0`` |
+-------------------------+---------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`byte_offset<class_GLTFBufferView_property_byte_offset>` | ``0`` |
+-------------------------+---------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`byte_stride<class_GLTFBufferView_property_byte_stride>` | ``-1`` |
+-------------------------+---------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`indices<class_GLTFBufferView_property_indices>` | ``false`` |
+-------------------------+---------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_GLTFBufferView_property_buffer:
.. rst-class:: classref-property
:ref:`int<class_int>` **buffer** = ``-1``
.. rst-class:: classref-property-setget
- void **set_buffer** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_buffer** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFBufferView_property_byte_length:
.. rst-class:: classref-property
:ref:`int<class_int>` **byte_length** = ``0``
.. rst-class:: classref-property-setget
- void **set_byte_length** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_byte_length** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFBufferView_property_byte_offset:
.. rst-class:: classref-property
:ref:`int<class_int>` **byte_offset** = ``0``
.. rst-class:: classref-property-setget
- void **set_byte_offset** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_byte_offset** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFBufferView_property_byte_stride:
.. rst-class:: classref-property
:ref:`int<class_int>` **byte_stride** = ``-1``
.. rst-class:: classref-property-setget
- void **set_byte_stride** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_byte_stride** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFBufferView_property_indices:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **indices** = ``false``
.. rst-class:: classref-property-setget
- void **set_indices** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_indices** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`