Terrain Engine 2D  1.10
A 2D Block Engine
TerrainEngine2D.Lighting.AdvancedLightSystem Class Reference

An advanced 2D block lighting system More...

Inheritance diagram for TerrainEngine2D.Lighting.AdvancedLightSystem:
TerrainEngine2D.MonoBehaviourSingleton< AdvancedLightSystem >

Public Attributes

Camera LightCamera
 The lighting camera More...
 
Camera OverlayCamera
 The overlay camera; for objects that should render on top of the lighting More...
 
Color32 SunlightColor = Color.white
 The color of the ambient lighting in the daytime More...
 
Color32 MoonlightColor = new Color32()
 The color of the ambient lighting in the nighttime More...
 
int DownRes = 1
 The amount to scale down the lighting texture (in powers of 2) More...
 
int NumberBlurPasses = 1
 The number of times the lighting texture will be blurred More...
 

Protected Member Functions

override void Awake ()
 

Properties

RenderTexture LightRenderTexture [get]
 The render texture used to capture the light graphics More...
 
RenderTexture OverlayRenderTexture [get]
 The render texture used to capture graphics which overlay the lighting More...
 
int LightBleed [get]
 The number of blocks from the edge of the terrain for light to illuminate Higher value means more blocks illuminated further from the edge of the terrain from a source of light More...
 
bool UseHeightMap [get]
 Whether to use the heightmap to calulate an ambient light value More...
 
int AmbientLightBleed [get]
 Amount of blocks that ambient light can bleed through vertically into the terrain More...
 
- Properties inherited from TerrainEngine2D.MonoBehaviourSingleton< AdvancedLightSystem >
static T Instance [get]
 

Detailed Description

An advanced 2D block lighting system

Member Function Documentation

◆ Awake()

override void TerrainEngine2D.Lighting.AdvancedLightSystem.Awake ( )
protectedvirtual

Member Data Documentation

◆ DownRes

int TerrainEngine2D.Lighting.AdvancedLightSystem.DownRes = 1

The amount to scale down the lighting texture (in powers of 2)

◆ LightCamera

Camera TerrainEngine2D.Lighting.AdvancedLightSystem.LightCamera

The lighting camera

◆ MoonlightColor

Color32 TerrainEngine2D.Lighting.AdvancedLightSystem.MoonlightColor = new Color32()

The color of the ambient lighting in the nighttime

◆ NumberBlurPasses

int TerrainEngine2D.Lighting.AdvancedLightSystem.NumberBlurPasses = 1

The number of times the lighting texture will be blurred

◆ OverlayCamera

Camera TerrainEngine2D.Lighting.AdvancedLightSystem.OverlayCamera

The overlay camera; for objects that should render on top of the lighting

◆ SunlightColor

Color32 TerrainEngine2D.Lighting.AdvancedLightSystem.SunlightColor = Color.white

The color of the ambient lighting in the daytime

Property Documentation

◆ AmbientLightBleed

int TerrainEngine2D.Lighting.AdvancedLightSystem.AmbientLightBleed
get

Amount of blocks that ambient light can bleed through vertically into the terrain

◆ LightBleed

int TerrainEngine2D.Lighting.AdvancedLightSystem.LightBleed
get

The number of blocks from the edge of the terrain for light to illuminate Higher value means more blocks illuminated further from the edge of the terrain from a source of light

◆ LightRenderTexture

RenderTexture TerrainEngine2D.Lighting.AdvancedLightSystem.LightRenderTexture
get

The render texture used to capture the light graphics

◆ OverlayRenderTexture

RenderTexture TerrainEngine2D.Lighting.AdvancedLightSystem.OverlayRenderTexture
get

The render texture used to capture graphics which overlay the lighting

◆ UseHeightMap

bool TerrainEngine2D.Lighting.AdvancedLightSystem.UseHeightMap
get

Whether to use the heightmap to calulate an ambient light value


The documentation for this class was generated from the following file: