ComfyUI Node Documentation: sdBxb_saveImage

Overview

The sdBxb_saveImage node is a custom node designed for the ComfyUI workflow within the ComfyUI_Bxb plugin. This node serves to effectively save images generated or processed in the UI workflow. Notably, it is specifically crafted to exclude workflow information from being saved with the images, enhancing privacy and streamlining image management.

1. Node Functionality

The primary function of the sdBxb_saveImage node is to save images to a designated output directory. It ensures that images are saved without accompanying metadata, such as workflow information, which is a deviation from the default image-saving behavior in ComfyUI. This attribute can be particularly useful when the images are meant for external sharing or usage without revealing workflow specifics.

2. Input Specifications

The sdBxb_saveImage node expects the following inputs:

• images: This mandatory input receives a batch of images that need to be saved. The images are expected to be in a format compatible with ComfyUI's internal data handling (typically tensor-based).

• filename_prefix: This optional input allows the user to specify a prefix for the filenames of the saved images. The default prefix is set to "ComfyUI". The prefix can be customized to help identify or categorize images easily.

3. Output Specifications

The sdBxb_saveImage node does not produce direct outputs in the form of data that can be used downstream in a workflow. Instead, its primary output is the saved image files, which are stored in the specified directory on the user's filesystem.

4. Usage in ComfyUI Workflows

The sdBxb_saveImage node can be integrated into ComfyUI workflows where there is a need to save image outputs without saving extra workflow information. This makes it particularly beneficial for workflows where the end result (the image) is more critical than the process used to generate it.

In typical use cases, this node would be added towards the end of the workflow pipeline, after all desired image processing or generation. The node captures the processed images, assigns them a filename according to the given prefix, and places them in an output directory designated by the ComfyUI system.

5. Special Features and Considerations

Special Features

• Metadata-Free Saving: The sdBxb_saveImage does not save additional workflow metadata with the images, which is the distinct advantage over ComfyUI's default behavior.

• Customizable Filename Prefix: Ability to set a custom filename prefix aids in organizing and categorizing saved images efficiently.

• Batch Processing: Capable of handling batches of images, saving each one individually with an auto-incremented filename.

Considerations

• Directory Management: Users should ensure that the specified output directory has adequate permissions and space for saving images.

• Image Format: The node saves images in PNG format which may result in larger file sizes compared to JPEG. Consider using post-processing tools or scripts if file size is a concern.

• Workflow Compatibility: This node is specifically built for ComfyUI_Bxb, and utilizing it outside of this environment may require additional integration.

This documentation aims to aid users in understanding and effectively utilizing the sdBxb_saveImage node within their ComfyUI workflows. For installation and further instructions, users are encouraged to consult the ComfyUI_Bxb repository and support resources.