[][src]Struct gdnative_common::Environment

pub struct Environment { /* fields omitted */ }

core class Environment inherits Resource (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.

Feature flag

This type is behind the gdnative crate's common feature flag.

Class hierarchy

Environment inherits methods from:

Methods

impl Environment[src]

pub fn new() -> Self[src]

pub fn new_ref(&self) -> Self[src]

Creates a new reference to the same reference-counted object.

pub fn set_background(&mut self, mode: i64)[src]

pub fn set_sky(&mut self, sky: Option<Sky>)[src]

pub fn set_sky_custom_fov(&mut self, scale: f64)[src]

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

pub fn set_bg_energy(&mut self, energy: f64)[src]

pub fn set_canvas_max_layer(&mut self, layer: i64)[src]

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

pub fn set_ambient_light_energy(&mut self, energy: f64)[src]

pub fn set_ambient_light_sky_contribution(&mut self, energy: f64)[src]

pub fn get_background(&self) -> EnvironmentBGMode[src]

pub fn get_sky(&self) -> Option<Sky>[src]

pub fn get_sky_custom_fov(&self) -> f64[src]

pub fn get_bg_color(&self) -> Color[src]

pub fn get_bg_energy(&self) -> f64[src]

pub fn get_canvas_max_layer(&self) -> i64[src]

pub fn get_ambient_light_color(&self) -> Color[src]

pub fn get_ambient_light_energy(&self) -> f64[src]

pub fn get_ambient_light_sky_contribution(&self) -> f64[src]

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

pub fn is_fog_enabled(&self) -> bool[src]

pub fn set_fog_color(&mut self, color: Color)[src]

pub fn get_fog_color(&self) -> Color[src]

pub fn set_fog_sun_color(&mut self, color: Color)[src]

pub fn get_fog_sun_color(&self) -> Color[src]

pub fn set_fog_sun_amount(&mut self, amount: f64)[src]

pub fn get_fog_sun_amount(&self) -> f64[src]

pub fn set_fog_depth_enabled(&mut self, enabled: bool)[src]

pub fn is_fog_depth_enabled(&self) -> bool[src]

pub fn set_fog_depth_begin(&mut self, distance: f64)[src]

pub fn get_fog_depth_begin(&self) -> f64[src]

pub fn set_fog_depth_curve(&mut self, curve: f64)[src]

pub fn get_fog_depth_curve(&self) -> f64[src]

pub fn set_fog_transmit_enabled(&mut self, enabled: bool)[src]

pub fn is_fog_transmit_enabled(&self) -> bool[src]

pub fn set_fog_transmit_curve(&mut self, curve: f64)[src]

pub fn get_fog_transmit_curve(&self) -> f64[src]

pub fn set_fog_height_enabled(&mut self, enabled: bool)[src]

pub fn is_fog_height_enabled(&self) -> bool[src]

pub fn set_fog_height_min(&mut self, height: f64)[src]

pub fn get_fog_height_min(&self) -> f64[src]

pub fn set_fog_height_max(&mut self, height: f64)[src]

pub fn get_fog_height_max(&self) -> f64[src]

pub fn set_fog_height_curve(&mut self, curve: f64)[src]

pub fn get_fog_height_curve(&self) -> f64[src]

pub fn set_tonemapper(&mut self, mode: i64)[src]

pub fn get_tonemapper(&self) -> EnvironmentToneMapper[src]

pub fn set_tonemap_exposure(&mut self, exposure: f64)[src]

pub fn get_tonemap_exposure(&self) -> f64[src]

pub fn set_tonemap_white(&mut self, white: f64)[src]

pub fn get_tonemap_white(&self) -> f64[src]

pub fn set_tonemap_auto_exposure(&mut self, auto_exposure: bool)[src]

pub fn get_tonemap_auto_exposure(&self) -> bool[src]

pub fn set_tonemap_auto_exposure_max(&mut self, exposure_max: f64)[src]

pub fn get_tonemap_auto_exposure_max(&self) -> f64[src]

pub fn set_tonemap_auto_exposure_min(&mut self, exposure_min: f64)[src]

pub fn get_tonemap_auto_exposure_min(&self) -> f64[src]

pub fn set_tonemap_auto_exposure_speed(&mut self, exposure_speed: f64)[src]

pub fn get_tonemap_auto_exposure_speed(&self) -> f64[src]

pub fn set_tonemap_auto_exposure_grey(&mut self, exposure_grey: f64)[src]

pub fn get_tonemap_auto_exposure_grey(&self) -> f64[src]

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

pub fn is_ssr_enabled(&self) -> bool[src]

pub fn set_ssr_max_steps(&mut self, max_steps: i64)[src]

pub fn get_ssr_max_steps(&self) -> i64[src]

pub fn set_ssr_fade_in(&mut self, fade_in: f64)[src]

pub fn get_ssr_fade_in(&self) -> f64[src]

pub fn set_ssr_fade_out(&mut self, fade_out: f64)[src]

pub fn get_ssr_fade_out(&self) -> f64[src]

pub fn set_ssr_depth_tolerance(&mut self, depth_tolerance: f64)[src]

pub fn get_ssr_depth_tolerance(&self) -> f64[src]

pub fn set_ssr_rough(&mut self, rough: bool)[src]

pub fn is_ssr_rough(&self) -> bool[src]

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

pub fn is_ssao_enabled(&self) -> bool[src]

pub fn set_ssao_radius(&mut self, radius: f64)[src]

pub fn get_ssao_radius(&self) -> f64[src]

pub fn set_ssao_intensity(&mut self, intensity: f64)[src]

pub fn get_ssao_intensity(&self) -> f64[src]

pub fn set_ssao_radius2(&mut self, radius: f64)[src]

pub fn get_ssao_radius2(&self) -> f64[src]

pub fn set_ssao_intensity2(&mut self, intensity: f64)[src]

pub fn get_ssao_intensity2(&self) -> f64[src]

pub fn set_ssao_bias(&mut self, bias: f64)[src]

pub fn get_ssao_bias(&self) -> f64[src]

pub fn set_ssao_direct_light_affect(&mut self, amount: f64)[src]

pub fn get_ssao_direct_light_affect(&self) -> f64[src]

pub fn set_ssao_ao_channel_affect(&mut self, amount: f64)[src]

pub fn get_ssao_ao_channel_affect(&self) -> f64[src]

pub fn set_ssao_color(&mut self, color: Color)[src]

pub fn get_ssao_color(&self) -> Color[src]

pub fn set_ssao_blur(&mut self, mode: i64)[src]

pub fn get_ssao_blur(&self) -> EnvironmentSSAOBlur[src]

pub fn set_ssao_quality(&mut self, quality: i64)[src]

pub fn get_ssao_quality(&self) -> EnvironmentSSAOQuality[src]

pub fn set_ssao_edge_sharpness(&mut self, edge_sharpness: f64)[src]

pub fn get_ssao_edge_sharpness(&self) -> f64[src]

pub fn set_dof_blur_far_enabled(&mut self, enabled: bool)[src]

pub fn is_dof_blur_far_enabled(&self) -> bool[src]

pub fn set_dof_blur_far_distance(&mut self, intensity: f64)[src]

pub fn get_dof_blur_far_distance(&self) -> f64[src]

pub fn set_dof_blur_far_transition(&mut self, intensity: f64)[src]

pub fn get_dof_blur_far_transition(&self) -> f64[src]

pub fn set_dof_blur_far_amount(&mut self, intensity: f64)[src]

pub fn get_dof_blur_far_amount(&self) -> f64[src]

pub fn set_dof_blur_far_quality(&mut self, intensity: i64)[src]

pub fn get_dof_blur_far_quality(&self) -> EnvironmentDOFBlurQuality[src]

pub fn set_dof_blur_near_enabled(&mut self, enabled: bool)[src]

pub fn is_dof_blur_near_enabled(&self) -> bool[src]

pub fn set_dof_blur_near_distance(&mut self, intensity: f64)[src]

pub fn get_dof_blur_near_distance(&self) -> f64[src]

pub fn set_dof_blur_near_transition(&mut self, intensity: f64)[src]

pub fn get_dof_blur_near_transition(&self) -> f64[src]

pub fn set_dof_blur_near_amount(&mut self, intensity: f64)[src]

pub fn get_dof_blur_near_amount(&self) -> f64[src]

pub fn set_dof_blur_near_quality(&mut self, level: i64)[src]

pub fn get_dof_blur_near_quality(&self) -> EnvironmentDOFBlurQuality[src]

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

pub fn is_glow_enabled(&self) -> bool[src]

pub fn set_glow_level(&mut self, idx: i64, enabled: bool)[src]

pub fn is_glow_level_enabled(&self, idx: i64) -> bool[src]

pub fn set_glow_intensity(&mut self, intensity: f64)[src]

pub fn get_glow_intensity(&self) -> f64[src]

pub fn set_glow_strength(&mut self, strength: f64)[src]

pub fn get_glow_strength(&self) -> f64[src]

pub fn set_glow_bloom(&mut self, amount: f64)[src]

pub fn get_glow_bloom(&self) -> f64[src]

pub fn set_glow_blend_mode(&mut self, mode: i64)[src]

pub fn get_glow_blend_mode(&self) -> EnvironmentGlowBlendMode[src]

pub fn set_glow_hdr_bleed_threshold(&mut self, threshold: f64)[src]

pub fn get_glow_hdr_bleed_threshold(&self) -> f64[src]

pub fn set_glow_hdr_bleed_scale(&mut self, scale: f64)[src]

pub fn get_glow_hdr_bleed_scale(&self) -> f64[src]

pub fn set_glow_bicubic_upscale(&mut self, enabled: bool)[src]

pub fn is_glow_bicubic_upscale_enabled(&self) -> bool[src]

pub fn set_adjustment_enable(&mut self, enabled: bool)[src]

pub fn is_adjustment_enabled(&self) -> bool[src]

pub fn set_adjustment_brightness(&mut self, brightness: f64)[src]

pub fn get_adjustment_brightness(&self) -> f64[src]

pub fn set_adjustment_contrast(&mut self, contrast: f64)[src]

pub fn get_adjustment_contrast(&self) -> f64[src]

pub fn set_adjustment_saturation(&mut self, saturation: f64)[src]

pub fn get_adjustment_saturation(&self) -> f64[src]

pub fn set_adjustment_color_correction(
    &mut self,
    color_correction: Option<Texture>
)
[src]

pub fn get_adjustment_color_correction(&self) -> Option<Texture>[src]

pub fn _setup_local_to_scene(&mut self)[src]

Inherited from Resource.

pub fn set_path(&mut self, path: GodotString)[src]

Inherited from Resource.

pub fn take_over_path(&mut self, path: GodotString)[src]

Inherited from Resource.

pub fn get_path(&self) -> GodotString[src]

Inherited from Resource.

pub fn set_name(&mut self, name: GodotString)[src]

Inherited from Resource.

pub fn get_name(&self) -> GodotString[src]

Inherited from Resource.

pub fn get_rid(&self) -> Rid[src]

Inherited from Resource.

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

Inherited from Resource.

pub fn is_local_to_scene(&self) -> bool[src]

Inherited from Resource.

pub fn get_local_scene(&self) -> Option<Node>[src]

Inherited from Resource.

pub fn setup_local_to_scene(&mut self)[src]

Inherited from Resource.

pub fn duplicate(&self, subresources: bool) -> Option<Resource>[src]

Inherited from Resource.

pub fn init_ref(&mut self) -> bool[src]

Inherited from Reference.

pub fn _notification(&mut self, what: i64)[src]

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool[src]

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant[src]

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray[src]

Inherited from Object.

pub fn _init(&mut self)[src]

Inherited from Object.

pub fn get_class(&self) -> GodotString[src]

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool[src]

Inherited from Object.

pub fn set(&mut self, property: GodotString, value: Variant)[src]

Inherited from Object.

pub fn get(&self, property: GodotString) -> Variant[src]

Inherited from Object.

pub fn set_indexed(&mut self, property: NodePath, value: Variant)[src]

Inherited from Object.

pub fn get_indexed(&self, property: NodePath) -> Variant[src]

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray[src]

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray[src]

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)[src]

