godot-docs/classes/class_gltfbufferview.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GLTFBufferView.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GLTFBufferView:

GLTFBufferView
==============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`



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.

Properties
----------

+-------------------------+---------------------------------------------------------------+-----------+
| :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`` |
+-------------------------+---------------------------------------------------------------+-----------+

Property Descriptions
---------------------

.. _class_GLTFBufferView_property_buffer:

- :ref:`int<class_int>` **buffer**

+-----------+-------------------+
| *Default* | ``-1``            |
+-----------+-------------------+
| *Setter*  | set_buffer(value) |
+-----------+-------------------+
| *Getter*  | get_buffer()      |
+-----------+-------------------+

----

.. _class_GLTFBufferView_property_byte_length:

- :ref:`int<class_int>` **byte_length**

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_byte_length(value) |
+-----------+------------------------+
| *Getter*  | get_byte_length()      |
+-----------+------------------------+

----

.. _class_GLTFBufferView_property_byte_offset:

- :ref:`int<class_int>` **byte_offset**

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_byte_offset(value) |
+-----------+------------------------+
| *Getter*  | get_byte_offset()      |
+-----------+------------------------+

----

.. _class_GLTFBufferView_property_byte_stride:

- :ref:`int<class_int>` **byte_stride**

+-----------+------------------------+
| *Default* | ``-1``                 |
+-----------+------------------------+
| *Setter*  | set_byte_stride(value) |
+-----------+------------------------+
| *Getter*  | get_byte_stride()      |
+-----------+------------------------+

----

.. _class_GLTFBufferView_property_indices:

- :ref:`bool<class_bool>` **indices**

+-----------+--------------------+
| *Default* | ``false``          |
+-----------+--------------------+
| *Setter*  | set_indices(value) |
+-----------+--------------------+
| *Getter*  | get_indices()      |
+-----------+--------------------+

.. |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.)`