Struct gdnative_bindings::Light2D

pub struct Light2D { /* fields omitted */ }

core class Light2D inherits Node2D (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.

Light2D is an unsafe pointer, and all of its methods are unsafe.

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 Light2D::free.

Class hierarchy

Light2D inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl Light2D

Constants

pub const SHADOW_FILTER_PCF13: i64

pub const SHADOW_FILTER_PCF9: i64

pub const SHADOW_FILTER_PCF7: i64

pub const MODE_ADD: i64

pub const SHADOW_FILTER_PCF5: i64

pub const SHADOW_FILTER_PCF3: i64

pub const MODE_SUB: i64

pub const SHADOW_FILTER_NONE: i64

pub const MODE_MASK: i64

pub const MODE_MIX: i64

impl Light2D

pub fn new() -> Self

Constructor.

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 Light2D::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_color(&self) -> Color

pub unsafe fn get_energy(&self) -> f64

pub unsafe fn get_height(&self) -> f64

pub unsafe fn get_item_cull_mask(&self) -> i64

pub unsafe fn get_item_shadow_cull_mask(&self) -> i64

pub unsafe fn get_layer_range_max(&self) -> i64

pub unsafe fn get_layer_range_min(&self) -> i64

pub unsafe fn get_mode(&self) -> Light2DMode

pub unsafe fn get_shadow_buffer_size(&self) -> i64

pub unsafe fn get_shadow_color(&self) -> Color

pub unsafe fn get_shadow_filter(&self) -> Light2DShadowFilter

pub unsafe fn get_shadow_gradient_length(&self) -> f64

pub unsafe fn get_shadow_smooth(&self) -> f64

pub unsafe fn get_texture(&self) -> Option<Texture>

pub unsafe fn get_texture_offset(&self) -> Vector2

pub unsafe fn get_texture_scale(&self) -> f64

pub unsafe fn get_z_range_max(&self) -> i64

pub unsafe fn get_z_range_min(&self) -> i64

pub unsafe fn is_editor_only(&self) -> bool

pub unsafe fn is_enabled(&self) -> bool

pub unsafe fn is_shadow_enabled(&self) -> bool

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

pub unsafe fn set_editor_only(&mut self, editor_only: bool)

pub unsafe fn set_enabled(&mut self, enabled: bool)

pub unsafe fn set_energy(&mut self, energy: f64)

pub unsafe fn set_height(&mut self, height: f64)

pub unsafe fn set_item_cull_mask(&mut self, item_cull_mask: i64)

pub unsafe fn set_item_shadow_cull_mask(&mut self, item_shadow_cull_mask: i64)

pub unsafe fn set_layer_range_max(&mut self, layer: i64)

pub unsafe fn set_layer_range_min(&mut self, layer: i64)

pub unsafe fn set_mode(&mut self, mode: i64)

pub unsafe fn set_shadow_buffer_size(&mut self, size: i64)

pub unsafe fn set_shadow_color(&mut self, shadow_color: Color)

pub unsafe fn set_shadow_enabled(&mut self, enabled: bool)

pub unsafe fn set_shadow_filter(&mut self, filter: i64)

pub unsafe fn set_shadow_gradient_length(&mut self, multiplier: f64)

pub unsafe fn set_shadow_smooth(&mut self, smooth: f64)

pub unsafe fn set_texture(&mut self, texture: Option<Texture>)

pub unsafe fn set_texture_offset(&mut self, texture_offset: Vector2)

pub unsafe fn set_texture_scale(&mut self, texture_scale: f64)

pub unsafe fn set_z_range_max(&mut self, z: i64)

pub unsafe fn set_z_range_min(&mut self, z: i64)

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = Node2D>

pub unsafe fn apply_scale(&mut self, ratio: Vector2)

pub unsafe fn get_angle_to(&self, point: Vector2) -> f64

pub unsafe fn get_global_position(&self) -> Vector2

pub unsafe fn get_global_rotation(&self) -> f64

pub unsafe fn get_global_rotation_degrees(&self) -> f64

pub unsafe fn get_global_scale(&self) -> Vector2

pub unsafe fn get_position(&self) -> Vector2

pub unsafe fn get_relative_transform_to_parent(
    &self,
    parent: Option<Node>
) -> Transform2D

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

pub unsafe fn get_scale(&self) -> Vector2

pub unsafe fn get_z_index(&self) -> i64

pub unsafe fn global_translate(&mut self, offset: Vector2)

pub unsafe fn is_z_relative(&self) -> bool

pub unsafe fn look_at(&mut self, point: Vector2)

pub unsafe fn move_local_x(&mut self, delta: f64, scaled: bool)

pub unsafe fn move_local_y(&mut self, delta: f64, scaled: bool)

pub unsafe fn rotate(&mut self, radians: f64)

pub unsafe fn set_global_position(&mut self, position: Vector2)

pub unsafe fn set_global_rotation(&mut self, radians: f64)

pub unsafe fn set_global_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_global_scale(&mut self, scale: Vector2)

pub unsafe fn set_global_transform(&mut self, xform: Transform2D)

pub unsafe fn set_position(&mut self, position: Vector2)

pub unsafe fn set_rotation(&mut self, radians: f64)

pub unsafe fn set_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_scale(&mut self, scale: Vector2)

pub unsafe fn set_transform(&mut self, xform: Transform2D)

pub unsafe fn set_z_as_relative(&mut self, enable: bool)

pub unsafe fn set_z_index(&mut self, z_index: i64)

pub unsafe fn to_global(&self, local_point: Vector2) -> Vector2

pub unsafe fn to_local(&self, global_point: Vector2) -> Vector2

pub unsafe fn translate(&mut self, offset: Vector2)

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for Light2D

fn clone(&self) -> Light2D

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Light2D

impl Debug for Light2D

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

Formats the value using the given formatter.

impl Deref for Light2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for Light2D

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

Mutably dereferences the value.

impl Free for Light2D

unsafe fn godot_free(self)

impl FromVariant for Light2D

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for Light2D

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for Light2D

fn construct() -> Self

impl QueueFree for Light2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Light2D

fn to_variant(&self) -> Variant