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

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 Environment

Constants

pub const BG_CAMERA_FEED: i64

pub const BG_CANVAS: i64

pub const BG_CLEAR_COLOR: i64

pub const BG_COLOR: i64

pub const BG_COLOR_SKY: i64

pub const BG_KEEP: i64

pub const BG_MAX: i64

pub const BG_SKY: i64

pub const DOF_BLUR_QUALITY_HIGH: i64

pub const DOF_BLUR_QUALITY_LOW: i64

pub const DOF_BLUR_QUALITY_MEDIUM: i64

pub const GLOW_BLEND_MODE_ADDITIVE: i64

pub const GLOW_BLEND_MODE_REPLACE: i64

pub const GLOW_BLEND_MODE_SCREEN: i64

pub const GLOW_BLEND_MODE_SOFTLIGHT: i64

pub const SSAO_BLUR_1x1: i64

pub const SSAO_BLUR_2x2: i64

pub const SSAO_BLUR_3x3: i64

pub const SSAO_BLUR_DISABLED: i64

pub const SSAO_QUALITY_HIGH: i64

pub const SSAO_QUALITY_LOW: i64

pub const SSAO_QUALITY_MEDIUM: i64

pub const TONE_MAPPER_ACES: i64

pub const TONE_MAPPER_FILMIC: i64

pub const TONE_MAPPER_LINEAR: i64

pub const TONE_MAPPER_REINHARDT: i64

impl Environment

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

Creates a new instance of this object.

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

pub fn adjustment_brightness(&self) -> f64

pub fn adjustment_color_correction(&self) -> Option<Ref<Texture, Shared>>

pub fn adjustment_contrast(&self) -> f64

pub fn adjustment_saturation(&self) -> f64

pub fn ambient_light_color(&self) -> Color

pub fn ambient_light_energy(&self) -> f64

pub fn ambient_light_sky_contribution(&self) -> f64

pub fn background(&self) -> BgMode

pub fn bg_color(&self) -> Color

pub fn bg_energy(&self) -> f64

pub fn camera_feed_id(&self) -> i64

pub fn canvas_max_layer(&self) -> i64

pub fn dof_blur_far_amount(&self) -> f64

pub fn dof_blur_far_distance(&self) -> f64

pub fn dof_blur_far_quality(&self) -> DofBlurQuality

pub fn dof_blur_far_transition(&self) -> f64

pub fn dof_blur_near_amount(&self) -> f64

pub fn dof_blur_near_distance(&self) -> f64

pub fn dof_blur_near_quality(&self) -> DofBlurQuality

pub fn dof_blur_near_transition(&self) -> f64

pub fn fog_color(&self) -> Color

pub fn fog_depth_begin(&self) -> f64

pub fn fog_depth_curve(&self) -> f64

pub fn fog_depth_end(&self) -> f64

pub fn fog_height_curve(&self) -> f64

pub fn fog_height_max(&self) -> f64

pub fn fog_height_min(&self) -> f64

pub fn fog_sun_amount(&self) -> f64

pub fn fog_sun_color(&self) -> Color

pub fn fog_transmit_curve(&self) -> f64

pub fn glow_blend_mode(&self) -> GlowBlendMode

pub fn glow_bloom(&self) -> f64

pub fn glow_hdr_bleed_scale(&self) -> f64

pub fn glow_hdr_bleed_threshold(&self) -> f64

pub fn glow_hdr_luminance_cap(&self) -> f64

pub fn glow_intensity(&self) -> f64

pub fn glow_strength(&self) -> f64

pub fn sky(&self) -> Option<Ref<Sky, Shared>>

pub fn sky_custom_fov(&self) -> f64

pub fn sky_orientation(&self) -> Basis

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

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

pub fn ssao_ao_channel_affect(&self) -> f64

pub fn ssao_bias(&self) -> f64

pub fn ssao_blur(&self) -> SsaoBlur

pub fn ssao_color(&self) -> Color

pub fn ssao_direct_light_affect(&self) -> f64

pub fn ssao_edge_sharpness(&self) -> f64

pub fn ssao_intensity(&self) -> f64

pub fn ssao_intensity2(&self) -> f64

pub fn ssao_quality(&self) -> SsaoQuality

pub fn ssao_radius(&self) -> f64

pub fn ssao_radius2(&self) -> f64

pub fn ssr_depth_tolerance(&self) -> f64

pub fn ssr_fade_in(&self) -> f64

pub fn ssr_fade_out(&self) -> f64

pub fn ssr_max_steps(&self) -> i64

pub fn tonemap_auto_exposure(&self) -> bool

pub fn tonemap_auto_exposure_grey(&self) -> f64

pub fn tonemap_auto_exposure_max(&self) -> f64

pub fn tonemap_auto_exposure_min(&self) -> f64

pub fn tonemap_auto_exposure_speed(&self) -> f64

pub fn tonemap_exposure(&self) -> f64

pub fn tonemap_white(&self) -> f64

pub fn tonemapper(&self) -> ToneMapper

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(&self, brightness: f64)

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

pub fn set_adjustment_contrast(&self, contrast: f64)

pub fn set_adjustment_enable(&self, enabled: bool)

