[−][src]Struct gdnative_bindings::ImmediateGeometry
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:
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
[src]
pub fn new() -> Ref<Self, Unique>
[src]
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)
[src]
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)
[src]
Adds a vertex in local coordinate space with the currently set color/uv/etc.
pub fn begin(&self, primitive: i64, texture: impl AsArg<Texture>)
[src]
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)
[src]
Clears everything that was drawn using begin/end.
pub fn end(&self)
[src]
Ends a drawing context and displays the results.
pub fn set_color(&self, color: Color)
[src]
The current drawing color.
pub fn set_normal(&self, normal: Vector3)
[src]
The next vertex's normal.
pub fn set_tangent(&self, tangent: Plane)
[src]
The next vertex's tangent (and binormal facing).
pub fn set_uv(&self, uv: Vector2)
[src]
The next vertex's UV.
pub fn set_uv2(&self, uv: Vector2)
[src]
The next vertex's second layer UV.
Methods from Deref<Target = GeometryInstance>
pub const FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: i64
[src]
pub const FLAG_MAX: i64
[src]
pub const FLAG_USE_BAKED_LIGHT: i64
[src]
pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: i64
[src]
pub const SHADOW_CASTING_SETTING_OFF: i64
[src]
pub const SHADOW_CASTING_SETTING_ON: i64
[src]
pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64
[src]
pub fn cast_shadows_setting(&self) -> ShadowCastingSetting
[src]
The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.
pub fn extra_cull_margin(&self) -> f64
[src]
The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.
pub fn flag(&self, flag: i64) -> bool
[src]
If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].
pub fn lod_max_distance(&self) -> f64
[src]
The GeometryInstance's max LOD distance.
[b]Note:[/b] This property currently has no effect.
pub fn lod_max_hysteresis(&self) -> f64
[src]
The GeometryInstance's max LOD margin.
[b]Note:[/b] This property currently has no effect.
pub fn lod_min_distance(&self) -> f64
[src]
The GeometryInstance's min LOD distance.
[b]Note:[/b] This property currently has no effect.
pub fn lod_min_hysteresis(&self) -> f64
[src]
The GeometryInstance's min LOD margin.
[b]Note:[/b] This property currently has no effect.
pub fn material_override(&self) -> Option<Ref<Material, Shared>>
[src]
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)
[src]
The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.
pub fn set_custom_aabb(&self, aabb: Aabb)
[src]
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)
[src]
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)
[src]
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)
[src]
The GeometryInstance's max LOD distance.
[b]Note:[/b] This property currently has no effect.
pub fn set_lod_max_hysteresis(&self, mode: f64)
[src]
The GeometryInstance's max LOD margin.
[b]Note:[/b] This property currently has no effect.
pub fn set_lod_min_distance(&self, mode: f64)
[src]
The GeometryInstance's min LOD distance.
[b]Note:[/b] This property currently has no effect.
pub fn set_lod_min_hysteresis(&self, mode: f64)
[src]
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>)
[src]
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
[src]
impl Deref for ImmediateGeometry
[src]
type Target = GeometryInstance
The resulting type after dereferencing.
fn deref(&self) -> &GeometryInstance
[src]
impl DerefMut for ImmediateGeometry
[src]
fn deref_mut(&mut self) -> &mut GeometryInstance
[src]
impl GodotObject for ImmediateGeometry
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for ImmediateGeometry
[src]
impl QueueFree for ImmediateGeometry
[src]
unsafe fn godot_queue_free(obj: *mut godot_object)
[src]
impl Sealed for ImmediateGeometry
[src]
impl SubClass<GeometryInstance> for ImmediateGeometry
[src]
impl SubClass<Node> for ImmediateGeometry
[src]
impl SubClass<Object> for ImmediateGeometry
[src]
impl SubClass<Spatial> for ImmediateGeometry
[src]
impl SubClass<VisualInstance> for ImmediateGeometry
[src]
Auto Trait Implementations
impl RefUnwindSafe for ImmediateGeometry
impl !Send for ImmediateGeometry
impl !Sync for ImmediateGeometry
impl Unpin for ImmediateGeometry
impl UnwindSafe for ImmediateGeometry
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,