CompositorNodeOutputFile(CompositorNode)

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeOutputFile(CompositorNode)

Write image file to disk

active_item_index

Index of the active item (in [0, inf], default 0)

Type:

int

directory

The directory where the image will be written (default “”, never None, blend relative // prefix supported, Supports template expressions)

Type:

str

file_name

The base name of the file. Other information might be included in the final file name depending on the node options (default “”, never None, Supports template expressions)

Type:

str

file_output_items

(default None, readonly)

Type:

NodeCompositorFileOutputItems[NodeCompositorFileOutputItem]

format

(readonly)

Type:

ImageFormatSettings

save_as_render

Apply render part of display transform when saving byte image (default False)

Type:

bool

use_file_extension

Add the file format extensions to the saved file name (eg: filename + .jpg) (default False)

Type:

bool

classmethod is_registered_node_type()

True if a registered node type

Returns:

Result

Return type:

bool

classmethod input_template(index)

Input socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod output_template(index)

Output socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions