Environment

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Member Functions

float get_adjustment_brightness ( ) const
Texture get_adjustment_color_correction ( ) const
float get_adjustment_contrast ( ) const
float get_adjustment_saturation ( ) const
Color get_ambient_light_color ( ) const
float get_ambient_light_energy ( ) const
float get_ambient_light_sky_contribution ( ) const
int get_background ( ) const
Color get_bg_color ( ) const
float get_bg_energy ( ) const
int get_canvas_max_layer ( ) const
float get_dof_blur_far_amount ( ) const
float get_dof_blur_far_distance ( ) const
int get_dof_blur_far_quality ( ) const
float get_dof_blur_far_transition ( ) const
float get_dof_blur_near_amount ( ) const
float get_dof_blur_near_distance ( ) const
int get_dof_blur_near_quality ( ) const
float get_dof_blur_near_transition ( ) const
Color get_fog_color ( ) const
float get_fog_depth_begin ( ) const
float get_fog_depth_curve ( ) const
float get_fog_height_curve ( ) const
float get_fog_height_max ( ) const
float get_fog_height_min ( ) const
float get_fog_sun_amount ( ) const
Color get_fog_sun_color ( ) const
float get_fog_transmit_curve ( ) const
int get_glow_blend_mode ( ) const
float get_glow_bloom ( ) const
float get_glow_hdr_bleed_scale ( ) const
float get_glow_hdr_bleed_threshold ( ) const
float get_glow_intensity ( ) const
float get_glow_strength ( ) const
Sky get_sky ( ) const
float get_sky_scale ( ) const
float get_ssao_bias ( ) const
Color get_ssao_color ( ) const
float get_ssao_direct_light_affect ( ) const
float get_ssao_intensity ( ) const
float get_ssao_intensity2 ( ) const
float get_ssao_radius ( ) const
float get_ssao_radius2 ( ) const
float get_ssr_depth_tolerance ( ) const
float get_ssr_fade_in ( ) const
float get_ssr_fade_out ( ) const
int get_ssr_max_steps ( ) const
bool get_tonemap_auto_exposure ( ) const
float get_tonemap_auto_exposure_grey ( ) const
float get_tonemap_auto_exposure_max ( ) const
float get_tonemap_auto_exposure_min ( ) const
float get_tonemap_auto_exposure_speed ( ) const
float get_tonemap_exposure ( ) const
float get_tonemap_white ( ) const
int get_tonemapper ( ) const
bool is_adjustment_enabled ( ) const
bool is_dof_blur_far_enabled ( ) const
bool is_dof_blur_near_enabled ( ) const
bool is_fog_depth_enabled ( ) const
bool is_fog_enabled ( ) const
bool is_fog_height_enabled ( ) const
bool is_fog_transmit_enabled ( ) const
bool is_glow_bicubic_upscale_enabled ( ) const
bool is_glow_enabled ( ) const
bool is_glow_level_enabled ( int idx ) const
bool is_ssao_blur_enabled ( ) const
bool is_ssao_enabled ( ) const
bool is_ssr_enabled ( ) const
bool is_ssr_rough ( ) const
void set_adjustment_brightness ( float brightness )
void set_adjustment_color_correction ( Texture color_correction )
void set_adjustment_contrast ( float contrast )
void set_adjustment_enable ( bool enabled )
void set_adjustment_saturation ( float saturation )
void set_ambient_light_color ( Color color )
void set_ambient_light_energy ( float energy )
void set_ambient_light_sky_contribution ( float energy )
void set_background ( int mode )
void set_bg_color ( Color color )
void set_bg_energy ( float energy )
void set_canvas_max_layer ( int layer )
void set_dof_blur_far_amount ( float intensity )
void set_dof_blur_far_distance ( float intensity )
void set_dof_blur_far_enabled ( bool enabled )
void set_dof_blur_far_quality ( int intensity )
void set_dof_blur_far_transition ( float intensity )
void set_dof_blur_near_amount ( float intensity )
void set_dof_blur_near_distance ( float intensity )
void set_dof_blur_near_enabled ( bool enabled )
void set_dof_blur_near_quality ( int level )
void set_dof_blur_near_transition ( float intensity )
void set_fog_color ( Color color )
void set_fog_depth_begin ( float distance )
void set_fog_depth_curve ( float curve )
void set_fog_depth_enabled ( bool enabled )
void set_fog_enabled ( bool enabled )
void set_fog_height_curve ( float curve )
void set_fog_height_enabled ( bool enabled )
void set_fog_height_max ( float height )
void set_fog_height_min ( float height )
void set_fog_sun_amount ( float amount )
void set_fog_sun_color ( Color color )
void set_fog_transmit_curve ( float curve )
void set_fog_transmit_enabled ( bool enabled )
void set_glow_bicubic_upscale ( bool enabled )
void set_glow_blend_mode ( int mode )
void set_glow_bloom ( float amount )
void set_glow_enabled ( bool enabled )
void set_glow_hdr_bleed_scale ( float scale )
void set_glow_hdr_bleed_threshold ( float threshold )
void set_glow_intensity ( float intensity )
void set_glow_level ( int idx, bool enabled )
void set_glow_strength ( float strength )
void set_sky ( Sky sky )
void set_sky_scale ( float scale )
void set_ssao_bias ( float bias )
void set_ssao_blur ( bool enabled )
void set_ssao_color ( Color color )
void set_ssao_direct_light_affect ( float amount )
void set_ssao_enabled ( bool enabled )
void set_ssao_intensity ( float intensity )
void set_ssao_intensity2 ( float intensity )
void set_ssao_radius ( float radius )
void set_ssao_radius2 ( float radius )
void set_ssr_depth_tolerance ( float depth_tolerance )
void set_ssr_enabled ( bool enabled )
void set_ssr_fade_in ( float fade_in )
void set_ssr_fade_out ( float fade_out )
void set_ssr_max_steps ( int max_steps )
void set_ssr_rough ( bool rough )
void set_tonemap_auto_exposure ( bool auto_exposure )
void set_tonemap_auto_exposure_grey ( float exposure_grey )
void set_tonemap_auto_exposure_max ( float exposure_max )
void set_tonemap_auto_exposure_min ( float exposure_min )
void set_tonemap_auto_exposure_speed ( float exposure_speed )
void set_tonemap_exposure ( float exposure )
void set_tonemap_white ( float white )
void set_tonemapper ( int mode )

