Index · Object → RefCounted → Resource → Mesh → ImmediateMesh

ImmediateMesh

Mesh optimized for creating geometry manually.

Class Description

A mesh type optimized for creating geometry manually, similar to OpenGL 1.x immediate mode.

Here's a sample on how to generate a triangular face:

var mesh = ImmediateMesh.new()
mesh.surface_begin(Mesh.PRIMITIVE_TRIANGLES)
mesh.surface_add_vertex(Vector3.LEFT)
mesh.surface_add_vertex(Vector3.FORWARD)
mesh.surface_add_vertex(Vector3.ZERO)
mesh.surface_end()

Note: Generating complex geometries with ImmediateMesh is highly inefficient. Instead, it is designed to generate simple geometry that changes often.

Properties

Inherited from Mesh (1)
var lightmap_size_hint: Vector2i = Vector2i(0, 0)
Inherited from Resource (4)

Methods

func clear_surfaces() -> void

Clear all surfaces.

func surface_add_vertex(vertex: Vector3) -> void

Add a 3D vertex using the current attributes previously set.

func surface_add_vertex_2d(vertex: Vector2) -> void

Add a 2D vertex using the current attributes previously set.

func surface_begin(primitive: Mesh.PrimitiveType, material: Material = null) -> void

Begin a new surface.

func surface_end() -> void

End and commit current surface. Note that surface being created will not be visible until this function is called.

func surface_set_color(color: Color) -> void

Set the color attribute that will be pushed with the next vertex.

func surface_set_normal(normal: Vector3) -> void

Set the normal attribute that will be pushed with the next vertex.

func surface_set_tangent(tangent: Plane) -> void

Set the tangent attribute that will be pushed with the next vertex.

Note: Even though tangent is a Plane, it does not directly represent the tangent plane. Its Plane.x, Plane.y, and Plane.z represent the tangent vector and Plane.d should be either -1 or 1. See also Mesh.ARRAY_TANGENT.

func surface_set_uv(uv: Vector2) -> void

Set the UV attribute that will be pushed with the next vertex.

func surface_set_uv2(uv2: Vector2) -> void

Set the UV2 attribute that will be pushed with the next vertex.

Inherited from Mesh (26)
func _get_aabb() -> AABB
func _set_blend_shape_name(index: int, name: StringName) -> void
func _surface_get_arrays(index: int) -> Array
func _surface_get_format(index: int) -> int
func _surface_set_material(index: int, material: Material) -> void
func create_convex_shape(clean: bool = true, simplify: bool = false) -> ConvexPolygonShape3D
func create_outline(margin: float) -> Mesh
func get_aabb() -> AABB
func surface_get_arrays(surf_idx: int) -> Array
func surface_get_blend_shape_arrays(surf_idx: int) -> Array[void]
func surface_get_material(surf_idx: int) -> Material
func surface_set_material(surf_idx: int, material: Material) -> void
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)