Struct gdnative::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.

Class hierarchy

Environment inherits methods from:

• Resource
• Reference
• Object

Methods

impl Environment

Constants

pub const TONE_MAPPER_REINHARDT: i64

pub const BG_CLEAR_COLOR: i64

pub const GLOW_BLEND_MODE_REPLACE: i64

pub const SSAO_QUALITY_MEDIUM: i64

pub const TONE_MAPPER_FILMIC: i64

pub const BG_MAX: i64

pub const TONE_MAPPER_LINEAR: i64

pub const BG_SKY: i64

pub const BG_CANVAS: i64

pub const DOF_BLUR_QUALITY_MEDIUM: i64

pub const SSAO_BLUR_1x1: i64

pub const SSAO_BLUR_3x3: i64

pub const BG_COLOR_SKY: i64

pub const DOF_BLUR_QUALITY_HIGH: i64

pub const BG_CAMERA_FEED: i64

pub const SSAO_QUALITY_LOW: i64

pub const DOF_BLUR_QUALITY_LOW: i64

pub const GLOW_BLEND_MODE_SCREEN: i64

pub const BG_COLOR: i64

pub const GLOW_BLEND_MODE_SOFTLIGHT: i64

pub const SSAO_QUALITY_HIGH: i64

pub const BG_KEEP: i64

pub const SSAO_BLUR_2x2: i64

pub const SSAO_BLUR_DISABLED: i64

pub const TONE_MAPPER_ACES: i64

pub const GLOW_BLEND_MODE_ADDITIVE: i64

impl Environment

pub fn new() -> Environment

pub fn new_ref(&self) -> Environment

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

pub fn get_adjustment_brightness(&self) -> f64

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

pub fn get_adjustment_contrast(&self) -> f64

pub fn get_adjustment_saturation(&self) -> f64

pub fn get_ambient_light_color(&self) -> Color

pub fn get_ambient_light_energy(&self) -> f64

pub fn get_ambient_light_sky_contribution(&self) -> f64

pub fn get_background(&self) -> EnvironmentBGMode

pub fn get_bg_color(&self) -> Color

pub fn get_bg_energy(&self) -> f64

pub fn get_camera_feed_id(&self) -> i64

pub fn get_canvas_max_layer(&self) -> i64

pub fn get_dof_blur_far_amount(&self) -> f64

pub fn get_dof_blur_far_distance(&self) -> f64

pub fn get_dof_blur_far_quality(&self) -> EnvironmentDOFBlurQuality

pub fn get_dof_blur_far_transition(&self) -> f64

pub fn get_dof_blur_near_amount(&self) -> f64

pub fn get_dof_blur_near_distance(&self) -> f64

pub fn get_dof_blur_near_quality(&self) -> EnvironmentDOFBlurQuality

pub fn get_dof_blur_near_transition(&self) -> f64

pub fn get_fog_color(&self) -> Color

pub fn get_fog_depth_begin(&self) -> f64

pub fn get_fog_depth_curve(&self) -> f64

pub fn get_fog_depth_end(&self) -> f64

pub fn get_fog_height_curve(&self) -> f64

pub fn get_fog_height_max(&self) -> f64

pub fn get_fog_height_min(&self) -> f64

pub fn get_fog_sun_amount(&self) -> f64

pub fn get_fog_sun_color(&self) -> Color

pub fn get_fog_transmit_curve(&self) -> f64

pub fn get_glow_blend_mode(&self) -> EnvironmentGlowBlendMode

pub fn get_glow_bloom(&self) -> f64

pub fn get_glow_hdr_bleed_scale(&self) -> f64

pub fn get_glow_hdr_bleed_threshold(&self) -> f64

pub fn get_glow_hdr_luminance_cap(&self) -> f64

pub fn get_glow_intensity(&self) -> f64

pub fn get_glow_strength(&self) -> f64

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

pub fn get_sky_custom_fov(&self) -> f64

pub fn get_sky_orientation(&self) -> Basis

pub fn get_sky_rotation(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_sky_rotation_degrees(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_ssao_ao_channel_affect(&self) -> f64

pub fn get_ssao_bias(&self) -> f64

pub fn get_ssao_blur(&self) -> EnvironmentSSAOBlur

pub fn get_ssao_color(&self) -> Color

pub fn get_ssao_direct_light_affect(&self) -> f64

pub fn get_ssao_edge_sharpness(&self) -> f64

pub fn get_ssao_intensity(&self) -> f64

pub fn get_ssao_intensity2(&self) -> f64

pub fn get_ssao_quality(&self) -> EnvironmentSSAOQuality

pub fn get_ssao_radius(&self) -> f64

pub fn get_ssao_radius2(&self) -> f64

pub fn get_ssr_depth_tolerance(&self) -> f64

pub fn get_ssr_fade_in(&self) -> f64

pub fn get_ssr_fade_out(&self) -> f64

pub fn get_ssr_max_steps(&self) -> i64

pub fn get_tonemap_auto_exposure(&self) -> bool

pub fn get_tonemap_auto_exposure_grey(&self) -> f64

pub fn get_tonemap_auto_exposure_max(&self) -> f64

pub fn get_tonemap_auto_exposure_min(&self) -> f64

pub fn get_tonemap_auto_exposure_speed(&self) -> f64

pub fn get_tonemap_exposure(&self) -> f64

pub fn get_tonemap_white(&self) -> f64

pub fn get_tonemapper(&self) -> EnvironmentToneMapper

pub fn is_adjustment_enabled(&self) -> bool

pub fn is_dof_blur_far_enabled(&self) -> bool

pub fn is_dof_blur_near_enabled(&self) -> bool

pub fn is_fog_depth_enabled(&self) -> bool

pub fn is_fog_enabled(&self) -> bool

pub fn is_fog_height_enabled(&self) -> bool

pub fn is_fog_transmit_enabled(&self) -> bool

pub fn is_glow_bicubic_upscale_enabled(&self) -> bool

pub fn is_glow_enabled(&self) -> bool

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

pub fn is_ssao_enabled(&self) -> bool

pub fn is_ssr_enabled(&self) -> bool

pub fn is_ssr_rough(&self) -> bool

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

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

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

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

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

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

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

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

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

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

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

pub fn set_camera_feed_id(&mut self, camera_feed_id: i64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn set_fog_depth_end(&mut self, distance: f64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn set_sky_orientation(&mut self, orientation: Basis)

pub fn set_sky_rotation(&mut self, euler_radians: Vector3D<f32, UnknownUnit>)

pub fn set_sky_rotation_degrees(
    &mut self,
    euler_degrees: Vector3D<f32, UnknownUnit>
)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Resource>

pub fn new_ref(&self) -> Resource

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

pub fn _setup_local_to_scene(&mut self)

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

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

pub fn get_name(&self) -> GodotString

pub fn get_path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

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

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

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

pub fn setup_local_to_scene(&mut self)

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

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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) -> &Resource

Dereferences the value.

impl DerefMut for Environment

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

Mutably dereferences the value.

impl Drop for Environment

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for Environment

fn from_variant(variant: &Variant) -> Result<Environment, FromVariantError>

impl GodotObject for Environment

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> Environment

unsafe fn from_return_position_sys(obj: *mut c_void) -> Environment

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for Environment

fn construct() -> Environment

impl ToVariant for Environment

fn to_variant(&self) -> Variant