asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/Mesh.xml

229 lines
10 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
<class name="Mesh" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
A [Resource] that contains vertex array-based geometry.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Mesh is a type of [Resource] that contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
Link to demos from within the class reference (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f)
2020-10-01 10:34:47 +02:00
<link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link>
<link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link>
<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<methods>
<method name="create_convex_shape" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Shape" />
<argument index="0" name="clean" type="bool" default="true" />
<argument index="1" name="simplify" type="bool" default="false" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Calculate a [ConvexPolygonShape] from the mesh.
Options to clean/simplify convex hull generated from mesh Clean: remove duplicate and interior vertices (uses Bullet algorithm) Simplify: modify the geometry for further simplification (uses VHACD algorithm) In the editor, single convex hull now uses the clean option. Added a new editor entry to create a simplified convex hull, can be useful for creating convex hull from highly tessellated triangle meshes. Specific change for 3.x: Add support for Vector<Vector3> and PoolVector<Vector3> in the convex hull generator.
2021-07-10 00:31:05 +02:00
If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed.
If [code]simplify[/code] is [code]true[/code], the geometry can be further simplified to reduce the amount of vertices. Disabled by default.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="create_outline" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Mesh" />
<argument index="0" name="margin" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Calculate an outline mesh at a defined offset (margin) from the original mesh.
[b]Note:[/b] This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="create_trimesh_shape" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Shape" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Calculate a [ConcavePolygonShape] from the mesh.
</description>
</method>
<method name="generate_triangle_mesh" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="TriangleMesh" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Generate a [TriangleMesh] from the mesh.
</description>
</method>
Expose Mesh get_aabb
2019-12-08 03:23:05 +01:00
<method name="get_aabb" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
Expose Mesh get_aabb
2019-12-08 03:23:05 +01:00
<description>
Cross-reference AABB getter methods in the documentation This also clarifies that `get_aabb()` returns the AABB in local space. See https://github.com/godotengine/godot/issues/42095. (cherry picked from commit 9712f8fd2da24d3f97b391c0a694215fd4f181c3)
2020-09-16 15:53:10 +02:00
Returns the smallest [AABB] enclosing this mesh in local space. Not affected by [code]custom_aabb[/code]. See also [method VisualInstance.get_transformed_aabb].
Expose Mesh get_aabb
2019-12-08 03:23:05 +01:00
[b]Note:[/b] This is only implemented for [ArrayMesh] and [PrimitiveMesh].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_faces" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="PoolVector3Array" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle.
</description>
</method>
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
<method name="get_surface_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 04:15:43 +02:00
Returns the amount of surfaces that the [Mesh] holds.
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
</description>
</method>
<method name="surface_get_arrays" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="surf_idx" type="int" />
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
<description>
Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method ArrayMesh.add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_blend_shape_arrays" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="surf_idx" type="int" />
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
<description>
Returns the blend shape arrays for the requested surface.
</description>
</method>
<method name="surface_get_material" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Material" />
<argument index="0" name="surf_idx" type="int" />
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 04:15:43 +02:00
Returns a [Material] in a given surface. Surface is rendered using this material.
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
</description>
</method>
MeshLibrary export improvements - From now materials assigned to the MeshInstance (not the Mesh) get exported into the MeshLibrary when such materials exist. This enables workflows where the MeshLibrary is exported from an imported scene (e.g. GLTF) where the materials assigned to the Mesh (not the MeshInstance) get overwritten on re-import, thus can't use editor set materials in the exported MeshLibrary unless they are assigned to the MeshInstance whose materials get saved with the inherited scene thus persist across re-imports. - When appending to an existing MeshLibrary only generate previews for newly added or modified meshes. - During preview generation transform camera and lights instead of the mesh and use the source MeshInstance's transform for the mesh to avoid weird previews being generated for meshes with a position dependent material (e.g. when using triplanar mapping). - Adjust the camera angle and light directions used in mesh preview generation for better results.
2019-01-31 18:04:36 +01:00
<method name="surface_set_material">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="surf_idx" type="int" />
<argument index="1" name="material" type="Material" />
MeshLibrary export improvements - From now materials assigned to the MeshInstance (not the Mesh) get exported into the MeshLibrary when such materials exist. This enables workflows where the MeshLibrary is exported from an imported scene (e.g. GLTF) where the materials assigned to the Mesh (not the MeshInstance) get overwritten on re-import, thus can't use editor set materials in the exported MeshLibrary unless they are assigned to the MeshInstance whose materials get saved with the inherited scene thus persist across re-imports. - When appending to an existing MeshLibrary only generate previews for newly added or modified meshes. - During preview generation transform camera and lights instead of the mesh and use the source MeshInstance's transform for the mesh to avoid weird previews being generated for meshes with a position dependent material (e.g. when using triplanar mapping). - Adjust the camera angle and light directions used in mesh preview generation for better results.
2019-01-31 18:04:36 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets a [Material] for a given surface. Surface will be rendered using this material.
MeshLibrary export improvements - From now materials assigned to the MeshInstance (not the Mesh) get exported into the MeshLibrary when such materials exist. This enables workflows where the MeshLibrary is exported from an imported scene (e.g. GLTF) where the materials assigned to the Mesh (not the MeshInstance) get overwritten on re-import, thus can't use editor set materials in the exported MeshLibrary unless they are assigned to the MeshInstance whose materials get saved with the inherited scene thus persist across re-imports. - When appending to an existing MeshLibrary only generate previews for newly added or modified meshes. - During preview generation transform camera and lights instead of the mesh and use the source MeshInstance's transform for the mesh to avoid weird previews being generated for meshes with a position dependent material (e.g. when using triplanar mapping). - Adjust the camera angle and light directions used in mesh preview generation for better results.
2019-01-31 18:04:36 +01:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</methods>
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="lightmap_size_hint" type="Vector2" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2( 0, 0 )">
Add documentation for new CPU lightmapper.
2020-12-30 17:12:41 +01:00
Sets a hint to be used for lightmap resolution in [BakedLightmap]. Overrides [member BakedLightmap.default_texels_per_unit].
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as points (one vertex equals one point).
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as lines (every two vertices a line is created).
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as line strip.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as line loop (like line strip, but closed).
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as triangles (every three vertices a triangle is created).
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as triangle strips.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
Render array as triangle fans.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Blend shapes are normalized.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Blend shapes are relative to base weight.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains vertices. All meshes require a vertex array so this should always be present.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains normals.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains tangents.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains colors.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains UVs.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains second UV.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains bones.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array contains bone weights.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Mesh array uses indices.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_BASE" value="9" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Used internally to calculate other [code]ARRAY_COMPRESS_*[/code] enum values. Do not use.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) vertex array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) normal array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) tangent array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) color array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) UV coordinates array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed bone array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed (half float) weight array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark a compressed index array.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark that the array contains 2D vertices.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat">
Completed documentation for many visual nodes
2020-01-14 22:27:14 +01:00
Flag used to mark that the array uses 16-bit bones instead of 8-bit.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
Octahedral Normal/Tangent Compression Implement Octahedral Compression for normal/tangent vectors *Oct32 for uncompressed vectors *Oct16 for compressed vectors Reduces vertex size for each attribute by *Uncompressed: 12 bytes, vec4<float32> -> vec2<unorm16> *Compressed: 2 bytes, vec4<unorm8> -> vec2<unorm8> Binormal sign is encoded in the y coordinate of the encoded tangent Added conversion functions to go from octahedral mapping to cartesian for normal and tangent vectors sprite_3d and soft_body meshes write to their vertex buffer memory directly and need to convert their normals and tangents to the new oct format before writing Created a new mesh flag to specify whether a mesh is using octahedral compression or not Updated documentation to discuss new flag/defaults Created shader flags to specify whether octahedral or cartesian vectors are being used Updated importers to use octahedral representation as the default format for importing meshes Updated ShaderGLES2 to support 64 bit version codes as we hit the limit of the 32-bit integer that was previously used as a bitset to store enabled/disabled flags
2021-03-08 18:58:13 +01:00
<constant name="ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION" value="2097152" enum="ArrayFormat">
Flag used to mark that the array uses an octahedral representation of normal and tangent vectors rather than cartesian.
</constant>
<constant name="ARRAY_COMPRESS_DEFAULT" value="2194432" enum="ArrayFormat">
Used to set flags [constant ARRAY_COMPRESS_VERTEX], [constant ARRAY_COMPRESS_NORMAL], [constant ARRAY_COMPRESS_TANGENT], [constant ARRAY_COMPRESS_COLOR], [constant ARRAY_COMPRESS_TEX_UV], [constant ARRAY_COMPRESS_TEX_UV2], [constant ARRAY_COMPRESS_WEIGHTS], and [constant ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION] quickly.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of vertices.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of normals.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of tangents as an array of floats, 4 floats per tangent.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of colors.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of UV coordinates.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of second set of UV coordinates.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of bone data.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of weights.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
Moved documentation for methods made accessible from super class for Mesh
2018-08-29 13:02:48 +02:00
Array of indices.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum ArrayType] enum.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constants>
</class>
Reference in a new issue Copy permalink