nodes.compositor.manual
manual
Attributes
| Name | Description |
|---|---|
tree |
Classes
| Name | Description |
|---|---|
| IndexSwitch | Node builder for the Index Switch node (Compositor tree). |
| MenuSwitch | Node builder for the Menu Switch node (Compositor tree) |
IndexSwitch
IndexSwitch(index=0, items=(), data_type=None)Node builder for the Index Switch node (Compositor tree).
The same node as in Geometry Nodes, with the same items API and type inference, but the compositor switches fewer types (and Integer Vector, which Geometry Nodes doesn’t). With nothing to infer from it is a Color switch, as Blender starts it in the compositor.
Attributes
| Name | Description |
|---|---|
data_type |
Input socket: Data Type |
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The switch’s items, one input socket each. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| boolean | |
| capture | Deprecated: use items.new(value, name).output. |
| color | |
| float | |
| font | |
| integer | |
| integer_vector | |
| matrix | |
| menu | |
| object | |
| rotation | |
| string | |
| vector |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
boolean
boolean(index=0, items=())capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
color
color(index=0, items=())float
float(index=0, items=())font
font(index=0, items=())integer
integer(index=0, items=())integer_vector
integer_vector(index=0, items=())matrix
matrix(index=0, items=())object
object(index=0, items=())rotation
rotation(index=0, items=())string
string(index=0, items=())vector
vector(index=0, items=())MenuSwitch
MenuSwitch(menu=None, items=None, *, data_type=None)Node builder for the Menu Switch node (Compositor tree)
Attributes
| Name | Description |
|---|---|
data_type |
Input socket: Data Type |
i |
|
items |
The menu’s items, one input socket each. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| boolean | |
| capture | Deprecated: use items.new(value, name).output. |
| color | |
| float | |
| integer | |
| is_selected | Gets the boolean output socket that is True when the named menu item is selected. |
| item | Deprecated: use items.new(value, name, description=). |
| menu | |
| string | |
| vector |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
boolean
boolean(menu=None, items=None)capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
color
color(menu=None, items=None)float
float(menu=None, items=None)integer
integer(menu=None, items=None)is_selected
is_selected(name)Gets the boolean output socket that is True when the named menu item is selected.
Cannot be used with the “Output” name as this refers to the output socket itself.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| name | str | The name of the menu item to get the selected socket for. | required |
Returns
| Name | Type | Description |
|---|---|---|
| BooleanSocket | The boolean output socket that is True when the named menu item is selected. |
item
item(name, value=None, *, description=None)Deprecated: use items.new(value, name, description=).
string
string(menu=None, items=None)vector
vector(menu=None, items=None)