Struct Environment

#[repr(C)]
pub struct Environment { /* private fields */ }

Godot class Environment.

Inherits Resource.

Related symbols:

• environment: sidecar module with related enum/flag types
• IEnvironment: virtual methods

See also Godot docs for Environment.

Construction

This class is reference-counted. You can create a new instance using Environment::new_gd().

Implementations

impl Environment

pub fn set_background(&mut self, mode: BgMode)

pub fn get_background(&self) -> BgMode

pub fn set_sky(&mut self, sky: impl AsObjectArg<Sky>)

pub fn get_sky(&self) -> Option<Gd<Sky>>

pub fn set_sky_custom_fov(&mut self, scale: f32)

pub fn get_sky_custom_fov(&self) -> f32

pub fn set_sky_rotation(&mut self, euler_radians: Vector3)

pub fn get_sky_rotation(&self) -> Vector3

pub fn set_bg_color(&mut self, color: Color)

pub fn get_bg_color(&self) -> Color

pub fn set_bg_energy_multiplier(&mut self, energy: f32)

pub fn get_bg_energy_multiplier(&self) -> f32

pub fn set_bg_intensity(&mut self, energy: f32)

pub fn get_bg_intensity(&self) -> f32

pub fn set_canvas_max_layer(&mut self, layer: i32)

pub fn get_canvas_max_layer(&self) -> i32

pub fn set_camera_feed_id(&mut self, id: i32)

pub fn get_camera_feed_id(&self) -> i32

pub fn set_ambient_light_color(&mut self, color: Color)

pub fn get_ambient_light_color(&self) -> Color

pub fn set_ambient_source(&mut self, source: AmbientSource)

pub fn get_ambient_source(&self) -> AmbientSource

pub fn set_ambient_light_energy(&mut self, energy: f32)

pub fn get_ambient_light_energy(&self) -> f32

pub fn set_ambient_light_sky_contribution(&mut self, ratio: f32)

pub fn get_ambient_light_sky_contribution(&self) -> f32

pub fn set_reflection_source(&mut self, source: ReflectionSource)

pub fn get_reflection_source(&self) -> ReflectionSource

pub fn set_tonemapper(&mut self, mode: ToneMapper)

pub fn get_tonemapper(&self) -> ToneMapper

pub fn set_tonemap_exposure(&mut self, exposure: f32)

pub fn get_tonemap_exposure(&self) -> f32

pub fn set_tonemap_white(&mut self, white: f32)

pub fn get_tonemap_white(&self) -> f32

pub fn set_ssr_enabled(&mut self, enabled: bool)

pub fn is_ssr_enabled(&self) -> bool

pub fn set_ssr_max_steps(&mut self, max_steps: i32)

pub fn get_ssr_max_steps(&self) -> i32

pub fn set_ssr_fade_in(&mut self, fade_in: f32)

pub fn get_ssr_fade_in(&self) -> f32

pub fn set_ssr_fade_out(&mut self, fade_out: f32)

pub fn get_ssr_fade_out(&self) -> f32

pub fn set_ssr_depth_tolerance(&mut self, depth_tolerance: f32)

pub fn get_ssr_depth_tolerance(&self) -> f32

pub fn set_ssao_enabled(&mut self, enabled: bool)

pub fn is_ssao_enabled(&self) -> bool

pub fn set_ssao_radius(&mut self, radius: f32)

pub fn get_ssao_radius(&self) -> f32

pub fn set_ssao_intensity(&mut self, intensity: f32)

pub fn get_ssao_intensity(&self) -> f32

pub fn set_ssao_power(&mut self, power: f32)

pub fn get_ssao_power(&self) -> f32

pub fn set_ssao_detail(&mut self, detail: f32)

pub fn get_ssao_detail(&self) -> f32

pub fn set_ssao_horizon(&mut self, horizon: f32)

pub fn get_ssao_horizon(&self) -> f32

pub fn set_ssao_sharpness(&mut self, sharpness: f32)

pub fn get_ssao_sharpness(&self) -> f32

pub fn set_ssao_direct_light_affect(&mut self, amount: f32)

pub fn get_ssao_direct_light_affect(&self) -> f32

pub fn set_ssao_ao_channel_affect(&mut self, amount: f32)

pub fn get_ssao_ao_channel_affect(&self) -> f32

pub fn set_ssil_enabled(&mut self, enabled: bool)

pub fn is_ssil_enabled(&self) -> bool

