Struct gdnative_bindings::ImmediateGeometry

pub struct ImmediateGeometry { /* fields omitted */ }

core class ImmediateGeometry inherits GeometryInstance (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

ImmediateGeometry is a reference-only type. Persistent references can only exist in the unsafe Ref<ImmediateGeometry> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

ImmediateGeometry inherits methods from:

• GeometryInstance
• VisualInstance
• Spatial
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl ImmediateGeometry

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn add_sphere(&self, lats: i64, lons: i64, radius: f64, add_uv: bool)

Simple helper to draw an UV sphere with given latitude, longitude and radius.

Default Arguments

• add_uv - true

pub fn add_vertex(&self, position: Vector3)

Adds a vertex in local coordinate space with the currently set color/uv/etc.

pub fn begin(&self, primitive: i64, texture: impl AsArg<Texture>)

Begin drawing (and optionally pass a texture override). When done call [method end]. For more information on how this works, search for [code]glBegin()[/code] and [code]glEnd()[/code] references.
				For the type of primitive, see the [enum Mesh.PrimitiveType] enum.

Default Arguments

• texture - null

pub fn clear(&self)

Clears everything that was drawn using begin/end.

pub fn end(&self)

Ends a drawing context and displays the results.

pub fn set_color(&self, color: Color)

The current drawing color.

pub fn set_normal(&self, normal: Vector3)

The next vertex's normal.

pub fn set_tangent(&self, tangent: Plane)

The next vertex's tangent (and binormal facing).

pub fn set_uv(&self, uv: Vector2)

The next vertex's UV.

pub fn set_uv2(&self, uv: Vector2)

The next vertex's second layer UV.

Methods from Deref<Target = GeometryInstance>

pub const FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: i64

pub const FLAG_MAX: i64

pub const FLAG_USE_BAKED_LIGHT: i64

pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: i64

pub const SHADOW_CASTING_SETTING_OFF: i64

pub const SHADOW_CASTING_SETTING_ON: i64

pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64

pub fn cast_shadows_setting(&self) -> ShadowCastingSetting

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn extra_cull_margin(&self) -> f64

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn flag(&self, flag: i64) -> bool

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn lod_max_distance(&self) -> f64

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_max_hysteresis(&self) -> f64

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_distance(&self) -> f64

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_hysteresis(&self) -> f64

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn material_override(&self) -> Option<Ref<Material, Shared>>

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

pub fn set_cast_shadows_setting(&self, shadow_casting_setting: i64)

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn set_custom_aabb(&self, aabb: Aabb)

Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.

pub fn set_extra_cull_margin(&self, margin: f64)

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn set_flag(&self, flag: i64, value: bool)

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn set_lod_max_distance(&self, mode: f64)

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_max_hysteresis(&self, mode: f64)

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_distance(&self, mode: f64)

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_hysteresis(&self, mode: f64)

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn set_material_override(&self, material: impl AsArg<Material>)

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

Trait Implementations

impl Debug for ImmediateGeometry

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

Formats the value using the given formatter.

impl Deref for ImmediateGeometry

type Target = GeometryInstance

The resulting type after dereferencing.

fn deref(&self) -> &GeometryInstance

Dereferences the value.

impl DerefMut for ImmediateGeometry

fn deref_mut(&mut self) -> &mut GeometryInstance

Mutably dereferences the value.

impl GodotObject for ImmediateGeometry

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for ImmediateGeometry

fn construct() -> Ref<Self, Unique>

impl QueueFree for ImmediateGeometry

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for ImmediateGeometry

impl SubClass<GeometryInstance> for ImmediateGeometry

impl SubClass<Node> for ImmediateGeometry

impl SubClass<Object> for ImmediateGeometry

impl SubClass<Spatial> for ImmediateGeometry

impl SubClass<VisualInstance> for ImmediateGeometry