[−][src]Struct gdnative_bindings::DirectionalLight
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:
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
[src]
Constants
pub const SHADOW_DEPTH_RANGE_OPTIMIZED: i64
[src]
pub const SHADOW_DEPTH_RANGE_STABLE: i64
[src]
pub const SHADOW_ORTHOGONAL: i64
[src]
pub const SHADOW_PARALLEL_2_SPLITS: i64
[src]
pub const SHADOW_PARALLEL_4_SPLITS: i64
[src]
impl DirectionalLight
[src]
pub fn new() -> Ref<Self, Unique>
[src]
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
[src]
Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange].
pub fn shadow_mode(&self) -> ShadowMode
[src]
The light's shadow rendering algorithm. See [enum ShadowMode].
pub fn is_blend_splits_enabled(&self) -> bool
[src]
If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits.
pub fn set_blend_splits(&self, enabled: bool)
[src]
If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits.
pub fn set_shadow_depth_range(&self, mode: i64)
[src]
Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange].
pub fn set_shadow_mode(&self, mode: i64)
[src]
The light's shadow rendering algorithm. See [enum ShadowMode].
Methods from Deref<Target = Light>
pub const BAKE_ALL: i64
[src]
pub const BAKE_DISABLED: i64
[src]
pub const BAKE_INDIRECT: i64
[src]
pub const PARAM_ATTENUATION: i64
[src]
pub const PARAM_CONTACT_SHADOW_SIZE: i64
[src]
pub const PARAM_ENERGY: i64
[src]
pub const PARAM_INDIRECT_ENERGY: i64
[src]
pub const PARAM_MAX: i64
[src]
pub const PARAM_RANGE: i64
[src]
pub const PARAM_SHADOW_BIAS: i64
[src]
pub const PARAM_SHADOW_BIAS_SPLIT_SCALE: i64
[src]
pub const PARAM_SHADOW_MAX_DISTANCE: i64
[src]
pub const PARAM_SHADOW_NORMAL_BIAS: i64
[src]
pub const PARAM_SHADOW_SPLIT_1_OFFSET: i64
[src]
pub const PARAM_SHADOW_SPLIT_2_OFFSET: i64
[src]
pub const PARAM_SHADOW_SPLIT_3_OFFSET: i64
[src]
pub const PARAM_SPECULAR: i64
[src]
pub const PARAM_SPOT_ANGLE: i64
[src]
pub const PARAM_SPOT_ATTENUATION: i64
[src]
pub fn bake_mode(&self) -> BakeMode
[src]
The light's bake mode. See [enum BakeMode].
pub fn color(&self) -> Color
[src]
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
[src]
The light will affect objects in the selected layers.
pub fn param(&self, param: i64) -> f64
[src]
Attempts to reduce [member shadow_bias] gap.
pub fn shadow_color(&self) -> Color
[src]
The color of shadows cast by this light.
pub fn shadow_reverse_cull_face(&self) -> bool
[src]
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
[src]
If [code]true[/code], the light will cast shadows.
pub fn is_editor_only(&self) -> bool
[src]
If [code]true[/code], the light only appears in the editor and will not be visible at runtime.
pub fn is_negative(&self) -> bool
[src]
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)
[src]
The light's bake mode. See [enum BakeMode].
pub fn set_color(&self, color: Color)
[src]
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)
[src]
The light will affect objects in the selected layers.
pub fn set_editor_only(&self, editor_only: bool)
[src]
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)
[src]
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)
[src]
Attempts to reduce [member shadow_bias] gap.
pub fn set_shadow(&self, enabled: bool)
[src]
If [code]true[/code], the light will cast shadows.
pub fn set_shadow_color(&self, shadow_color: Color)
[src]
The color of shadows cast by this light.
pub fn set_shadow_reverse_cull_face(&self, enable: bool)
[src]
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
[src]
impl Deref for DirectionalLight
[src]
impl DerefMut for DirectionalLight
[src]
impl GodotObject for DirectionalLight
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for DirectionalLight
[src]
impl QueueFree for DirectionalLight
[src]
unsafe fn godot_queue_free(obj: *mut godot_object)
[src]
impl Sealed for DirectionalLight
[src]
impl SubClass<Light> for DirectionalLight
[src]
impl SubClass<Node> for DirectionalLight
[src]
impl SubClass<Object> for DirectionalLight
[src]
impl SubClass<Spatial> for DirectionalLight
[src]
impl SubClass<VisualInstance> for DirectionalLight
[src]
Auto Trait Implementations
impl RefUnwindSafe for DirectionalLight
impl !Send for DirectionalLight
impl !Sync for DirectionalLight
impl Unpin for DirectionalLight
impl UnwindSafe for DirectionalLight
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,