Параметры

Разделы:

The material parameter that is available in the shader as a variable. Use the type of the ULON node for the parameter type.Параметр материала, который доступен в шейдере как переменная. Используйте тип узла ULON для типа параметра.

The syntax is the following:Синтаксис следующий:

ULON

ParameterType name = value <attributes>

The parameters are passed to shaders with the specified variable prefix.Параметры передаются шейдерам с указанным изменяемым префиксом.

Types of Parameters
Типы параметров#

float / float2 / float3 / float4 — a float vector of N components in UUSLfloat / float2 / float3 / float4 — вектор с плавающей запятой N компонентов в UUSL
Int / Int2 / Int3 / Int4 — an integer (int) vector of N components in UUSLInt/Int2/Int3/Int4 — целочисленный (int) вектор N компонентов в UUSL
ArrayFloat / ArrayFloat2 / ArrayFloat4 — an array of float vectors with N components in UUSLArrayFloat/ArrayFloat2/ArrayFloat4 — массив векторов с плавающей запятой с N компонентами в UUSL
ArrayInt / ArrayInt2 / ArrayInt4 — an array of integer (int) vectors with N components in UUSLArrayInt/ArrayInt2/ArrayInt4 — массив целочисленных (int) векторов с N компонентами в UUSL
Color — a float vector with 4 components representing a color in UUSLColor — вектор с плавающей запятой с 4 компонентами, представляющий цвет в UUSL
Mask24 / Mask32 — an integer representing the mask in UUSLMask24/Mask32 — целое число, представляющее маску в UUSL
UV — a float vector of 4 components representing a UV transformation UV — вектор с плавающей запятой из 4 компонентов, представляющих UV-преобразование
Slider — a float variable with the default range of [0, 1]Слайдер — переменная с плавающей запятой с диапазоном по умолчанию [0, 1]

ULON	Что используется для инициализации в ULON?	UUSL
Float	float valueплавающее значение	float
Float2	array of 2 float valuesмассив из 2 значений с плавающей запятой	float2
Float3	array of 3 float valuesмассив из 3 значений с плавающей запятой	float3
Float4	array of 4 float valuesмассив из 4 значений с плавающей запятой	float4
ArrayFloat	float valueплавающее значение	float[N]
ArrayFloat2	array of arrays of 2 float valuesмассив массивов из 2 значений с плавающей запятой	float2[N]
ArrayFloat4	array of arrays of 4 float valuesмассив массивов из 4 значений с плавающей запятой	float4[N]
Color	array of 4 float valuesмассив из 4 значений с плавающей запятой	float4
UV	array of 4 float valuesмассив из 4 значений с плавающей запятой	float4

Usage Examples
Примеры использования#

For instance, the following example parameters are defined using the expression:Например, следующие параметры примера определяются с помощью выражения:

ULON

Float float_example = 1  
Int int_example = 1
ArrayFloat array_example = [1 2 3 4 5] <size=5>
ArrayFloat2 array_float2_example = [1 2 3 4 5 6] <size=3>
Float4 float4_example = [1 2 3 4]
Color color_example = [1 1 1 1]
UV uv_example = [1 1 0 0]
Mask24 mask24_example = 1

They are accessible in the shaders with the specified prefix:Они доступны в шейдерах с указанным префиксом:

UUSL

float a = var_float_example;
int b = var_int_example;
float c = var_array_example[0];
float d = array_float2_example [0][1];
float4 e = var_float4_example;
float4 f = var_color_example;
float4 g = var_uv_example;
int h = var_mask24_example;

Arguments
Arguments#

name
name#

String

The name of the parameter.Имя параметра.

shader_name
shader_name#

String

Uniform name in the shader. If specified the provided uniform name is used, otherwise default naming logic is used.Единое имя в шейдере. Если указано, используется предоставленное универсальное имя, в противном случае используется логика именования по умолчанию.

min
min#

Float

The minimum limit for a parameter range (not applicable for Color and Array types).Минимальный предел диапазона параметров (не применимо для типов Color и Array).

Default values:Значения по умолчанию:

0.0 — for the Slider parameter0.0 — для параметра Slider
-inf — for all the others parameters-inf — для всех остальных параметров

max
max#

Float

The maximum limit for a parameter range (not applicable for Color and Array types).Максимальный предел диапазона параметров (не применимо для типов Color и Array).

