This page has been translated automatically.
Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World Nodes
Звуковые объекты
Объекты поиска пути
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
Унифицированный язык шейдеров UUSL
Плагины
Rebuilding the Engine Tools
GUI
Двойная точность координат
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Art Samples
Tutorials

Parameters

The material parameter that is available in the shader as a variable. Use the type of the ULON node for the parameter type.

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 UUSL
  • Int / Int2 / Int3 / Int4 — an integer (int) vector of N components in UUSL
  • ArrayFloat / ArrayFloat2 / ArrayFloat4 — an array of float vectors with N components in UUSL
  • ArrayInt / ArrayInt2 / ArrayInt4 — an array of integer (int) vectors with N components in UUSL
  • Color — a float vector with 4 components representing a color in UUSL
  • Mask24 / Mask32 — an integer representing the mask in UUSL
  • UV — a float vector of 4 components representing a UV transformation
  • Slider — a float variable with the default range of [0, 1]
ULON What to use for initialization in ULON? UUSL
Float float value float
Float2 array of 2 float values float2
Float3 array of 3 float values float3
Float4 array of 4 float values float4
ArrayFloat float value float[N]
ArrayFloat2 array of arrays of 2 float values float2[N]
ArrayFloat4 array of arrays of 4 float values float4[N]
Color array of 4 float values float4
UV array of 4 float values 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] [4 5] ] <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

Their 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#

name#

String

The name of the parameter.

min#

Float

The minimum limit for a parameter range (not applicable for Color and Array types).

Default values:

  • 0.0 — for the Slider parameter
  • -inf — for all the others parameters

max#

Float

The maximum limit for a parameter range (not applicable for Color and Array types).

Default values:

  • 1.0 — for the Slider parameter
  • +inf — for all the others parameters

title#

String

The parameter group title that will be displayed in the Editor.

tooltip#

String

The tooltip text displayed in the Editor on cursor hover over the parameter field.

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:

Parameter type Widget
Mask24 mask24
UV uv
Color сolor
Slider slider

min_expand#

Boolean

A flag that enables the ability to specify values outside the minimum range limit.

Available values:

  • false — fix the minimum range limit
  • true — expand the minimum range limit

Default values:

  • false — for the Slider parameter
  • true — for all the others parameters

max_expand#

Boolean

A flag that enables the ability to specify values outside the maximum range limit.

Available values:

  • false — fix the maximum range limit
  • true — expand the maximum range limit

Default values:

  • false — for the Slider parameter
  • true — for all the others parameters

expand#

Boolean

A flag that enables the ability to specify values outside the minimum and maximum range limit.

Available values:

  • false — fix the range limit
  • true — expand the range limit

Default values:

  • false — for the Slider parameter
  • true — for all the others parameters

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 variable
  • true — pass the parameter to the shader as a variable (by default)

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)
  • true — hide the parameter and do not save its values for the inherited materials

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.

  • false — do not hide the parameter
  • true — hide the parameter

auto_init#

Boolean

A flag that determines whether the parameter should be automatically declared in the shader.

  • false — auto initialized
  • true — not auto initialized (by default)

size#

Integer

The size of an array (applicable only to array types), the default value is 0.

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:

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.

Available values:

  • false — requires the user to assign specific values to the parameter (by default)
  • true — use expression to calculate the parameter’s values
Last update: 24.08.2021
Build: ()