Struct gdnative::api::ProceduralSky

pub struct ProceduralSky { /* fields omitted */ }

core class ProceduralSky inherits Sky (reference counted).

Official documentation

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

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

ProceduralSky inherits methods from:

• Sky
• Resource
• Reference
• 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 ProceduralSky

Constants

pub const TEXTURE_SIZE_1024: i64

pub const TEXTURE_SIZE_2048: i64

pub const TEXTURE_SIZE_256: i64

pub const TEXTURE_SIZE_4096: i64

pub const TEXTURE_SIZE_512: i64

pub const TEXTURE_SIZE_MAX: i64

impl ProceduralSky

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

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn ground_bottom_color(&self) -> Color

Color of the ground at the bottom.

pub fn ground_curve(&self) -> f64

How quickly the [member ground_horizon_color] fades into the [member ground_bottom_color].

pub fn ground_energy(&self) -> f64

Amount of energy contribution from the ground.

pub fn ground_horizon_color(&self) -> Color

Color of the ground at the horizon.

pub fn sky_curve(&self) -> f64

How quickly the [member sky_horizon_color] fades into the [member sky_top_color].

pub fn sky_energy(&self) -> f64

Amount of energy contribution from the sky.

pub fn sky_horizon_color(&self) -> Color

Color of the sky at the horizon.

pub fn sky_top_color(&self) -> Color

Color of the sky at the top.

pub fn sun_angle_max(&self) -> f64

Distance from center of sun where it fades out completely.

pub fn sun_angle_min(&self) -> f64

Distance from sun where it goes from solid to starting to fade.

pub fn sun_color(&self) -> Color

The sun's color.

pub fn sun_curve(&self) -> f64

How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max].

pub fn sun_energy(&self) -> f64

Amount of energy contribution from the sun.

pub fn sun_latitude(&self) -> f64

The sun's height using polar coordinates.

pub fn sun_longitude(&self) -> f64

The direction of the sun using polar coordinates.

pub fn texture_size(&self) -> TextureSize

Size of [Texture] that the ProceduralSky will generate. The size is set using [enum TextureSize].

pub fn set_ground_bottom_color(&self, color: Color)

Color of the ground at the bottom.

pub fn set_ground_curve(&self, curve: f64)

How quickly the [member ground_horizon_color] fades into the [member ground_bottom_color].

pub fn set_ground_energy(&self, energy: f64)

Amount of energy contribution from the ground.

pub fn set_ground_horizon_color(&self, color: Color)

Color of the ground at the horizon.

pub fn set_sky_curve(&self, curve: f64)

How quickly the [member sky_horizon_color] fades into the [member sky_top_color].

pub fn set_sky_energy(&self, energy: f64)

Amount of energy contribution from the sky.

pub fn set_sky_horizon_color(&self, color: Color)

Color of the sky at the horizon.

pub fn set_sky_top_color(&self, color: Color)

Color of the sky at the top.

pub fn set_sun_angle_max(&self, degrees: f64)

Distance from center of sun where it fades out completely.

pub fn set_sun_angle_min(&self, degrees: f64)

Distance from sun where it goes from solid to starting to fade.

pub fn set_sun_color(&self, color: Color)

The sun's color.

pub fn set_sun_curve(&self, curve: f64)

How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max].

pub fn set_sun_energy(&self, energy: f64)

Amount of energy contribution from the sun.

pub fn set_sun_latitude(&self, degrees: f64)

The sun's height using polar coordinates.

pub fn set_sun_longitude(&self, degrees: f64)

The direction of the sun using polar coordinates.

pub fn set_texture_size(&self, size: i64)

Size of [Texture] that the ProceduralSky will generate. The size is set using [enum TextureSize].

Methods from Deref<Target = Sky>

pub const RADIANCE_SIZE_1024: i64

pub const RADIANCE_SIZE_128: i64

pub const RADIANCE_SIZE_2048: i64

pub const RADIANCE_SIZE_256: i64

pub const RADIANCE_SIZE_32: i64

pub const RADIANCE_SIZE_512: i64

pub const RADIANCE_SIZE_64: i64

pub const RADIANCE_SIZE_MAX: i64

pub fn radiance_size(&self) -> RadianceSize

The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
			See [enum RadianceSize] constants for values.
			[b]Note:[/b] Some hardware will have trouble with higher radiance sizes, especially [constant RADIANCE_SIZE_512] and above. Only use such high values on high-end hardware.

pub fn set_radiance_size(&self, size: i64)

The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
			See [enum RadianceSize] constants for values.
			[b]Note:[/b] Some hardware will have trouble with higher radiance sizes, especially [constant RADIANCE_SIZE_512] and above. Only use such high values on high-end hardware.

Trait Implementations

impl Debug for ProceduralSky

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

Formats the value using the given formatter.

impl Deref for ProceduralSky

type Target = Sky

The resulting type after dereferencing.

fn deref(&self) -> &Sky

Dereferences the value.

impl DerefMut for ProceduralSky

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

Mutably dereferences the value.

impl GodotObject for ProceduralSky

type RefKind = RefCounted

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 ProceduralSky

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

impl SubClass<Object> for ProceduralSky

impl SubClass<Reference> for ProceduralSky

impl SubClass<Resource> for ProceduralSky

impl SubClass<Sky> for ProceduralSky