Skip to content

ProcessImageNodeWrite

ProcessImageNodeWrite#

(Image Node Write)

  • Category: Process
  • Default object name: image_node_write
  • Inherits from: ProjectItem > Process

Go to User page.

Description#

Process that saves to disk the input image.

Public Attributes#

Type Name Visual Hint Description
reference (ImageNode) input VISUAL_HINT_DEFAULT Image Node to write to disk.
string filename VISUAL_HINT_FILENAME_SAVE Set the output filename. Filenames are expected to be of the form .ext eg. name.####.ext (for 4 digit padding), name.#.ext (no padding). The file extension may be modified depending on the output image format specified.
string current_filename VISUAL_HINT_DEFAULT Path to current image.
long format VISUAL_HINT_DEFAULT Set the output file format.
long open_exr_output_compression_mode VISUAL_HINT_DEFAULT Set the compression mode when the image format is set to Open EXR.
string metadata VISUAL_HINT_SCRIPT Additional Metadata that is stored in the image file such as an EXR. Note that not all image format supports Metadata.
long image_buffer_ouput_mode VISUAL_HINT_DEFAULT Specify how the channels must be written in the output file.

Inherited Public Attributes#

Type Name Visual Hint Description
action run_process VISUAL_HINT_DEFAULT

CID#

class "ProcessImageNodeWrite" "Process" {
    #license {
        flavor "advanced"
    }
    #version 0.9
    icon "../icons/object_icons/process_image_node_write.iconrc"
    doc "Process that saves to disk the input image."
    attribute_group "input" {
        reference "input" {
            doc "Image Node to write to disk."
            filter "ImageNode"
            value ""
        }
    }
    attribute_group "output" {
        filename_save "filename" {
            doc "Set the output filename. Filenames are expected to be of the form <name><padding>.ext eg. name.####.ext (for 4 digit padding), name.#.ext (no padding). The file extension may be modified depending on the output image format specified."
            output "none"
            dg_active no
            value ""
        }
        string "current_filename" {
            doc "Path to current image."
            saveable no
            read_only yes
            value ""
        }
        long "format" {
            doc "Set the output file format."
            output "none"
            dg_active no
            preset "Open EXR (16bit)" "0"
            preset "Open EXR (32bit)" "1"
            preset "Jpeg" "2"
            preset "Bitmap" "3"
            preset "Targa" "4"
            preset "Png (8bit)" "5"
            preset "Png (16bit)" "6"
            preset "Tiff (8bit)" "7"
            preset "Tiff (16bit)" "8"
            preset "Tiff (32bit)" "9"
            value 0
        }
        long "open_exr_output_compression_mode" {
            doc "Set the compression mode when the image format is set to Open EXR."
            output "none"
            dg_active no
            preset "Use project preferences" "0"
            preset "No Compression" "1"
            preset "RLE Compression" "2"
            preset "ZIPS Compression" "3"
            preset "ZIP Compression" "4"
            preset "PIZ Compression" "5"
            preset "PXR24 Compression" "6"
            preset "B44 Compression" "7"
            preset "B44A Compression" "8"
            preset "DWAA Compression" "9"
            preset "DWAB Compression" "10"
            value 0
        }
        script "metadata" {
            doc "Additional Metadata that is stored in the image file such as an EXR. Note that not all image format supports Metadata."
            filter ""
            output "none"
            dg_active no
            value ""
        }
        long "image_buffer_ouput_mode" {
            doc "Specify how the channels must be written in the output file."
            preset "Single File" "0"
            preset "Multiple Files (Source Channel)" "1"
            preset "Multiple Files (RGBA Channel)" "2"
            value 0
        }
        bool "is_process_running" {
            private yes
            read_only yes
            value no
        }
    }
}