Default values:Значения по умолчанию:

1.0 — for the Slider parameter1.0 — для параметра Slider
+inf — for all the others parameters+inf — для всех остальных параметров

title
title#

String

The parameter group title that will be displayed in the Editor.Название группы параметров, которое будет отображаться в редакторе.

tooltip
tooltip#

String

The tooltip text displayed in the Editor on cursor hover over the parameter field.Текст всплывающей подсказки отображается в Редакторе при наведении курсора на поле параметра.

widget
widget#

String

The type of widget used for the parameter in the Editor.Тип виджета, используемый для параметра в редакторе.

If the type of widget is not specified, the most appropriate will be used (box fields for vector components or a slider). For the following types of parameters these widgets are set as defaults:Если тип виджета не указан, будет использоваться наиболее подходящий (поля для векторных компонентов или ползунок). Для следующих типов параметров эти виджеты установлены по умолчанию:

Тип параметра	Виджет
Mask24	mask24
UV	uv
Color	сolor
Slider	slider

min_expand
min_expand#

Boolean

A flag that enables the ability to specify values outside the minimum range limit.Флаг, позволяющий задавать значения, выходящие за пределы минимального диапазона.

Available values:Доступные значения:

false — fix the minimum range limitfalse — исправить ограничение минимального диапазона
true — expand the minimum range limittrue — расширить минимальный предел диапазона

Default values:Значения по умолчанию:

false — for the Slider parameterfalse — для параметра Slider
true — for all the others parameterstrue — для всех остальных параметров

max_expand
max_expand#

Boolean

A flag that enables the ability to specify values outside the maximum range limit.Флаг, позволяющий задавать значения за пределами максимального диапазона.

Available values:Доступные значения:

false — fix the maximum range limitfalse — исправить максимальное ограничение диапазона
true — expand the maximum range limittrue — расширить максимальный предел диапазона

Default values:Значения по умолчанию:

false — for the Slider parameterfalse — для параметра Slider
true — for all the others parameterstrue — для всех остальных параметров

expand
expand#

Boolean

A flag that enables the ability to specify values outside the minimum and maximum range limit.Флаг, который позволяет задавать значения за пределами минимального и максимального диапазона.

Available values:Доступные значения:

false — fix the range limitfalse — исправить ограничение диапазона
true — expand the range limittrue — расширить лимит диапазона

Default values:Значения по умолчанию:

false — for the Slider parameterfalse — для параметра Slider
true — for all the others parameterstrue — для всех остальных параметров

shared
shared#

Boolean

A flag that disables the passing of the parameter to shaders.Флаг, отключающий передачу параметра шейдерам.

Available values:Доступные значения:

false — do not pass the parameter to the shader as a variablefalse — не передавать параметр шейдеру как переменную
true — pass the parameter to the shader as a variable (by default)true — передать параметр шейдеру как переменную ( по умолчанию )

internal
internal#

Boolean

A flag that hides the parameter in the Editor and its values are not saved for the inherited materials.Флаг, который скрывает параметр в Редакторе и его значения не сохраняются для унаследованных материалов.

false — do not hide the parameter and save its values for the inherited materials (by default)false — не скрывать параметр и сохранять его значения для унаследованных материалов ( по умолчанию )
true — hide the parameter and do not save its values for the inherited materialstrue — скрыть параметр и не сохранять его значения для унаследованных материалов

hidden
hidden#

Boolean

A flag that hides the parameter in the Editor. The default value depends on the state of the internal argument. Enabled by default, except for Slider.Флаг, скрывающий параметр в Редакторе. Значение по умолчанию зависит от состояния внутреннего аргумента. Включено по умолчанию, за исключением Slider.

false — do not hide the parameterfalse — не скрывать параметр
true — hide the parametertrue — скрыть параметр

auto_init
auto_init#

Boolean

A flag that determines whether the parameter should be automatically declared in the shader.Флаг, определяющий, должен ли параметр автоматически объявляться в шейдере.

false — auto initializedfalse — инициализируется автоматически
true — not auto initialized (by default)true — не инициализируется автоматически ( по умолчанию )

size
size#

Integer

The size of an array (applicable only to array types), the default value is 0.Размер массива (применимо только к типам массивов), значение по умолчанию — 0.

pass
pass#

