godot-docs/classes/class_gltfaccessor.rst

:github_url: hide

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

.. _class_GLTFAccessor:

GLTFAccessor
============

**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 ``GLTFAccessor`` within a script will cause an error in an exported project.

Properties
----------

+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`buffer_view<class_GLTFAccessor_property_buffer_view>`                                     | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`byte_offset<class_GLTFAccessor_property_byte_offset>`                                     | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`component_type<class_GLTFAccessor_property_component_type>`                               | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`count<class_GLTFAccessor_property_count>`                                                 | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`max<class_GLTFAccessor_property_max>`                                                     | ``PoolRealArray(  )`` |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`min<class_GLTFAccessor_property_min>`                                                     | ``PoolRealArray(  )`` |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>`                   | :ref:`normalized<class_GLTFAccessor_property_normalized>`                                       | ``false``             |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`sparse_count<class_GLTFAccessor_property_sparse_count>`                                   | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`sparse_indices_buffer_view<class_GLTFAccessor_property_sparse_indices_buffer_view>`       | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`sparse_indices_byte_offset<class_GLTFAccessor_property_sparse_indices_byte_offset>`       | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`sparse_indices_component_type<class_GLTFAccessor_property_sparse_indices_component_type>` | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`sparse_values_buffer_view<class_GLTFAccessor_property_sparse_values_buffer_view>`         | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`sparse_values_byte_offset<class_GLTFAccessor_property_sparse_values_byte_offset>`         | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                     | :ref:`type<class_GLTFAccessor_property_type>`                                                   | ``0``                 |
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+

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

.. _class_GLTFAccessor_property_buffer_view:

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

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_buffer_view(value) |
+-----------+------------------------+
| *Getter*  | get_buffer_view()      |
+-----------+------------------------+

----

.. _class_GLTFAccessor_property_byte_offset:

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

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

----

.. _class_GLTFAccessor_property_component_type:

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

+-----------+---------------------------+
| *Default* | ``0``                     |
+-----------+---------------------------+
| *Setter*  | set_component_type(value) |
+-----------+---------------------------+
| *Getter*  | get_component_type()      |
+-----------+---------------------------+

----

.. _class_GLTFAccessor_property_count:

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

+-----------+------------------+
| *Default* | ``0``            |
+-----------+------------------+
| *Setter*  | set_count(value) |
+-----------+------------------+
| *Getter*  | get_count()      |
+-----------+------------------+

----

.. _class_GLTFAccessor_property_max:

- :ref:`PoolRealArray<class_PoolRealArray>` **max**

+-----------+-----------------------+
| *Default* | ``PoolRealArray(  )`` |
+-----------+-----------------------+
| *Setter*  | set_max(value)        |
+-----------+-----------------------+
| *Getter*  | get_max()             |
+-----------+-----------------------+

----

.. _class_GLTFAccessor_property_min:

- :ref:`PoolRealArray<class_PoolRealArray>` **min**

+-----------+-----------------------+
| *Default* | ``PoolRealArray(  )`` |
+-----------+-----------------------+
| *Setter*  | set_min(value)        |
+-----------+-----------------------+
| *Getter*  | get_min()             |
+-----------+-----------------------+

----

.. _class_GLTFAccessor_property_normalized:

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

+-----------+-----------------------+
| *Default* | ``false``             |
+-----------+-----------------------+
| *Setter*  | set_normalized(value) |
+-----------+-----------------------+
| *Getter*  | get_normalized()      |
+-----------+-----------------------+

----

.. _class_GLTFAccessor_property_sparse_count:

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

+-----------+-------------------------+
| *Default* | ``0``                   |
+-----------+-------------------------+
| *Setter*  | set_sparse_count(value) |
+-----------+-------------------------+
| *Getter*  | get_sparse_count()      |
+-----------+-------------------------+

----

.. _class_GLTFAccessor_property_sparse_indices_buffer_view:

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

+-----------+---------------------------------------+
| *Default* | ``0``                                 |
+-----------+---------------------------------------+
| *Setter*  | set_sparse_indices_buffer_view(value) |
+-----------+---------------------------------------+
| *Getter*  | get_sparse_indices_buffer_view()      |
+-----------+---------------------------------------+

----

.. _class_GLTFAccessor_property_sparse_indices_byte_offset:

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

+-----------+---------------------------------------+
| *Default* | ``0``                                 |
+-----------+---------------------------------------+
| *Setter*  | set_sparse_indices_byte_offset(value) |
+-----------+---------------------------------------+
| *Getter*  | get_sparse_indices_byte_offset()      |
+-----------+---------------------------------------+

----

.. _class_GLTFAccessor_property_sparse_indices_component_type:

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

+-----------+------------------------------------------+
| *Default* | ``0``                                    |
+-----------+------------------------------------------+
| *Setter*  | set_sparse_indices_component_type(value) |
+-----------+------------------------------------------+
| *Getter*  | get_sparse_indices_component_type()      |
+-----------+------------------------------------------+

----

.. _class_GLTFAccessor_property_sparse_values_buffer_view:

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

+-----------+--------------------------------------+
| *Default* | ``0``                                |
+-----------+--------------------------------------+
| *Setter*  | set_sparse_values_buffer_view(value) |
+-----------+--------------------------------------+
| *Getter*  | get_sparse_values_buffer_view()      |
+-----------+--------------------------------------+

----

.. _class_GLTFAccessor_property_sparse_values_byte_offset:

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

+-----------+--------------------------------------+
| *Default* | ``0``                                |
+-----------+--------------------------------------+
| *Setter*  | set_sparse_values_byte_offset(value) |
+-----------+--------------------------------------+
| *Getter*  | get_sparse_values_byte_offset()      |
+-----------+--------------------------------------+

----

.. _class_GLTFAccessor_property_type:

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

+-----------+-----------------+
| *Default* | ``0``           |
+-----------+-----------------+
| *Setter*  | set_type(value) |
+-----------+-----------------+
| *Getter*  | get_type()      |
+-----------+-----------------+

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