Struct gdnative::api::Light

pub struct Light { /* fields omitted */ }

core class Light inherits VisualInstance (unsafe).

Official documentation

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

Class hierarchy

Light inherits methods from:

• 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 Light

Constants

pub const BAKE_ALL: i64

pub const BAKE_DISABLED: i64

pub const BAKE_INDIRECT: i64

pub const PARAM_ATTENUATION: i64

pub const PARAM_CONTACT_SHADOW_SIZE: i64

pub const PARAM_ENERGY: i64

pub const PARAM_INDIRECT_ENERGY: i64

pub const PARAM_MAX: i64

pub const PARAM_RANGE: i64

pub const PARAM_SHADOW_BIAS: i64

pub const PARAM_SHADOW_BIAS_SPLIT_SCALE: i64

pub const PARAM_SHADOW_MAX_DISTANCE: i64

pub const PARAM_SHADOW_NORMAL_BIAS: i64

pub const PARAM_SHADOW_SPLIT_1_OFFSET: i64

pub const PARAM_SHADOW_SPLIT_2_OFFSET: i64

pub const PARAM_SHADOW_SPLIT_3_OFFSET: i64

pub const PARAM_SPECULAR: i64

pub const PARAM_SPOT_ANGLE: i64

pub const PARAM_SPOT_ATTENUATION: i64

impl Light

pub fn bake_mode(&self) -> BakeMode

pub fn color(&self) -> Color

pub fn cull_mask(&self) -> i64

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

pub fn shadow_color(&self) -> Color

pub fn shadow_reverse_cull_face(&self) -> bool

pub fn has_shadow(&self) -> bool

pub fn is_editor_only(&self) -> bool

pub fn is_negative(&self) -> bool

pub fn set_bake_mode(&self, bake_mode: i64)

pub fn set_color(&self, color: Color)

pub fn set_cull_mask(&self, cull_mask: i64)

pub fn set_editor_only(&self, editor_only: bool)

pub fn set_negative(&self, enabled: bool)

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

pub fn set_shadow(&self, enabled: bool)

pub fn set_shadow_color(&self, shadow_color: Color)

pub fn set_shadow_reverse_cull_face(&self, enable: bool)

Methods from Deref<Target = VisualInstance>

pub fn get_aabb(&self) -> Aabb

pub fn get_base(&self) -> Rid

pub fn get_instance(&self) -> Rid

pub fn layer_mask(&self) -> i64

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

pub fn get_transformed_aabb(&self) -> Aabb

pub fn set_base(&self, base: Rid)

pub fn set_layer_mask(&self, mask: i64)

pub fn set_layer_mask_bit(&self, layer: i64, enabled: bool)

Trait Implementations

impl Debug for Light

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

Formats the value using the given formatter.

impl Deref for Light

type Target = VisualInstance

The resulting type after dereferencing.

fn deref(&self) -> &VisualInstance

Dereferences the value.

impl DerefMut for Light

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

Mutably dereferences the value.

impl GodotObject for Light

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 QueueFree for Light

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Light> for SpotLight

impl SubClass<Light> for OmniLight

impl SubClass<Light> for DirectionalLight

impl SubClass<Node> for Light

impl SubClass<Object> for Light

impl SubClass<Spatial> for Light

impl SubClass<VisualInstance> for Light