Inherited from Object.

pub fn get_instance_id(&self) -> i64[src]

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)[src]

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>[src]

Inherited from Object.

pub fn set_meta(&mut self, name: GodotString, value: Variant)[src]

Inherited from Object.

pub fn get_meta(&self, name: GodotString) -> Variant[src]

Inherited from Object.

pub fn has_meta(&self, name: GodotString) -> bool[src]

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray[src]

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)[src]

Inherited from Object.

pub fn has_user_signal(&self, signal: GodotString) -> bool[src]

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant[src]

Inherited from Object.

pub fn has_method(&self, method: GodotString) -> bool[src]

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray[src]

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray[src]

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray[src]

Inherited from Object.

pub fn connect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString,
    binds: VariantArray,
    flags: i64
) -> GodotResult
[src]

Inherited from Object.

pub fn disconnect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
)
[src]

Inherited from Object.

pub fn is_connected(
    &self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
) -> bool
[src]

Inherited from Object.

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

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool[src]

Inherited from Object.

pub fn property_list_changed_notify(&mut self)[src]

Inherited from Object.

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

Inherited from Object.

pub fn can_translate_messages(&self) -> bool[src]

Inherited from Object.

pub fn tr(&self, message: GodotString) -> GodotString[src]

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool[src]

Inherited from Object.

pub fn to_resource(&self) -> Resource[src]

Up-cast.

pub fn to_reference(&self) -> Reference[src]

Up-cast.

pub fn to_object(&self) -> Object[src]

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>[src]

Generic dynamic cast.

Trait Implementations

impl Debug for Environment[src]

impl Drop for Environment[src]

impl GodotObject for Environment[src]

impl ToVariant for Environment[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.