summaryrefslogtreecommitdiff
path: root/doc/classes/ImmediateMesh.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ImmediateMesh.xml')
-rw-r--r--doc/classes/ImmediateMesh.xml84
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/classes/ImmediateMesh.xml b/doc/classes/ImmediateMesh.xml
new file mode 100644
index 0000000000..69637d5bdd
--- /dev/null
+++ b/doc/classes/ImmediateMesh.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ImmediateMesh" inherits="Mesh" version="4.0">
+ <brief_description>
+ Mesh optimized for creating geometry manually.
+ </brief_description>
+ <description>
+ Mesh optimized for creating geometry manually, similar to OpenGL1.x immediate mode.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ <method name="clear_surfaces">
+ <return type="void" />
+ <description>
+ Clear all surfaces.
+ </description>
+ </method>
+ <method name="surface_add_vertex">
+ <return type="void" />
+ <argument index="0" name="vertex" type="Vector3" />
+ <description>
+ Add a 3D vertex using the current attributes previously set.
+ </description>
+ </method>
+ <method name="surface_add_vertex_2d">
+ <return type="void" />
+ <argument index="0" name="vertex" type="Vector2" />
+ <description>
+ Add a 2D vertex using the current attributes previously set.
+ </description>
+ </method>
+ <method name="surface_begin">
+ <return type="void" />
+ <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" />
+ <argument index="1" name="material" type="Material" default="null" />
+ <description>
+ Begin a new surface.
+ </description>
+ </method>
+ <method name="surface_end">
+ <return type="void" />
+ <description>
+ End and commit current surface. Note that surface being created will not be visible until this function is called.
+ </description>
+ </method>
+ <method name="surface_set_color">
+ <return type="void" />
+ <argument index="0" name="color" type="Color" />
+ <description>
+ Set the color attribute that will be pushed with the next vertex.
+ </description>
+ </method>
+ <method name="surface_set_normal">
+ <return type="void" />
+ <argument index="0" name="normal" type="Vector3" />
+ <description>
+ Set the normal attribute that will be pushed with the next vertex.
+ </description>
+ </method>
+ <method name="surface_set_tangent">
+ <return type="void" />
+ <argument index="0" name="tangent" type="Plane" />
+ <description>
+ Set the tangent attribute that will be pushed with the next vertex.
+ </description>
+ </method>
+ <method name="surface_set_uv">
+ <return type="void" />
+ <argument index="0" name="uv" type="Vector2" />
+ <description>
+ Set the UV attribute that will be pushed with the next vertex.
+ </description>
+ </method>
+ <method name="surface_set_uv2">
+ <return type="void" />
+ <argument index="0" name="uv2" type="Vector2" />
+ <description>
+ Set the UV2 attribute that will be pushed with the next vertex.
+ </description>
+ </method>
+ </methods>
+ <constants>
+ </constants>
+</class>