Light2D — C# API

class Light2DReckfellSharpНаследует Entity2D

Излучает свет в 2D-среде.

Излучает свет в 2D-среде. Свет определяется цветом, значением энергии, режимом (см. константы) и различными другими параметрами (диапазоном и тенями).

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Свойства15

BlendModeСвойство

# BlendMode

C#
public Light2D.BlendModeEnum BlendMode { get; set; }

Режим смешивания Light2D.

ColorСвойство

# Color

C#
public Color Color { get; set; }

Color в Light2D.

Только редактор

EditorOnlyСвойство

# EditorOnly

C#
public bool EditorOnly { get; set; }

Если true, Light2D будет отображаться только при редактировании сцены.

EnabledСвойство

# Enabled

C#
public bool Enabled { get; set; }

Если true, Light2D будет излучать свет.

EnergyСвойство

# Energy

C#
public float Energy { get; set; }

Значение энергии Light2D. Чем больше значение, тем сильнее свет.

RangeItemCullMaskСвойство

# RangeItemCullMask

C#
public int RangeItemCullMask { get; set; }

Маска слоя. Только объекты с соответствующим CanvasItem.LightMask будут затронуты Light2D. См. также Light2D.ShadowItemCullMask, который влияет на то, какие объекты могут отбрасывать тени. Примечание: Light2D.RangeItemCullMask игнорируется DirectionalLight2D, который всегда будет освещать 2D-узел независимо от CanvasItem.LightMask 2D-узла.

RangeLayerMaxСвойство

# RangeLayerMax

C#
public int RangeLayerMax { get; set; }

Максимальное значение слоя объектов, на которые влияет Light2D.

RangeLayerMinСвойство

# RangeLayerMin

C#
public int RangeLayerMin { get; set; }

Минимальное значение слоя объектов, на которые влияет Light2D.

RangeZMaxСвойство

# RangeZMax

C#
public int RangeZMax { get; set; }

Максимальное значение z объектов, на которые влияет Light2D.

RangeZMinСвойство

# RangeZMin

C#
public int RangeZMin { get; set; }

Минимальное значение z объектов, на которые влияет Light2D.

ShadowColorСвойство

# ShadowColor

C#
public Color ShadowColor { get; set; }

Color теней, отбрасываемых Light2D.

ShadowEnabledСвойство

# ShadowEnabled

C#
public bool ShadowEnabled { get; set; }

Если true, Light2D будет отбрасывать тени.

ShadowFilterСвойство

# ShadowFilter

C#
public Light2D.ShadowFilterEnum ShadowFilter { get; set; }

Тип фильтра теней.

ShadowFilterSmoothСвойство

# ShadowFilterSmooth

C#
public float ShadowFilterSmooth { get; set; }

Значение сглаживания для теней. Более высокие значения приведут к более мягким теням за счет видимых полос, которые могут появиться при рендеринге теней. Light2D.ShadowFilterSmooth имеет эффект только в том случае, если Light2D.ShadowFilter равен Light2D.ShadowFilterEnum.Pcf5 или Light2D.ShadowFilterEnum.Pcf13.

ShadowItemCullMaskСвойство

# ShadowItemCullMask

C#
public int ShadowItemCullMask { get; set; }

Битовая маска теней. Для PointLight2D отбор заслонителя учитывает пересечение с LightOccluder2D.OccluderLightMask; применение тени к получателю также учитывает CanvasItem.LightMask. Это отдельная проверка от RangeItemCullMask, который выбирает освещаемые объекты. Для начала задайте всем этим маскам 1; затем разделяйте группы осознанно.

Проверяемый пример масок.

Методы32

GetBlendModeLight2D.BlendModeEnum

# GetBlendMode

C#
public Light2D.BlendModeEnum GetBlendMode();

Возвращает Light2D.BlendModeEnum

GetColorColor

# GetColor

C#
public Color GetColor();

Возвращает Color

GetEnergyfloat

# GetEnergy

C#
public float GetEnergy();

Возвращает float

GetHeightfloat

# GetHeight

C#
public float GetHeight();

Возвращает высоту источника света, которая используется в 2D-нормальном отображении. См. PointLight2D.Height и DirectionalLight2D.Height.

Возвращает float

GetItemCullMaskint

# GetItemCullMask

C#
public int GetItemCullMask();

Возвращает int

GetItemShadowCullMaskint

# GetItemShadowCullMask

C#
public int GetItemShadowCullMask();

Возвращает int

GetLayerRangeMaxint

# GetLayerRangeMax

C#
public int GetLayerRangeMax();

Возвращает int

GetLayerRangeMinint

# GetLayerRangeMin

C#
public int GetLayerRangeMin();

Возвращает int

GetShadowColorColor

# GetShadowColor

C#
public Color GetShadowColor();

Возвращает Color

GetShadowFilterLight2D.ShadowFilterEnum

# GetShadowFilter

C#
public Light2D.ShadowFilterEnum GetShadowFilter();

Возвращает Light2D.ShadowFilterEnum

GetShadowSmoothfloat

