334 lines
13 KiB
ReStructuredText
334 lines
13 KiB
ReStructuredText
: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/GLTFAccessor.xml.
|
|
|
|
.. _class_GLTFAccessor:
|
|
|
|
GLTFAccessor
|
|
============
|
|
|
|
**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 **GLTFAccessor** 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_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`` |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_GLTFAccessor_property_buffer_view:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **buffer_view** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_buffer_view** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_buffer_view** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_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_GLTFAccessor_property_component_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **component_type** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_component_type** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_component_type** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_count:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **count** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_count** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_count** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_max:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`PoolRealArray<class_PoolRealArray>` **max** = ``PoolRealArray( )``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_max** **(** :ref:`PoolRealArray<class_PoolRealArray>` value **)**
|
|
- :ref:`PoolRealArray<class_PoolRealArray>` **get_max** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_min:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`PoolRealArray<class_PoolRealArray>` **min** = ``PoolRealArray( )``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_min** **(** :ref:`PoolRealArray<class_PoolRealArray>` value **)**
|
|
- :ref:`PoolRealArray<class_PoolRealArray>` **get_min** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_normalized:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **normalized** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_normalized** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **get_normalized** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_sparse_count:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sparse_count** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sparse_count** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sparse_count** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_sparse_indices_buffer_view:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sparse_indices_buffer_view** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sparse_indices_buffer_view** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sparse_indices_buffer_view** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_sparse_indices_byte_offset:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sparse_indices_byte_offset** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sparse_indices_byte_offset** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sparse_indices_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_GLTFAccessor_property_sparse_indices_component_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sparse_indices_component_type** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sparse_indices_component_type** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sparse_indices_component_type** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_sparse_values_buffer_view:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sparse_values_buffer_view** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sparse_values_buffer_view** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sparse_values_buffer_view** **(** **)**
|
|
|
|
.. 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_GLTFAccessor_property_sparse_values_byte_offset:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sparse_values_byte_offset** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sparse_values_byte_offset** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sparse_values_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_GLTFAccessor_property_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **type** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_type** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_type** **(** **)**
|
|
|
|
.. 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.)`
|