Skip to content

ImageNodeMerge

ImageNodeMerge#

(Merge)

Go to User page.

Description#

Merge two images.

Public Attributes#

Type Name Visual Hint Description
reference (ImageNode) b VISUAL_HINT_DEFAULT Define the B image. By default, B is the background.
reference (ImageNode) a VISUAL_HINT_DEFAULT Define the A image. By default, A is the foreground. Note that you can stack multiple A inputs.
reference (ImageNodeMask) mask VISUAL_HINT_DEFAULT Specify a mask on which the operation is performed.
string b_alpha_channel VISUAL_HINT_TAG Name of the image channel to consider as alpha for B
string a_alpha_channel VISUAL_HINT_TAG Name of the image channel to consider as alpha for A
long window VISUAL_HINT_DEFAULT Define the resulting image window in the event the image window of the inputs mismatch.
long merge_mode VISUAL_HINT_DEFAULT Define the type of merge operation performed by the node.
long alpha VISUAL_HINT_DEFAULT Specify how resulting alpha should be computed.
double mix VISUAL_HINT_DEFAULT Specify the weight of the merging operation.

Inherited Public Attributes#

Type Name Visual Hint Description
bool thumbnail VISUAL_HINT_DEFAULT Enable/Disable the display of the node thumbnail in the Build View.
double thumbnail_size VISUAL_HINT_DEFAULT Set the size of the thumbnail in the Build View.
long caching VISUAL_HINT_DEFAULT Cache result of this node
action clear_cache VISUAL_HINT_DEFAULT Clear the internal image cached by the node. If you clear the image cache, the node will request an evaluation when displayed by the Image View.
bool pass_through VISUAL_HINT_DEFAULT Enable pass through. If enabled, the node returns the input specified as Master Input.
string master_input VISUAL_HINT_TAG Define which input should be returned by the node if Pass Through is enabled.

CID#

class "ImageNodeMerge" "ImageNode" {
    #license {
        flavor "advanced"
    }
    #version 0.92
    icon "../icons/object_icons/image_node_merge.iconrc"
    category "Image"
    doc "Merge two images."
    attribute_group "input" {
        reference "b" {
            doc "Define the B image. By default, B is the background."
            filter "ImageNode"
            dirtiness_pass_through yes
            value ""
        }
        list<reference> "a" {
            doc "Define the A image. By default, A is the foreground. Note that you can stack multiple A inputs."
            filter "ImageNode"
            dirtiness_pass_through yes
            value <empty>
        }
        reference "mask" {
            doc "Specify a mask on which the operation is performed."
            filter "ImageNodeMask"
            dirtiness_pass_through yes
            value ""
        }
        tag "b_alpha_channel" {
            doc "Name of the image channel to consider as alpha for B"
            output "image"
            value "rgba.alpha"
        }
        tag "a_alpha_channel" {
            doc "Name of the image channel to consider as alpha for A"
            output "image"
            value "rgba.alpha"
        }
    }
    attribute_group "options" {
        long "window" {
            doc "Define the resulting image window in the event the image window of the inputs mismatch."
            output "image"
            preset "Keep A" "0"
            preset "Keep B" "1"
            preset "Union" "2"
            preset "Intersection" "3"
            value 2
        }
        long "merge_mode" {
            doc "Define the type of merge operation performed by the node."
            output "image"
            preset "Over" "0"
            preset "Conjoint Over" "1"
            preset "Disjoint Over" "2"
            preset "Add" "3"
            preset "Subtract" "4"
            preset "Multiply" "5"
            preset "Divide" "6"
            preset "Screen" "7"
            preset "Minimum" "8"
            preset "Maximum" "9"
            value 0
        }
        long "alpha" {
            doc "Specify how resulting alpha should be computed."
            output "image"
            preset "Merge" "0"
            preset "Keep A" "1"
            preset "Keep B" "2"
            value 0
        }
        double "mix" {
            doc "Specify the weight of the merging operation."
            output "image"
            numeric_range yes 0.0 3.402823e+38
            ui_range yes 0.0 1
            value 1
        }
    }
    attribute_group "ModuleImageNodeInput.b" {
        doc "b"
    }
    attribute_group "ModuleImageNodeInputs.a" {
        doc "a"
    }
    attribute_group "ModuleImageNodeInput.m" {
        doc "m"
    }
    attribute_group "ModuleImageNodeWindow" {
        doc "null"
    }
    attribute_group "INodeMergeOptions" {
        doc "null"
    }
}