pub fn set_ssil_radius(&mut self, radius: f32)

pub fn get_ssil_radius(&self) -> f32

pub fn set_ssil_intensity(&mut self, intensity: f32)

pub fn get_ssil_intensity(&self) -> f32

pub fn set_ssil_sharpness(&mut self, sharpness: f32)

pub fn get_ssil_sharpness(&self) -> f32

pub fn set_ssil_normal_rejection(&mut self, normal_rejection: f32)

pub fn get_ssil_normal_rejection(&self) -> f32

pub fn set_sdfgi_enabled(&mut self, enabled: bool)

pub fn is_sdfgi_enabled(&self) -> bool

pub fn set_sdfgi_cascades(&mut self, amount: i32)

pub fn get_sdfgi_cascades(&self) -> i32

pub fn set_sdfgi_min_cell_size(&mut self, size: f32)

pub fn get_sdfgi_min_cell_size(&self) -> f32

pub fn set_sdfgi_max_distance(&mut self, distance: f32)

pub fn get_sdfgi_max_distance(&self) -> f32

pub fn set_sdfgi_cascade0_distance(&mut self, distance: f32)

pub fn get_sdfgi_cascade0_distance(&self) -> f32

pub fn set_sdfgi_y_scale(&mut self, scale: SdfgiYScale)

pub fn get_sdfgi_y_scale(&self) -> SdfgiYScale

pub fn set_sdfgi_use_occlusion(&mut self, enable: bool)

pub fn is_sdfgi_using_occlusion(&self) -> bool

pub fn set_sdfgi_bounce_feedback(&mut self, amount: f32)

pub fn get_sdfgi_bounce_feedback(&self) -> f32

pub fn set_sdfgi_read_sky_light(&mut self, enable: bool)

pub fn is_sdfgi_reading_sky_light(&self) -> bool

pub fn set_sdfgi_energy(&mut self, amount: f32)

pub fn get_sdfgi_energy(&self) -> f32

pub fn set_sdfgi_normal_bias(&mut self, bias: f32)

pub fn get_sdfgi_normal_bias(&self) -> f32

pub fn set_sdfgi_probe_bias(&mut self, bias: f32)

pub fn get_sdfgi_probe_bias(&self) -> f32

pub fn set_glow_enabled(&mut self, enabled: bool)

pub fn is_glow_enabled(&self) -> bool

pub fn set_glow_level(&mut self, idx: i32, intensity: f32)

pub fn get_glow_level(&self, idx: i32) -> f32

pub fn set_glow_normalized(&mut self, normalize: bool)

pub fn is_glow_normalized(&self) -> bool

pub fn set_glow_intensity(&mut self, intensity: f32)

pub fn get_glow_intensity(&self) -> f32

pub fn set_glow_strength(&mut self, strength: f32)

pub fn get_glow_strength(&self) -> f32

pub fn set_glow_mix(&mut self, mix: f32)

pub fn get_glow_mix(&self) -> f32

pub fn set_glow_bloom(&mut self, amount: f32)

pub fn get_glow_bloom(&self) -> f32

pub fn set_glow_blend_mode(&mut self, mode: GlowBlendMode)

pub fn get_glow_blend_mode(&self) -> GlowBlendMode

pub fn set_glow_hdr_bleed_threshold(&mut self, threshold: f32)

pub fn get_glow_hdr_bleed_threshold(&self) -> f32

pub fn set_glow_hdr_bleed_scale(&mut self, scale: f32)

pub fn get_glow_hdr_bleed_scale(&self) -> f32

pub fn set_glow_hdr_luminance_cap(&mut self, amount: f32)

pub fn get_glow_hdr_luminance_cap(&self) -> f32

pub fn set_glow_map_strength(&mut self, strength: f32)

pub fn get_glow_map_strength(&self) -> f32

pub fn set_glow_map(&mut self, mode: impl AsObjectArg<Texture>)

pub fn get_glow_map(&self) -> Option<Gd<Texture>>

pub fn set_fog_enabled(&mut self, enabled: bool)

pub fn is_fog_enabled(&self) -> bool

pub fn set_fog_mode(&mut self, mode: FogMode)

pub fn get_fog_mode(&self) -> FogMode

pub fn set_fog_light_color(&mut self, light_color: Color)

pub fn get_fog_light_color(&self) -> Color

pub fn set_fog_light_energy(&mut self, light_energy: f32)

