Struct gdnative::api::DirectionalLight

pub struct DirectionalLight { /* fields omitted */ }

core class DirectionalLight 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.

DirectionalLight is a reference-only type. Persistent references can only exist in the unsafe Ref<DirectionalLight> 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

DirectionalLight inherits methods from:

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

Constants

pub const SHADOW_DEPTH_RANGE_OPTIMIZED: i64

pub const SHADOW_DEPTH_RANGE_STABLE: i64

pub const SHADOW_ORTHOGONAL: i64

pub const SHADOW_PARALLEL_2_SPLITS: i64

pub const SHADOW_PARALLEL_4_SPLITS: i64

impl DirectionalLight

pub fn new() -> Ref<DirectionalLight, Unique>

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 shadow_depth_range(&self) -> ShadowDepthRange

Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange].

pub fn shadow_mode(&self) -> ShadowMode

The light's shadow rendering algorithm. See [enum ShadowMode].

pub fn is_blend_splits_enabled(&self) -> bool

If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits.

pub fn set_blend_splits(&self, enabled: bool)

If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits.

pub fn set_shadow_depth_range(&self, mode: i64)

Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange].

pub fn set_shadow_mode(&self, mode: i64)

The light's shadow rendering algorithm. See [enum ShadowMode].

Methods from Deref<Target = Light>

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

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].

Trait Implementations

impl Debug for DirectionalLight

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

Formats the value using the given formatter.

impl Deref for DirectionalLight

type Target = Light

The resulting type after dereferencing.

fn deref(&self) -> &Light

Dereferences the value.

impl DerefMut for DirectionalLight

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

Mutably dereferences the value.

impl GodotObject for DirectionalLight

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 Instanciable for DirectionalLight

fn construct() -> Ref<DirectionalLight, Unique>

impl QueueFree for DirectionalLight

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Light> for DirectionalLight

impl SubClass<Node> for DirectionalLight

impl SubClass<Object> for DirectionalLight

impl SubClass<Spatial> for DirectionalLight

impl SubClass<VisualInstance> for DirectionalLight