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

The light's bake mode. See [enum BakeMode].

pub fn color(&self) -> Color

The light's color. An [i]overbright[/i] color can be used to achieve a result equivalent to increasing the light's [member light_energy].

pub fn cull_mask(&self) -> i64

The light will affect objects in the selected layers.

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

Attempts to reduce [member shadow_bias] gap.

pub fn shadow_color(&self) -> Color

The color of shadows cast by this light.

pub fn shadow_reverse_cull_face(&self) -> bool

If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [constant GeometryInstance.SHADOW_CASTING_SETTING_DOUBLE_SIDED].

pub fn has_shadow(&self) -> bool

If [code]true[/code], the light will cast shadows.

pub fn is_editor_only(&self) -> bool

If [code]true[/code], the light only appears in the editor and will not be visible at runtime.

pub fn is_negative(&self) -> bool

If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows.

pub fn set_bake_mode(&self, bake_mode: i64)

The light's bake mode. See [enum BakeMode].

pub fn set_color(&self, color: Color)

The light's color. An [i]overbright[/i] color can be used to achieve a result equivalent to increasing the light's [member light_energy].

pub fn set_cull_mask(&self, cull_mask: i64)

The light will affect objects in the selected layers.

pub fn set_editor_only(&self, editor_only: bool)

If [code]true[/code], the light only appears in the editor and will not be visible at runtime.

pub fn set_negative(&self, enabled: bool)

If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows.

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

Attempts to reduce [member shadow_bias] gap.

pub fn set_shadow(&self, enabled: bool)

If [code]true[/code], the light will cast shadows.

pub fn set_shadow_color(&self, shadow_color: Color)

The color of shadows cast by this light.

pub fn set_shadow_reverse_cull_face(&self, enable: bool)

If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [constant GeometryInstance.SHADOW_CASTING_SETTING_DOUBLE_SIDED].

Methods from Deref<Target = VisualInstance>

pub fn get_aabb(&self) -> Aabb

Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. See also [method get_transformed_aabb].

pub fn get_base(&self) -> Rid

Returns the RID of the resource associated with this [VisualInstance]. For example, if the Node is a [MeshInstance], this will return the RID of the associated [Mesh].

pub fn get_instance(&self) -> Rid

Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call [VisualServer] functions directly on this [VisualInstance].

pub fn layer_mask(&self) -> i64

The render layer(s) this [VisualInstance] is drawn on.
			This object will only be visible for [Camera]s whose cull mask includes the render object this [VisualInstance] is set to.

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

Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise.

pub fn get_transformed_aabb(&self) -> Aabb

Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance].
				Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. See also [method get_aabb].

pub fn set_base(&self, base: Rid)

Sets the resource that is instantiated by this [VisualInstance], which changes how the engine handles the [VisualInstance] under the hood. Equivalent to [method VisualServer.instance_set_base].

pub fn set_layer_mask(&self, mask: i64)

The render layer(s) this [VisualInstance] is drawn on.
			This object will only be visible for [Camera]s whose cull mask includes the render object this [VisualInstance] is set to.

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

Enables a particular layer in [member layers].

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