pub fn get_fog_light_energy(&self) -> f32

pub fn set_fog_sun_scatter(&mut self, sun_scatter: f32)

pub fn get_fog_sun_scatter(&self) -> f32

pub fn set_fog_density(&mut self, density: f32)

pub fn get_fog_density(&self) -> f32

pub fn set_fog_height(&mut self, height: f32)

pub fn get_fog_height(&self) -> f32

pub fn set_fog_height_density(&mut self, height_density: f32)

pub fn get_fog_height_density(&self) -> f32

pub fn set_fog_aerial_perspective(&mut self, aerial_perspective: f32)

pub fn get_fog_aerial_perspective(&self) -> f32

pub fn set_fog_sky_affect(&mut self, sky_affect: f32)

pub fn get_fog_sky_affect(&self) -> f32

pub fn set_fog_depth_curve(&mut self, curve: f32)

pub fn get_fog_depth_curve(&self) -> f32

pub fn set_fog_depth_begin(&mut self, begin: f32)

pub fn get_fog_depth_begin(&self) -> f32

pub fn set_fog_depth_end(&mut self, end: f32)

pub fn get_fog_depth_end(&self) -> f32

pub fn set_volumetric_fog_enabled(&mut self, enabled: bool)

pub fn is_volumetric_fog_enabled(&self) -> bool

pub fn set_volumetric_fog_emission(&mut self, color: Color)

pub fn get_volumetric_fog_emission(&self) -> Color

pub fn set_volumetric_fog_albedo(&mut self, color: Color)

pub fn get_volumetric_fog_albedo(&self) -> Color

pub fn set_volumetric_fog_density(&mut self, density: f32)

pub fn get_volumetric_fog_density(&self) -> f32

pub fn set_volumetric_fog_emission_energy(&mut self, begin: f32)

pub fn get_volumetric_fog_emission_energy(&self) -> f32

pub fn set_volumetric_fog_anisotropy(&mut self, anisotropy: f32)

pub fn get_volumetric_fog_anisotropy(&self) -> f32

pub fn set_volumetric_fog_length(&mut self, length: f32)

pub fn get_volumetric_fog_length(&self) -> f32

pub fn set_volumetric_fog_detail_spread(&mut self, detail_spread: f32)

pub fn get_volumetric_fog_detail_spread(&self) -> f32

pub fn set_volumetric_fog_gi_inject(&mut self, gi_inject: f32)

pub fn get_volumetric_fog_gi_inject(&self) -> f32

pub fn set_volumetric_fog_ambient_inject(&mut self, enabled: f32)

pub fn get_volumetric_fog_ambient_inject(&self) -> f32

pub fn set_volumetric_fog_sky_affect(&mut self, sky_affect: f32)

pub fn get_volumetric_fog_sky_affect(&self) -> f32

pub fn set_volumetric_fog_temporal_reprojection_enabled( &mut self, enabled: bool, )

pub fn is_volumetric_fog_temporal_reprojection_enabled(&self) -> bool

pub fn set_volumetric_fog_temporal_reprojection_amount( &mut self, temporal_reprojection_amount: f32, )

pub fn get_volumetric_fog_temporal_reprojection_amount(&self) -> f32

pub fn set_adjustment_enabled(&mut self, enabled: bool)

pub fn is_adjustment_enabled(&self) -> bool

pub fn set_adjustment_brightness(&mut self, brightness: f32)

pub fn get_adjustment_brightness(&self) -> f32

pub fn set_adjustment_contrast(&mut self, contrast: f32)

pub fn get_adjustment_contrast(&self) -> f32

pub fn set_adjustment_saturation(&mut self, saturation: f32)

pub fn get_adjustment_saturation(&self) -> f32

pub fn set_adjustment_color_correction( &mut self, color_correction: impl AsObjectArg<Texture>, )

pub fn get_adjustment_color_correction(&self) -> Option<Gd<Texture>>

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: GString)

pub fn take_over_path(&mut self, path: GString)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: GString)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: GString)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: &Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: &Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: &Variant)

pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for Environment

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Deref for Environment

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &<Environment as Deref>::Target

Dereferences the value.

impl DerefMut for Environment

fn deref_mut(&mut self) -> &mut <Environment as Deref>::Target

Mutably dereferences the value.

impl GodotClass for Environment

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Resource

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for Environment

impl Inherits<Object> for Environment

impl Inherits<RefCounted> for Environment

impl Inherits<Resource> for Environment