int
Integer parameter
The int type represents an integer parameter that can be exposed in the user interface.
It allows for configuring numeric inputs with options like sliders and value constraints.
Shader Equivalent
Example
{
"type": "int",
"name": "my_int_value",
"label": "My int",
"slider": true,
"min": 0,
"max": 100,
"default": 50,
"step": 1
}
Properties
Property |
Type | Required | If absent | Description |
|---|---|---|---|---|
default |
number | Yes | - | - |
name |
string | Yes | - | Name of the field. It must be the same as the associated variable in the shader. |
type |
"int" |
Yes | - | - |
description |
string | No | - | Description of the field. It will be shown in the UI. |
devmode |
boolean | No | false |
If set to true, this field will only be available in the property UI if the developer mode is active. |
label |
string | No | "Same as name" |
The label of the field in the UI. If not set, the name will be used. |
max |
number | No | - | Maximum value of the parameter. If not set, 100 will be used |
min |
number | No | - | Minimum value of the parameter. If not set, 0.0 will be used |
slider |
boolean | No | false |
Show a slider in the UI |
step |
number | No | 1 |
Smaller step allowed. If not set, 1 will be used |