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

Type:

int in [0, inf], default 0

directory

The directory where the image will be written

Type:

string, default “”, (never None, blend relative // prefix supported, Supports template expressions)

file_name

The base name of the file. Other information might be included in the final file name depending on the node options

Type:

string, default “”, (never None, Supports template expressions)

file_output_items
Type:

NodeCompositorFileOutputItems bpy_prop_collection of NodeCompositorFileOutputItem, (readonly)

format
Type:

ImageFormatSettings, (readonly)

save_as_render

Apply render part of display transform when saving byte image

Type:

boolean, default False

classmethod is_registered_node_type()

True if a registered node type

Returns:

Result

Return type:

boolean

classmethod input_template(index)

Input socket template

Parameters:

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

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod output_template(index)

Output socket template

Parameters:

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

Returns:

result

Return type:

NodeInternalSocketTemplate

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

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

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

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions