Struct SurfaceTool 

#[repr(C)]
pub struct SurfaceTool { /* private fields */ }

Godot class SurfaceTool.

Inherits RefCounted.

Related symbols:

• surface_tool: sidecar module with related enum/flag types
• ISurfaceTool: virtual methods

See also Godot docs for SurfaceTool.

Construction

This class is reference-counted. You can create a new instance using SurfaceTool::new_gd().

Implementations

impl SurfaceTool

pub fn set_skin_weight_count(&mut self, count: SkinWeightCount)

pub fn get_skin_weight_count(&self) -> SkinWeightCount

pub fn set_custom_format(&mut self, channel_index: i32, format: CustomFormat)

pub fn get_custom_format(&self, channel_index: i32) -> CustomFormat

pub fn begin(&mut self, primitive: PrimitiveType)

pub fn add_vertex(&mut self, vertex: Vector3)

pub fn set_color(&mut self, color: Color)

pub fn set_normal(&mut self, normal: Vector3)

pub fn set_tangent(&mut self, tangent: Plane)

pub fn set_uv(&mut self, uv: Vector2)

pub fn set_uv2(&mut self, uv2: Vector2)

pub fn set_bones(&mut self, bones: &PackedArray<i32>)

pub fn set_weights(&mut self, weights: &PackedArray<f32>)

pub fn set_custom(&mut self, channel_index: i32, custom_color: Color)

pub fn set_smooth_group(&mut self, index: u32)

pub fn add_triangle_fan(&mut self, vertices: &PackedArray<Vector3>)

To set the default parameters, use Self::add_triangle_fan_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_triangle_fan_ex<'a>( &'a mut self, vertices: &'a PackedArray<Vector3>, ) -> ExAddTriangleFan<'a>

pub fn add_index(&mut self, index: i32)

pub fn index(&mut self)

pub fn deindex(&mut self)

pub fn generate_normals(&mut self)

To set the default parameters, use Self::generate_normals_ex and its builder methods. See the book for detailed usage instructions.

pub fn generate_normals_ex<'a>(&'a mut self) -> ExGenerateNormals<'a>

pub fn generate_tangents(&mut self)

pub fn optimize_indices_for_cache(&mut self)

pub fn get_aabb(&self) -> Aabb

pub fn generate_lod(&mut self, nd_threshold: f32) -> PackedArray<i32>

To set the default parameters, use Self::generate_lod_ex and its builder methods. See the book for detailed usage instructions.

pub fn generate_lod_ex<'a>(&'a mut self, nd_threshold: f32) -> ExGenerateLod<'a>

pub fn set_material(&mut self, material: impl AsArg<Option<Gd<Material>>>)

pub fn get_primitive_type(&self) -> PrimitiveType

pub fn clear(&mut self)

pub fn create_from( &mut self, existing: impl AsArg<Option<Gd<Mesh>>>, surface: i32, )

pub fn create_from_arrays(&mut self, arrays: &Array<Variant>)

To set the default parameters, use Self::create_from_arrays_ex and its builder methods. See the book for detailed usage instructions.

pub fn create_from_arrays_ex<'a>( &'a mut self, arrays: &'a Array<Variant>, ) -> ExCreateFromArrays<'a>

pub fn create_from_blend_shape( &mut self, existing: impl AsArg<Option<Gd<Mesh>>>, surface: i32, blend_shape: impl AsArg<GString>, )

pub fn append_from( &mut self, existing: impl AsArg<Option<Gd<Mesh>>>, surface: i32, transform: Transform3D, )

pub fn commit(&mut self) -> Option<Gd<ArrayMesh>>

To set the default parameters, use Self::commit_ex and its builder methods. See the book for detailed usage instructions.

pub fn commit_ex<'a>(&'a mut self) -> ExCommit<'a>

pub fn commit_to_arrays(&mut self) -> Array<Variant>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn get_translation_domain(&self) -> StringName

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for SurfaceTool

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for SurfaceTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for SurfaceTool

type Target = RefCounted

The resulting type after dereferencing.

fn deref(&self) -> &<SurfaceTool as Deref>::Target

Dereferences the value.

impl DerefMut for SurfaceTool

fn deref_mut(&mut self) -> &mut <SurfaceTool as Deref>::Target

Mutably dereferences the value.

impl GodotClass for SurfaceTool

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = RefCounted

The immediate superclass of T. This is always a Godot engine class.

fn class_id() -> ClassId

Globally unique class ID, linked to the name under which the class is registered in Godot.

fn class_name() -> ClassId

👎Deprecated: Renamed to class_id()

fn inherits<Base>() -> bool

where Base: GodotClass,

Returns whether Self inherits from Base.

impl Inherits<Object> for SurfaceTool

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<RefCounted> for SurfaceTool

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl WithSignals for SurfaceTool

type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>

The associated struct listing all signals of this class.

impl GodotDefault for SurfaceTool