Member Variables

  • float adjustment_brightness
  • Texture adjustment_color_correction
  • float adjustment_contrast
  • bool adjustment_enabled
  • float adjustment_saturation
  • Color ambient_light_color
  • float ambient_light_energy
  • float ambient_light_sky_contribution
  • bool auto_exposure_enabled
  • float auto_exposure_max_luma
  • float auto_exposure_min_luma
  • float auto_exposure_scale
  • float auto_exposure_speed
  • int background_canvas_max_layer
  • Color background_color
  • float background_energy
  • int background_mode
  • Sky background_sky
  • float background_sky_scale
  • float dof_blur_far_amount
  • float dof_blur_far_distance
  • bool dof_blur_far_enabled
  • int dof_blur_far_quality
  • float dof_blur_far_transition
  • float dof_blur_near_amount
  • float dof_blur_near_distance
  • bool dof_blur_near_enabled
  • int dof_blur_near_quality
  • float dof_blur_near_transition
  • Color fog_color
  • float fog_depth_begin
  • float fog_depth_curve
  • bool fog_depth_enabled
  • bool fog_enabled
  • float fog_height_curve
  • bool fog_height_enabled
  • float fog_height_max
  • float fog_height_min
  • float fog_sun_amount
  • Color fog_sun_color
  • float fog_transmit_curve
  • bool fog_transmit_enabled
  • bool glow_bicubic_upscale
  • int glow_blend_mode
  • float glow_bloom
  • bool glow_enabled
  • float glow_hdr_scale
  • float glow_hdr_threshold
  • float glow_intensity
  • bool glow_levels/1
  • bool glow_levels/2
  • bool glow_levels/3
  • bool glow_levels/4
  • bool glow_levels/5
  • bool glow_levels/6
  • bool glow_levels/7
  • float glow_strength
  • float ss_reflections_depth_tolerance
  • bool ss_reflections_enabled
  • float ss_reflections_fade_in
  • float ss_reflections_fade_out
  • int ss_reflections_max_steps
  • bool ss_reflections_roughness
  • float ssao_bias
  • bool ssao_blur
  • Color ssao_color
  • bool ssao_enabled
  • float ssao_intensity
  • float ssao_intensity2
  • float ssao_light_affect
  • float ssao_radius
  • float ssao_radius2
  • float tonemap_exposure
  • int tonemap_mode
  • float tonemap_white

