Опции
Fixed options of the material, their list cannot be changed. They are used to set custom values for common material options. The type of ULON node is Option.Фиксированные параметры материала, их список изменить нельзя. Они используются для установки пользовательских значений для общих параметров материала. Тип узла ULON — Option.
The syntax is the following:Синтаксис следующий:
Option option_name = value(s)Preprocessor Auto Generation for ShadersАвтоматическая генерация препроцессора для шейдеров#
You can access options in the shader using the following defines:Вы можете получить доступ к параметрам в шейдере, используя следующие определения:
- GET_OPTION_<option name in uppercase> — available for all types of options.GET_OPTION_<имя опции в верхнем регистре> — доступно для всех типов опций.
| Option name | Option's define | Possible values |
|---|---|---|
| Transparent | GET_OPTION_TRANSPARENT |
0 — opaque (default) 1 — alpha test 2 — blend 3 — water |
| Order | GET_OPTION_ORDER |
-128..127
|
| Depth mask | GET_OPTION_DEPTH_MASK | 0 or 10 или 1 |
| Depth test | GET_OPTION_DEPTH_TEST | 0 or 10 или 1 |
| Two sided | GET_OPTION_TWO_SIDED | 0 or 10 или 1 |
| Cast shadow | GET_OPTION_CAST_PROJ_OMNI_SHADOW | 0 or 10 или 1 |
| Cast world shadow | GET_OPTION_CAST_WORLD_SHADOW | 0 or 10 или 1 |
| Overlap | GET_OPTION_OVERLAP | 0 or 10 или 1 |
- OPTION_<option name in uppercase> — defined only if an option has a positive value.OPTION_<имя опции в верхнем регистре> — определяется только в том случае, если опция имеет положительное значение.
| Option name | Option's define | Additional define(s) |
|---|---|---|
| Transparent | OPTION_TRANSPARENT |
0 — OPAQUE 1 — ALPHA_TEST 2 — TRANSPARENT_BLEND 3 — TRANSPARENT_WATER |
| Order | OPTION_ORDER | — |
| Depth mask | OPTION_DEPTH_MASK | — |
| Depth test | OPTION_DEPTH_TEST | — |
| Two sided | OPTION_TWO_SIDED | 1 — TWO_SIDED |
| Cast shadow | OPTION_CAST_PROJ_OMNI_SHADOW | — |
| Cast world shadow | OPTION_CAST_WORLD_SHADOW | — |
| Overlap | OPTION_OVERLAP | 1 — OVERLAP_RENDER |
For various blend modes the source and destination defines are generated:
Для различных режимов наложения генерируются определения source и destination:
BLEND_SRC_FUNC_<source blend option name in uppercase>
BLEND_DEST_FUNC_<destination blend option name in uppercase>
// Examples
BLEND_SRC_FUNC_SRC_ALPHA
BLEND_DEST_FUNC_ONE_MINUS_SRC_ALPHAUsage ExamplesПримеры использования#
BaseMaterial
{
Option depth_test = false
Option transparent = 2
Option blend_src = src_alpha
Option blend_dest = one_minus_src_alpha
}ArgumentsАргументы#
The argument names and values are case-sensitive.Имена и значения аргументов чувствительны к регистру.editableeditable#
Boolean
A flag indicating if option can be changed in the Parameters window or via API.Флаг, указывающий, можно ли изменить параметр в окне Parameters или через API .
Available values:Доступные значения:
- false — unchangeablefalse — неизменяемый
- true — changeable (by default)true — изменяемый (по умолчанию)
hiddenhidden#
Boolean
A flag indicating if option is displayed in the Parameters window.Флаг, указывающий, отображается ли опция в окне Parameters.
Available values:Доступные значения:
- false — displayed (by default)false — отображается (по умолчанию)
- true — hiddentrue — скрыто
Types of OptionsТипы опций#
blend_srcblend_src#
String
A node that allows you to set a blending option value (only for transparent objects and decals). It is a source image representing polygon color.Узел, который позволяет установить значение параметра смешивания (только для прозрачных объектов и декалей). Это исходное изображение, представляющее цвет многоугольника.
Available values:Доступные значения:
- zero — RGBA components of the source/destination image color are multiplied by zero.zero — компоненты RGBA цвета исходного/целевого изображения умножаются на ноль.
- one — RGBA components of the source/destination image color are multiplied by one.one — компоненты RGBA цвета исходного/целевого изображения умножаются на единицу.
- src_color — RGBA components of the source/destination image color are multiplied by the mR, mG, mB, mA components (per component).src_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты mR, mG, mB, mA (на компонент).
- one_minus_src_color — RGBA components of the source/destination image color are multiplied by the 1 - mR, 1 - mG, 1 - mB, 1 - mA components (per component).one_minus_src_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты 1 - mR, 1 - mG, 1 - mB, 1 - mA (на компонент).
- src_alpha — RGBA components of the source/destination image color are multiplied by the mA component.src_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент mA.
- one_minus_src_alpha — RGBA components of the source/destination image color are multiplied by the 1 - mA component.one_minus_src_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент 1 - mA.
- dest_color — RGBA components of the source/destination image color are multiplied by the bR, bG, bB, bA components (per component).dest_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты bR, bG, bB, bA (на компонент).
- one_minus_dest_color — RGBA components of the source/destination image color are multiplied by the 1 - bR, 1 - bG, 1 - bB, 1 - bA components (per component).one_minus_dest_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты 1 - bR, 1 - bG, 1 - bB, 1 - bA (на компонент).
- dest_alpha — RGBA components of the source/destination image color are multiplied by the bA component.dest_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент bA.
- one_minus_dest_alpha — RGBA components of the source/destination image color are multiplied by the 1 - bA component.one_minus_dest_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент 1 - bA.
mR, mG, mB, mA are normalized Red, Blue, Green and Alpha material image channels;mR, mG, mB, mA — нормированные каналы изображения материала Red, Blue, Green и Alpha;
bR, bG, bB, bA are normalized Red, Blue, Green and Alpha background image channels.bR, bG, bB, bA — нормализованные каналы фонового изображения Red, Blue, Green и Alpha.
blend_destblend_dest#
String
A node that allows you to set a blending option value (only for transparent objects and decals). It is a destination image representing screen buffer color.Узел, который позволяет установить значение параметра смешивания (только для прозрачных объектов и декалей). Это целевое изображение, представляющее цвет экранного буфера.
Available values:Доступные значения:
- zero — RGBA components of the source/destination image color are multiplied by zero.zero — компоненты RGBA цвета исходного/целевого изображения умножаются на ноль.
- one — RGBA components of the source/destination image color are multiplied by one.one — компоненты RGBA цвета исходного/целевого изображения умножаются на единицу.
- src_color — RGBA components of the source/destination image color are multiplied by the mR, mG, mB, mA components (per component).src_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты mR, mG, mB, mA (на компонент).
- one_minus_src_color — RGBA components of the source/destination image color are multiplied by the 1 - mR, 1 - mG, 1 - mB, 1 - mA components (per component).one_minus_src_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты 1 - mR, 1 - mG, 1 - mB, 1 - mA (на компонент).
- src_alpha — RGBA components of the source/destination image color are multiplied by the mA component.src_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент mA.
- one_minus_src_alpha — RGBA components of the source/destination image color are multiplied by the 1 - mA component.one_minus_src_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент 1 - mA.
- dest_color — RGBA components of the source/destination image color are multiplied by the bR, bG, bB, bA components (per component).dest_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты bR, bG, bB, bA (на компонент).
- one_minus_dest_color — RGBA components of the source/destination image color are multiplied by the 1 - bR, 1 - bG, 1 - bB, 1 - bA components (per component).one_minus_dest_color — компоненты RGBA цвета исходного/целевого изображения умножаются на компоненты 1 - bR, 1 - bG, 1 - bB, 1 - bA (на компонент).
- dest_alpha — RGBA components of the source/destination image color are multiplied by the bA component.dest_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент bA.
- one_minus_dest_alpha — RGBA components of the source/destination image color are multiplied by the 1 - bA component. one_minus_dest_alpha — компоненты RGBA цвета исходного/целевого изображения умножаются на компонент 1 - bA.
mR, mG, mB, mA are normalized Red, Blue, Green and Alpha material image channels;mR, mG, mB, mA — нормированные каналы изображения материала Red, Blue, Green и Alpha;
bR, bG, bB, bA are normalized Red, Blue, Green and Alpha background image channels.bR, bG, bB, bA — нормализованные каналы фонового изображения Red, Blue, Green и Alpha.
orderorder#
Char
Rendering order of the material. Specifies the priority of the material rendering (only for Object and Decal).Порядок рендеринга материала. Определяет приоритет рендеринга материала (только для Object и Decal).
Available values:Доступные значения:
- -128 .. 127. The default value is 0. The higher the rendering order, the lower the rendering priority (the material with the -128 order will be rendered first).-128 .. 127. Значение по умолчанию — 0. Чем выше порядок рендеринга, тем ниже приоритет рендеринга (материал с порядком -128 будет рендериться первым).
shadow_maskshadow_mask#
Integer
A shadow mask used to control shadows cast by an object lit by light sources (only for Object and Decal).Маска shadow, используемая для управления тенями, отбрасываемыми объектом, освещенным источниками света (только для Object и Decal).
Available values:Доступные значения:
- Integer number, representing a mask. The default value is ~0.Целое число, представляющее маску. Значение по умолчанию — ~0.
viewport_maskviewport_mask#
Integer
A viewport mask (only for Object and Decal).Маска viewport (только для Object и Decal).
Available values:Доступные значения:
- Integer number, representing a mask. The default value is ~0.Целое число, представляющее маску. Значение по умолчанию — ~0.
depth_maskdepth_mask#
Boolean
A flag indicating if writing in the depth buffer is enabled for a material (only for Object).Флаг, указывающий, если запись в буфер глубины включен для материала (только для Object).
Available values:Доступные значения:
- false — not usedfalse — не используется
- true — used (by default)true — используется (по умолчанию)
depth_testdepth_test#
Boolean
A flag indicating if the Depth Test option is enabled for a material (only for Object).Флаг, указывающий, включена ли для материала опция Depth Test (только для Object).
Available values:Доступные значения:
- false — disabledfalse — отключено
- true — enabled (by default)true — включено (по умолчанию)
two_sidedtwo_sided#
Boolean
A flag indicating if the Two Sided option is enabled for a material (only for Object).Флаг, указывающий, включена ли для материала опция Two Sided (только для Object).
Available values:Доступные значения:
- false — disabled (by default)false — отключено (по умолчанию)
- true — enabledtrue — включено
cast_shadowcast_shadow#
Boolean
A flag indicating if the Cast Proj and Omni Shadow option is enabled for a material (only for Object).Флаг, указывающий, включена ли для материала опция Cast Proj and Omni Shadow (только для Object).
Available values:Доступные значения:
- false — disabledfalse — отключено
- true — enabled (by default)true — включено (по умолчанию)
cast_world_shadowcast_world_shadow#
Boolean
A flag indicating if the Cast World shadow option is enabled for a material (only for Object).Флаг, указывающий, включена ли для материала опция Cast World shadow (только для Object).
Available values:Доступные значения:
- false — disabledfalse — отключено
- true — enabled (by default)true — включено (по умолчанию)
transparenttransparent#
Indicates how and when an object with this material will be rendered (only for Object). A lower value gives a higher priority in the rendering queue.Указывает, как и когда будет визуализирован объект с этим материалом (только для Object). Меньшее значение дает более высокий приоритет в очереди рендеринга.
Available values:Доступные значения:
IntegerЦелое число
- 0 = TRANSPARENT_NONE — opaque geometry that renders in deferred pass into GBuffer0 = TRANSPARENT_NONE — непрозрачная геометрия, которая рендерится в отложенном проходе в GBuffer
- 1 = TRANSPARENT_ALPHA_TEST — opaque geometry with enabled alpha test that renders in the deferred pass into GBuffer1 = TRANSPARENT_ALPHA_TEST — непрозрачная геометрия с включенным альфа-тестом, которая рендерится в отложенном проходе в GBuffer
- 2 = TRANSPARENT_BLEND — transparent geometry that renders in forward passes2 = TRANSPARENT_BLEND — прозрачная геометрия, которая рендерится в прямом проходе
- 3 = TRANSPARENT_WATER — water objects that renders in the deferred pass3 = TRANSPARENT_WATER — водные объекты, которые рендерятся в отложенном проходе
or a Stringили строка
- none = TRANSPARENT_NONE
- alpha_test = TRANSPARENT_ALPHA_TEST
- blend = TRANSPARENT_BLEND
- water = TRANSPARENT_WATER
overlapoverlap#
Boolean
A flag indicating if the Overlap option is enabled for a material (only for Object). This can be used for UI elements.Флаг, указывающий, включена ли для материала опция Overlap (только для Object). Это можно использовать для элементов пользовательского интерфейса.
Available values:Доступные значения:
- false — disabled (by default)false — отключено (по умолчанию)
- true — enabledtrue — включено