Skip to content

bool

Boolean parameter

This will show a Yes/No input UI in the effect properties.

Shader Equivalent

uniform bool parameter_name;

Example

{
  "type": "bool",
  "name": "my_bool",
  "default": true,
  "label": "A boolean"
}

Properties

Property
Type Required If absent Description
default boolean Yes - -
name string Yes - Name of the field. It must be the same as the associated variable in the shader.
type "bool" 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.