Numeric Constants

  • BG_KEEP = 4
  • BG_CLEAR_COLOR = 0
  • BG_COLOR = 1
  • BG_SKY = 2
  • BG_CANVAS = 3
  • BG_MAX = 5
  • GLOW_BLEND_MODE_ADDITIVE = 0
  • GLOW_BLEND_MODE_SCREEN = 1
  • GLOW_BLEND_MODE_SOFTLIGHT = 2
  • GLOW_BLEND_MODE_REPLACE = 3
  • TONE_MAPPER_LINEAR = 0
  • TONE_MAPPER_REINHARDT = 1
  • TONE_MAPPER_FILMIC = 2
  • TONE_MAPPER_ACES = 3
  • DOF_BLUR_QUALITY_LOW = 0
  • DOF_BLUR_QUALITY_MEDIUM = 1
  • DOF_BLUR_QUALITY_HIGH = 2

Member Function Description

  • float get_adjustment_brightness ( ) const
  • Texture get_adjustment_color_correction ( ) const
  • float get_adjustment_contrast ( ) const
  • float get_adjustment_saturation ( ) const
  • Color get_ambient_light_color ( ) const
  • float get_ambient_light_energy ( ) const
  • float get_ambient_light_sky_contribution ( ) const
  • int get_background ( ) const
  • Color get_bg_color ( ) const
  • float get_bg_energy ( ) const
  • int get_canvas_max_layer ( ) const
  • float get_dof_blur_far_amount ( ) const
  • float get_dof_blur_far_distance ( ) const
  • int get_dof_blur_far_quality ( ) const
  • float get_dof_blur_far_transition ( ) const
  • float get_dof_blur_near_amount ( ) const
  • float get_dof_blur_near_distance ( ) const
  • int get_dof_blur_near_quality ( ) const
  • float get_dof_blur_near_transition ( ) const
  • Color get_fog_color ( ) const
  • float get_fog_depth_begin ( ) const
  • float get_fog_depth_curve ( ) const
  • float get_fog_height_curve ( ) const
  • float get_fog_height_max ( ) const
  • float get_fog_height_min ( ) const
  • float get_fog_sun_amount ( ) const
  • Color get_fog_sun_color ( ) const
  • float get_fog_transmit_curve ( ) const
  • int get_glow_blend_mode ( ) const
  • float get_glow_bloom ( ) const
  • float get_glow_hdr_bleed_scale ( ) const
  • float get_glow_hdr_bleed_threshold ( ) const
  • float get_glow_intensity ( ) const
  • float get_glow_strength ( ) const
  • Sky get_sky ( ) const
  • float get_sky_scale ( ) const
  • float get_ssao_bias ( ) const
  • Color get_ssao_color ( ) const
  • float get_ssao_direct_light_affect ( ) const
  • float get_ssao_intensity ( ) const
  • float get_ssao_intensity2 ( ) const
  • float get_ssao_radius ( ) const
  • float get_ssao_radius2 ( ) const
  • float get_ssr_depth_tolerance ( ) const
  • float get_ssr_fade_in ( ) const
  • float get_ssr_fade_out ( ) const
  • int get_ssr_max_steps ( ) const
  • bool get_tonemap_auto_exposure ( ) const
  • float get_tonemap_auto_exposure_grey ( ) const
  • float get_tonemap_auto_exposure_max ( ) const
  • float get_tonemap_auto_exposure_min ( ) const
  • float get_tonemap_auto_exposure_speed ( ) const
  • float get_tonemap_exposure ( ) const
  • float get_tonemap_white ( ) const
  • int get_tonemapper ( ) const
  • bool is_adjustment_enabled ( ) const
  • bool is_dof_blur_far_enabled ( ) const
  • bool is_dof_blur_near_enabled ( ) const
  • bool is_fog_depth_enabled ( ) const
  • bool is_fog_enabled ( ) const
  • bool is_fog_height_enabled ( ) const
  • bool is_fog_transmit_enabled ( ) const
  • bool is_glow_bicubic_upscale_enabled ( ) const
  • bool is_glow_enabled ( ) const
  • bool is_glow_level_enabled ( int idx ) const
  • bool is_ssao_blur_enabled ( ) const
  • bool is_ssao_enabled ( ) const
  • bool is_ssr_enabled ( ) const
  • bool is_ssr_rough ( ) const
  • void set_adjustment_brightness ( float brightness )
  • void set_adjustment_color_correction ( Texture color_correction )
  • void set_adjustment_contrast ( float contrast )
  • void set_adjustment_enable ( bool enabled )
  • void set_adjustment_saturation ( float saturation )
  • void set_ambient_light_color ( Color color )
  • void set_ambient_light_energy ( float energy )
  • void set_ambient_light_sky_contribution ( float energy )
  • void set_background ( int mode )
  • void set_bg_color ( Color color )
  • void set_bg_energy ( float energy )
  • void set_canvas_max_layer ( int layer )
  • void set_dof_blur_far_amount ( float intensity )
  • void set_dof_blur_far_distance ( float intensity )
  • void set_dof_blur_far_enabled ( bool enabled )
  • void set_dof_blur_far_quality ( int intensity )
  • void set_dof_blur_far_transition ( float intensity )
  • void set_dof_blur_near_amount ( float intensity )
  • void set_dof_blur_near_distance ( float intensity )
  • void set_dof_blur_near_enabled ( bool enabled )
  • void set_dof_blur_near_quality ( int level )
  • void set_dof_blur_near_transition ( float intensity )
  • void set_fog_color ( Color color )
  • void set_fog_depth_begin ( float distance )
  • void set_fog_depth_curve ( float curve )
  • void set_fog_depth_enabled ( bool enabled )
  • void set_fog_enabled ( bool enabled )
  • void set_fog_height_curve ( float curve )
  • void set_fog_height_enabled ( bool enabled )
  • void set_fog_height_max ( float height )
  • void set_fog_height_min ( float height )
  • void set_fog_sun_amount ( float amount )
  • void set_fog_sun_color ( Color color )
  • void set_fog_transmit_curve ( float curve )
  • void set_fog_transmit_enabled ( bool enabled )
  • void set_glow_bicubic_upscale ( bool enabled )
  • void set_glow_blend_mode ( int mode )
  • void set_glow_bloom ( float amount )
  • void set_glow_enabled ( bool enabled )
  • void set_glow_hdr_bleed_scale ( float scale )
  • void set_glow_hdr_bleed_threshold ( float threshold )
  • void set_glow_intensity ( float intensity )
  • void set_glow_level ( int idx, bool enabled )
  • void set_glow_strength ( float strength )
  • void set_sky ( Sky sky )
  • void set_sky_scale ( float scale )
  • void set_ssao_bias ( float bias )
  • void set_ssao_blur ( bool enabled )
  • void set_ssao_color ( Color color )
  • void set_ssao_direct_light_affect ( float amount )
  • void set_ssao_enabled ( bool enabled )
  • void set_ssao_intensity ( float intensity )
  • void set_ssao_intensity2 ( float intensity )
  • void set_ssao_radius ( float radius )
  • void set_ssao_radius2 ( float radius )
  • void set_ssr_depth_tolerance ( float depth_tolerance )
  • void set_ssr_enabled ( bool enabled )
  • void set_ssr_fade_in ( float fade_in )
  • void set_ssr_fade_out ( float fade_out )
  • void set_ssr_max_steps ( int max_steps )
  • void set_ssr_rough ( bool rough )
  • void set_tonemap_auto_exposure ( bool auto_exposure )
  • void set_tonemap_auto_exposure_grey ( float exposure_grey )
  • void set_tonemap_auto_exposure_max ( float exposure_max )
  • void set_tonemap_auto_exposure_min ( float exposure_min )
  • void set_tonemap_auto_exposure_speed ( float exposure_speed )
  • void set_tonemap_exposure ( float exposure )
  • void set_tonemap_white ( float white )
  • void set_tonemapper ( int mode )