String

The set of passes during which the parameter will be used. If not specified the parameter is passed to all passes by default.Набор проходов, в течение которых будет использоваться параметр. Если не указано, параметр по умолчанию передается во все проходы.

Available values:Доступные значения:

custom_pass_name — name of a custom rendering pass (up to 32 custom passes are supported)custom_pass_name — имя пользовательского прохода рендеринга (поддерживается до 32 пользовательских проходов)
wireframe — the wireframe passwireframe — wireframe проход
visualizer_solid — the visualizer solid passvisualizer_solid — visualizer solid проход
lightmap_data - the lightmap baking passlightmap_data - проход для запекания карт освещения
deferred — the deferred passdeferred - отложенный проход
auxiliary — the auxiliary passauxiliary - вспомогательный проход
emission — the emission passemission - эмиссионный проход
refraction — the refraction passrefraction — рефракционный проход
transparent_blur — the transparent blur passtransparent_blur — проход transparent blur
ambient — the ambient passambient — проход ambient
light_voxel_probe — the Voxel Probe light passlight_voxel_probe — проход источников света Voxel Probe
light_environment_probe — the Environment Probe passlight_environment_probe — проход источников света Environment Probe
light_planar_probe — the Planar Probe pass light_planar_probe — проход источников света Planar Probe
light_omni — the Omni Light passlight_omni — проход Omni Light
light_proj — the Proj Light passlight_proj — проход Proj Light
light_world — the World Light passlight_world — проход World Light
depth_pre_pass — the native depth pre-passdepth_pre_pass — нативный предварительный проход глубины
ms_depth - the SRAA passms_depth - проход SRAA
shadow — the shadows passshadow - проход теней
post — the post-process passpost - проход постобработки
procedural_decals - the procedural decal passprocedural_decals - проход процедурных декалей
procedural_fields - the procedural field passprocedural_fields - проход процедурных полей
light_all — the Voxel Probe, Environment Probe, Planar Probe, Omni Light, Projected Light, World Light passes light_all — проходы Voxel Probe, Environment Probe, Planar Probe, Omni Light, Projected Light, World Light
forward — the Voxel Probe, Environment Probe, Planar Probe, Omni Light, Projected Light, World Light and ambient passes forward — проходы Voxel Probe, Environment Probe, Planar Probe, Omni Light, Projected Light, World Light и ambient
transparent — the forward, refraction, transparent blur passes transparent — forward, refraction, transparent blur проходы
object — deferred, auxiliary, emission, refraction, transparent blur, ambient, Voxel Probe, Environment Probe, Planar Probe, Omni Light, Projected Light, World Light, shadow and native depth passes object — deferred, auxiliary, emission, refraction, transparent blur, ambient, Voxel Probe, Environment Probe, Planar Probe, Omni Light, Projected Light, World Light, shadow и native depth проходы

expression
expression#

Boolean

A flag indicating if the parameter is controlled via an expression (UnigineScript). It also enables the ability to specify an expression in the Editor.Флаг, указывающий, управляется ли параметр через выражение (UnigineScript). Это также позволяет указать выражение в редакторе.

Available values:Доступные значения:

false — requires the user to assign specific values to the parameter (by default)false — требует, чтобы пользователь присвоил параметру определенные значения ( по умолчанию )
true — use expression to calculate the parameter's valuestrue — использовать выражение для вычисления значений параметра

Последнее обновление: 16.08.2024

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

Параметры

Разделы:

Types of ParametersТипы параметров#

Usage ExamplesПримеры использования#

ArgumentsArguments#

namename#

shader_nameshader_name#

minmin#

maxmax#

titletitle#

tooltiptooltip#

widgetwidget#

min_expandmin_expand#

max_expandmax_expand#

expandexpand#

sharedshared#

internalinternal#

hiddenhidden#

auto_initauto_init#

sizesize#

passpass#

expressionexpression#

Types of Parameters
Типы параметров#

Usage Examples
Примеры использования#

Arguments
Arguments#

name
name#

shader_name
shader_name#

min
min#

max
max#

title
title#

tooltip
tooltip#

widget
widget#

min_expand
min_expand#

max_expand
max_expand#

expand
expand#

shared
shared#

internal
internal#

hidden
hidden#

auto_init
auto_init#

size
size#

pass
pass#

expression
expression#