pub fn set_adjustment_saturation(&self, saturation: f64)

pub fn set_ambient_light_color(&self, color: Color)

pub fn set_ambient_light_energy(&self, energy: f64)

pub fn set_ambient_light_sky_contribution(&self, energy: f64)

pub fn set_background(&self, mode: i64)

pub fn set_bg_color(&self, color: Color)

pub fn set_bg_energy(&self, energy: f64)

pub fn set_camera_feed_id(&self, camera_feed_id: i64)

pub fn set_canvas_max_layer(&self, layer: i64)

pub fn set_dof_blur_far_amount(&self, intensity: f64)

pub fn set_dof_blur_far_distance(&self, intensity: f64)

pub fn set_dof_blur_far_enabled(&self, enabled: bool)

pub fn set_dof_blur_far_quality(&self, intensity: i64)

pub fn set_dof_blur_far_transition(&self, intensity: f64)

pub fn set_dof_blur_near_amount(&self, intensity: f64)

pub fn set_dof_blur_near_distance(&self, intensity: f64)

pub fn set_dof_blur_near_enabled(&self, enabled: bool)

pub fn set_dof_blur_near_quality(&self, level: i64)

pub fn set_dof_blur_near_transition(&self, intensity: f64)

pub fn set_fog_color(&self, color: Color)

pub fn set_fog_depth_begin(&self, distance: f64)

pub fn set_fog_depth_curve(&self, curve: f64)

pub fn set_fog_depth_enabled(&self, enabled: bool)

pub fn set_fog_depth_end(&self, distance: f64)

pub fn set_fog_enabled(&self, enabled: bool)

pub fn set_fog_height_curve(&self, curve: f64)

pub fn set_fog_height_enabled(&self, enabled: bool)

pub fn set_fog_height_max(&self, height: f64)

pub fn set_fog_height_min(&self, height: f64)

pub fn set_fog_sun_amount(&self, amount: f64)

pub fn set_fog_sun_color(&self, color: Color)

pub fn set_fog_transmit_curve(&self, curve: f64)

pub fn set_fog_transmit_enabled(&self, enabled: bool)

pub fn set_glow_bicubic_upscale(&self, enabled: bool)

pub fn set_glow_blend_mode(&self, mode: i64)

pub fn set_glow_bloom(&self, amount: f64)

pub fn set_glow_enabled(&self, enabled: bool)

pub fn set_glow_hdr_bleed_scale(&self, scale: f64)

pub fn set_glow_hdr_bleed_threshold(&self, threshold: f64)

pub fn set_glow_hdr_luminance_cap(&self, amount: f64)

pub fn set_glow_intensity(&self, intensity: f64)

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

pub fn set_glow_strength(&self, strength: f64)

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

pub fn set_sky_custom_fov(&self, scale: f64)

pub fn set_sky_orientation(&self, orientation: Basis)

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

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

pub fn set_ssao_ao_channel_affect(&self, amount: f64)

pub fn set_ssao_bias(&self, bias: f64)

pub fn set_ssao_blur(&self, mode: i64)

pub fn set_ssao_color(&self, color: Color)

pub fn set_ssao_direct_light_affect(&self, amount: f64)

pub fn set_ssao_edge_sharpness(&self, edge_sharpness: f64)

pub fn set_ssao_enabled(&self, enabled: bool)

pub fn set_ssao_intensity(&self, intensity: f64)

pub fn set_ssao_intensity2(&self, intensity: f64)

pub fn set_ssao_quality(&self, quality: i64)

pub fn set_ssao_radius(&self, radius: f64)

pub fn set_ssao_radius2(&self, radius: f64)

pub fn set_ssr_depth_tolerance(&self, depth_tolerance: f64)

pub fn set_ssr_enabled(&self, enabled: bool)

pub fn set_ssr_fade_in(&self, fade_in: f64)

pub fn set_ssr_fade_out(&self, fade_out: f64)

pub fn set_ssr_max_steps(&self, max_steps: i64)

pub fn set_ssr_rough(&self, rough: bool)

pub fn set_tonemap_auto_exposure(&self, auto_exposure: bool)

pub fn set_tonemap_auto_exposure_grey(&self, exposure_grey: f64)

pub fn set_tonemap_auto_exposure_max(&self, exposure_max: f64)

pub fn set_tonemap_auto_exposure_min(&self, exposure_min: f64)

pub fn set_tonemap_auto_exposure_speed(&self, exposure_speed: f64)

pub fn set_tonemap_exposure(&self, exposure: f64)

pub fn set_tonemap_white(&self, white: f64)

pub fn set_tonemapper(&self, mode: i64)

Methods from Deref<Target = Resource>

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

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

pub fn name(&self) -> GodotString

pub fn path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

pub fn set_local_to_scene(&self, enable: bool)

pub fn set_name(&self, name: impl Into<GodotString>)

pub fn set_path(&self, path: impl Into<GodotString>)

pub fn setup_local_to_scene(&self)

pub fn take_over_path(&self, path: impl Into<GodotString>)

Trait Implementations

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

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 Environment

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

impl SubClass<Object> for Environment

impl SubClass<Reference> for Environment

impl SubClass<Resource> for Environment