Struct gdnative::api::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 a reference-only type. Persistent references can only exist in the unsafe Ref<SpotLight> 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 Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

SpotLight 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 SpotLight

pub fn new() -> Ref<SpotLight, 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 Ptr::free, or preferably Ptr::queue_free if it is a Node.

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

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)

Trait Implementations

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 GodotObject for SpotLight

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 SpotLight

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

impl QueueFree for SpotLight

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Light> for SpotLight

impl SubClass<Node> for SpotLight

impl SubClass<Object> for SpotLight

impl SubClass<Spatial> for SpotLight

impl SubClass<VisualInstance> for SpotLight