Struct gdnative::SpotLight

pub struct SpotLight { /* fields omitted */ }

core class SpotLight inherits Light (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.

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

Class hierarchy

SpotLight inherits methods from:

• Light
• VisualInstance
• Spatial
• Node
• Object

Methods

impl SpotLight

pub fn new() -> SpotLight

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn to_light(&self) -> Light

Up-cast.

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

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>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Light>

pub const PARAM_RANGE: i64

pub const PARAM_SPOT_ATTENUATION: i64

pub const BAKE_DISABLED: i64

pub const PARAM_SPECULAR: i64

pub const PARAM_ATTENUATION: i64

pub const PARAM_SHADOW_SPLIT_2_OFFSET: i64

pub const PARAM_SHADOW_SPLIT_1_OFFSET: i64

pub const PARAM_CONTACT_SHADOW_SIZE: i64

pub const PARAM_SHADOW_BIAS_SPLIT_SCALE: i64

pub const PARAM_MAX: i64

pub const PARAM_ENERGY: i64

pub const PARAM_INDIRECT_ENERGY: i64

pub const BAKE_INDIRECT: i64

pub const PARAM_SHADOW_MAX_DISTANCE: i64

pub const PARAM_SHADOW_NORMAL_BIAS: i64

pub const BAKE_ALL: i64

pub const PARAM_SHADOW_BIAS: i64

pub const PARAM_SHADOW_SPLIT_3_OFFSET: i64

pub const PARAM_SPOT_ANGLE: i64

pub unsafe fn get_bake_mode(&self) -> LightBakeMode

pub unsafe fn get_color(&self) -> Color

pub unsafe fn get_cull_mask(&self) -> i64

pub unsafe fn get_param(&self, param: i64) -> f64

pub unsafe fn get_shadow_color(&self) -> Color

pub unsafe fn get_shadow_reverse_cull_face(&self) -> bool

pub unsafe fn has_shadow(&self) -> bool

pub unsafe fn is_editor_only(&self) -> bool

pub unsafe fn is_negative(&self) -> bool

pub unsafe fn set_bake_mode(&mut self, bake_mode: i64)

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

pub unsafe fn set_cull_mask(&mut self, cull_mask: i64)

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

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

pub unsafe fn set_param(&mut self, param: i64, value: f64)

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

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

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

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

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>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for SpotLight

fn clone(&self) -> SpotLight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SpotLight

impl Debug for SpotLight

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

Formats the value using the given formatter.

impl Deref for SpotLight

type Target = Light

The resulting type after dereferencing.

fn deref(&self) -> &Light

Dereferences the value.

impl DerefMut for SpotLight

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

Mutably dereferences the value.

impl Free for SpotLight

unsafe fn godot_free(self)

impl FromVariant for SpotLight

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

impl GodotObject for SpotLight

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> SpotLight

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

impl Instanciable for SpotLight

fn construct() -> SpotLight

impl QueueFree for SpotLight

unsafe fn godot_queue_free(&mut self)

impl ToVariant for SpotLight

fn to_variant(&self) -> Variant