# GetShadowSmooth

C#
public float GetShadowSmooth();

Возвращает float

GetZRangeMaxint

# GetZRangeMax

C#
public int GetZRangeMax();

Возвращает int

GetZRangeMinint

# GetZRangeMin

C#
public int GetZRangeMin();

Возвращает int

IsEditorOnlybool

# IsEditorOnly

C#
public bool IsEditorOnly();

Возвращает bool

IsEnabledbool

# IsEnabled

C#
public bool IsEnabled();

Возвращает bool

IsShadowEnabledbool

# IsShadowEnabled

C#
public bool IsShadowEnabled();

Возвращает bool

SetBlendModevoid

# SetBlendMode

C#
public void SetBlendMode(Light2D.BlendModeEnum mode);

Параметры
Имя	Тип	По умолчанию
`mode`	`Light2D.BlendModeEnum`	—

SetColorvoid

# SetColor

C#
public void SetColor(Color color);

Параметры
Имя	Тип	По умолчанию
`color`	`Color`	—

SetEditorOnlyvoid

# SetEditorOnly

C#
public void SetEditorOnly(bool editorOnly);

Параметры
Имя	Тип	По умолчанию
`editorOnly`	`bool`	—

SetEnabledvoid

# SetEnabled

C#
public void SetEnabled(bool enabled);

Параметры
Имя	Тип	По умолчанию
`enabled`	`bool`	—

SetEnergyvoid

# SetEnergy

C#
public void SetEnergy(float energy);

Параметры
Имя	Тип	По умолчанию
`energy`	`float`	—

SetHeightvoid

# SetHeight

C#
public void SetHeight(float height);

Устанавливает высоту света, которая используется в 2D-нормальном отображении. См. PointLight2D.Height и DirectionalLight2D.Height.

Параметры
Имя	Тип	По умолчанию
`height`	`float`	—

SetItemCullMaskvoid

# SetItemCullMask

C#
public void SetItemCullMask(int itemCullMask);

Параметры
Имя	Тип	По умолчанию
`itemCullMask`	`int`	—

SetItemShadowCullMaskvoid

# SetItemShadowCullMask

C#
public void SetItemShadowCullMask(int itemShadowCullMask);

Параметры
Имя	Тип	По умолчанию
`itemShadowCullMask`	`int`	—

SetLayerRangeMaxvoid

# SetLayerRangeMax

C#
public void SetLayerRangeMax(int layer);

Параметры
Имя	Тип	По умолчанию
`layer`	`int`	—

SetLayerRangeMinvoid

# SetLayerRangeMin

C#
public void SetLayerRangeMin(int layer);

Параметры
Имя	Тип	По умолчанию
`layer`	`int`	—

SetShadowColorvoid

# SetShadowColor

C#
public void SetShadowColor(Color shadowColor);

Параметры
Имя	Тип	По умолчанию
`shadowColor`	`Color`	—

SetShadowEnabledvoid

# SetShadowEnabled

C#
public void SetShadowEnabled(bool enabled);

Параметры
Имя	Тип	По умолчанию
`enabled`	`bool`	—

SetShadowFiltervoid

# SetShadowFilter

C#
public void SetShadowFilter(Light2D.ShadowFilterEnum filter);

Параметры
Имя	Тип	По умолчанию
`filter`	`Light2D.ShadowFilterEnum`	—

SetShadowSmoothvoid

# SetShadowSmooth

C#
public void SetShadowSmooth(float smooth);

Параметры
Имя	Тип	По умолчанию
`smooth`	`float`	—

SetZRangeMaxvoid

# SetZRangeMax

C#
public void SetZRangeMax(int z);

Параметры
Имя	Тип	По умолчанию
`z`	`int`	—

SetZRangeMinvoid

# SetZRangeMin

C#
public void SetZRangeMin(int z);

Параметры
Имя	Тип	По умолчанию
`z`	`int`	—

Light2D.BlendModeEnum

Значение	Описание
`Add = 0`	Добавляет значение пикселей, соответствующих Light2D, к значениям пикселей под ним. Это обычное поведение света.
`Mix = 2`	Смешиваем значения пикселей, соответствующих Light2D, со значениями пикселей под ним с помощью линейной интерполяции.
`Sub = 1`	Вычитает значение пикселей, соответствующих Light2D, из значений пикселей под ним, что приводит к эффекту инвертированного света.

Light2D.ShadowFilterEnum

Значение	Описание
`None = 0`	Фильтр не применяется к карте теней. Это обеспечивает жесткие края теней и является самым быстрым для рендеринга. См. `Light2D.ShadowFilter`.
`Pcf13 = 2`	Фильтрация сближения процентов (13 образцов) применяется к карте теней. Это самый медленный режим фильтрации теней, и его следует использовать экономно. См. `Light2D.ShadowFilter`.
`Pcf5 = 1`	Фильтрация сближения процентов (5 образцов) применяется к карте теней. Это медленнее по сравнению с жестким рендерингом теней. См. `Light2D.ShadowFilter`.