Light2D

Inherits: Node2D < CanvasItem < Node < Object Casts light in a 2D environment.

Description

Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note: Light2D can also be used as a mask.

Tutorials

  • 2D lights and shadows

    Properties

    Enumerations

    Mode:
  • MODE_ADD = 0 —- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.
  • MODE_SUB = 1 —- Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
  • MODE_MIX = 2 —- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
  • MODE_MASK = 3 —- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.

ShadowFilter:

  • SHADOW_FILTER_NONE = 0 —- No filter applies to the shadow map. See shadow_filter.
  • SHADOW_FILTER_PCF3 = 1 —- Percentage closer filtering (3 samples) applies to the shadow map. See shadow_filter.
  • SHADOW_FILTER_PCF5 = 2 —- Percentage closer filtering (5 samples) applies to the shadow map. See shadow_filter.
  • SHADOW_FILTER_PCF7 = 3 —- Percentage closer filtering (7 samples) applies to the shadow map. See shadow_filter.
  • SHADOW_FILTER_PCF9 = 4 —- Percentage closer filtering (9 samples) applies to the shadow map. See shadow_filter.
  • SHADOW_FILTER_PCF13 = 5 —- Percentage closer filtering (13 samples) applies to the shadow map. See shadow_filter.

    Property Descriptions

  • Color color Color.
  • bool editor_only true, Light2D will only appear when editing the scene.
  • bool enabled true, Light2D will emit light.
  • float energy The Light2D’s energy value. The larger the value, the stronger the light.
  • Mode mode Mode constants for values.
  • Vector2 offset texture.
  • float range_height The height of the Light2D. Used with 2D normal mapping.
  • int range_item_cull_mask The layer mask. Only objects with a matching mask will be affected by the Light2D.
  • int range_layer_max Maximum layer value of objects that are affected by the Light2D.
  • int range_layer_min Minimum layer value of objects that are affected by the Light2D.
  • int range_z_max z value of objects that are affected by the Light2D.
  • int range_z_min z value of objects that are affected by the Light2D.
  • int shadow_buffer_size Shadow buffer size.
  • Color shadow_color Color of shadows cast by the Light2D.
  • bool shadow_enabled true, the Light2D will cast shadows.
  • ShadowFilter shadow_filter ShadowFilter for possible values.
  • float shadow_filter_smooth Smoothing value for shadows.
  • float shadow_gradient_length Smooth shadow gradient length.
  • int shadow_item_cull_mask LightOccluder2D to cast shadows. Only occluders with a matching light mask will cast shadows.
  • Texture texture Texture used for the Light2D’s appearance.
  • float texture_scale texture‘s scale factor.