summaryrefslogtreecommitdiffstats
path: root/modules/gltf/doc_classes/GLTFAccessor.xml
diff options
context:
space:
mode:
authorAaron Franke <arnfranke@yahoo.com>2024-01-10 16:08:25 -0600
committerAaron Franke <arnfranke@yahoo.com>2024-01-11 20:33:51 -0600
commitd36a34edb77e93d501fd18fb7a255cc14e246dab (patch)
tree7a5e1605706528742e97ab1a35f98e04fcdb5e28 /modules/gltf/doc_classes/GLTFAccessor.xml
parent26b1fd0d842fa3c2f090ead47e8ea7cd2d6515e1 (diff)
downloadredot-engine-d36a34edb77e93d501fd18fb7a255cc14e246dab.tar.gz
Misc changes to the GLTF module before audio PR
Diffstat (limited to 'modules/gltf/doc_classes/GLTFAccessor.xml')
-rw-r--r--modules/gltf/doc_classes/GLTFAccessor.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/modules/gltf/doc_classes/GLTFAccessor.xml b/modules/gltf/doc_classes/GLTFAccessor.xml
index f678a11319..ba7323b7cd 100644
--- a/modules/gltf/doc_classes/GLTFAccessor.xml
+++ b/modules/gltf/doc_classes/GLTFAccessor.xml
@@ -1,14 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFAccessor" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
+ Represents a GLTF accessor.
</brief_description>
<description>
+ GLTFAccessor is a data structure representing GLTF a [code]accessor[/code] that would be found in the [code]"accessors"[/code] array. A buffer is a blob of binary data. A buffer view is a slice of a buffer. An accessor is a typed interpretation of the data in a buffer view.
+ Most custom data stored in GLTF does not need accessors, only buffer views (see [GLTFBufferView]). Accessors are for more advanced use cases such as interleaved mesh data encoded for the GPU.
</description>
<tutorials>
+ <link title="Buffers, BufferViews, and Accessors in Khronos glTF specification">https://github.com/KhronosGroup/glTF-Tutorials/blob/master/gltfTutorial/gltfTutorial_005_BuffersBufferViewsAccessors.md</link>
<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
</tutorials>
<members>
<member name="buffer_view" type="int" setter="set_buffer_view" getter="get_buffer_view" default="-1">
+ The index of the buffer view this accessor is referencing. If [code]-1[/code], this accessor is not referencing any buffer view.
</member>
<member name="byte_offset" type="int" setter="set_byte_offset" getter="get_byte_offset" default="0">
</member>