eevee_world.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2021 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_world_types.h"
 
#include "eevee_lookdev.hh"
#include "eevee_sync.hh"
 
struct bNodeTree;
struct bNodeSocketValueRGBA;
struct UniformBuffer;
 
namespace blender::eevee {
 
class Instance;

 
/* -------------------------------------------------------------------- */
 
class World {
 public:
  UniformBuffer<LightData> sunlight = {"sunlight"};
 
 private:
  Instance &inst_;
 
  /* Used to detect if world change. */
  ::World *prev_original_world = nullptr;
 
  /* Used when the scene doesn't have a world. */
  ::World *default_world_ = nullptr;
 
  /* Is true if world as a valid volume shader compiled. */
  bool has_volume_ = false;
  /* Is true if the volume shader has absorption. Disables distant lights. */
  bool has_volume_absorption_ = false;
  /* Is true if the volume shader has scattering. */
  bool has_volume_scatter_ = false;
  /* Is true if the surface shader is compiled and ready. */
  bool is_ready_ = false;
 
  LookdevWorld lookdev_world_;
 
 public:
  World(Instance &inst) : inst_(inst) {};
  ~World();
 
  /* Setup and request the background shader. */
  void sync();
 
  bool has_volume() const
  {
    return has_volume_;
  }
 
  bool has_volume_absorption() const
  {
    return has_volume_absorption_;
  }
 
  bool has_volume_scatter() const
  {
    return has_volume_scatter_;
  }
 
  bool is_ready() const
  {
    return is_ready_;
  }
 
  float sun_threshold();
 
  float sun_angle()
  {
    return scene_world_get()->sun_angle;
  }
 
  float sun_shadow_max_resolution()
  {
    return scene_world_get()->sun_shadow_maximum_resolution;
  }
 
  float sun_shadow_filter_radius()
  {
    return scene_world_get()->sun_shadow_filter_radius;
  }
 
  float sun_shadow_jitter_overblur()
  {
    return scene_world_get()->sun_shadow_jitter_overblur;
  }
 
  bool use_sun_shadow()
  {
    return scene_world_get()->flag & WO_USE_SUN_SHADOW;
  }
 
  bool use_sun_shadow_jitter()
  {
    return scene_world_get()->flag & WO_USE_SUN_SHADOW_JITTER;
  }
 
 private:
  void sync_volume(const WorldHandle &world_handle, bool wait_ready);
 
  /* Returns a dummy black world for when a valid world isn't present or when we want to suppress
   * any light coming from the world. */
  ::World *default_world_get();
 
  /* Returns either the scene world or the default world if scene has no world. */
  ::World *scene_world_get();
};

 
}  // namespace blender::eevee