Skip to content

Image

Image#

(Image)

  • Default object name: image
  • Inherits from: ProjectItem

Go to User page.

Description#

The layered image manages layers that can be composited.

Public Attributes#

Type Name Visual Hint Description
long resolution_mode VISUAL_HINT_DEFAULT Defines the canvas size of the image.
string resolution_preset VISUAL_HINT_ENUM Defines the canvas size of the image.
long[2] resolution VISUAL_HINT_PIXEL Defines the canvas size of the image. The canvas is the visible area of the image.
long resolution_multiplier VISUAL_HINT_DEFAULT Defines the pixel size of the image. By default the resolution multiplier is set to 50%. Modify this value if you want to reduce or enlarge the image size freely without the need to modify Kernel Filters pixel sizes. This is really useful if you want to set Kernel Filters sizes such as Gaussian Blur, for example, on a lower image resolution to speed up rendering.
double display_ratio VISUAL_HINT_DEFAULT Stretches the image in the Image View.
bool enable_limited_region VISUAL_HINT_DEFAULT If set, only the part of the image defined by the region below will be rendered.
double[4] limited_region VISUAL_HINT_PERCENTAGE Region of interest to be rendered: x, y, width, height in percentages of the image visible window size.
long margin_mode VISUAL_HINT_DEFAULT Set the mode to use to determine the size of the overscan.
long[4] margin_pixel VISUAL_HINT_PIXEL Set the overscan for the current layer: Left, Top, Right, Bottom
double[4] margin_ratio VISUAL_HINT_PERCENTAGE Set the overscan for the current layer: Left, Top, Right, Bottom
double sampling_quality VISUAL_HINT_PERCENTAGE Increase or decrease the number of samples used during a render. It affects all what is using sampling: anti-aliasing, materials, lights, textures. This value doesn't change actually sampling values. Orignal sampling values are kept, it's only a multiplier that is applied during evaluation.
double shading_quality VISUAL_HINT_PERCENTAGE Increase or decrease the number of samples used during a render but only for the shading. It affects only materials, lights, textures. This value doesn't change actually sampling values. Orignal sampling values are kept, it's only a multiplier that is applied during evaluation.
object[] (Layer) layers VISUAL_HINT_DEFAULT List of the layers of the image.
bool render_to_disk VISUAL_HINT_DEFAULT If checked, the image is flagged to be rendered and saved to disk at the specified output path. Note the image supports rendering sequences. If you wish to export a still, make sure first frame and last frame have the same value.
string save_as VISUAL_HINT_FILENAME_SAVE Set the image output filename. Please note frame number is automatically appended to the filename.
long first_frame VISUAL_HINT_FRAME Set the first output render frame range. If set to 10, the rendering of the image will start at frame 10.
long last_frame VISUAL_HINT_FRAME Set the last output render frame range. If set to 20, the rendering of the image will stop at frame 20.
long frame_step VISUAL_HINT_FRAME Set the output render frame step. The frame step is simply the frame increment between two renders in the frame range defined by first and last frame.
long format VISUAL_HINT_DEFAULT Image output fileformat.
string LUT VISUAL_HINT_ENUM Select the color correction to apply to the output image.
long open_exr_output_compression_mode VISUAL_HINT_DEFAULT Set the OpenEXR output compression mode.
string metadata VISUAL_HINT_SCRIPT Declare custom metadata to write in the EXR header.

CID#

class "Image" "ProjectItem" {
    #version 0.96
    icon "../icons/object_icons/image.iconrc"
    doc "The layered image manages layers that can be composited."
    long "active_layer" {
        private yes
        dg_active no
        value -1
    }
    attribute_group "canvas" {
        long "resolution_mode" {
            doc "Defines the canvas size of the image."
            preset "Use Project Preferences" "0"
            preset "User-defined" "1"
            value 0
        }
        enum "resolution_preset" {
            doc "Defines the canvas size of the image."
            filter "resolution_preset"
            read_only yes
            value "__invalid_enum_label__"
        }
        pixel[2] "resolution" {
            doc "Defines the canvas size of the image. The canvas is the visible area of the image."
            output "image"
            animatable yes
            numeric_range yes 20 16384
            ui_range yes 20 16384
            read_only yes
            value 1280 720
        }
        long "resolution_multiplier" {
            doc "Defines the pixel size of the image. By default the resolution multiplier is set to 50%. Modify this value if you want to reduce or enlarge the image size freely without the need to modify Kernel Filters pixel sizes. This is really useful if you want to set Kernel Filters sizes such as Gaussian Blur, for example, on a lower image resolution to speed up rendering."
            output "image"
            preset "25%" "0"
            preset "50%" "1"
            preset "75%" "5"
            preset "100%" "2"
            preset "150%" "6"
            preset "200%" "3"
            preset "400%" "4"
            value 1
        }
        double "display_ratio" {
            doc "Stretches the image in the Image View."
            numeric_range yes 0.1 10
            ui_range yes 0.5 2
            read_only yes
            value 1
        }
    }
    attribute_group "region" {
        collapsed yes
        bool "enable_limited_region" {
            doc "If set, only the part of the image defined by the region below will be rendered."
            animatable yes
            value no
        }
        percentage[4] "limited_region" {
            doc "Region of interest to be rendered: x, y, width, height in percentages of the image visible window size."
            animatable yes
            read_only yes
            value 0.0 0.0 1 1
        }
    }
    attribute_group "overscan" {
        collapsed yes
        long "margin_mode" {
            doc "Set the mode to use to determine the size of the overscan."
            preset "Pixel" "0"
            preset "Ratio" "1"
            value 0
        }
        pixel[4] "margin_pixel" {
            doc "Set the overscan for the current layer: Left, Top, Right, Bottom"
            numeric_range yes 0.0 10000
            ui_range yes 0.0 10000
            value 0 0 0 0
        }
        percentage[4] "margin_ratio" {
            doc "Set the overscan for the current layer: Left, Top, Right, Bottom"
            numeric_range yes 0.0 10
            ui_range yes 0.0 10
            value 0.0 0.0 0.0 0.0
        }
    }
    attribute_group "quality" {
        collapsed yes
        percentage "sampling_quality" {
            doc "Increase or decrease the number of samples used during a render. It affects all what is using sampling: anti-aliasing, materials, lights, textures. This value doesn\'t change actually sampling values. Orignal sampling values are kept, it\'s only a multiplier that is applied during evaluation."
            output "shading"
            numeric_range yes 0.0 10
            ui_range yes 0.0 1
            value 1
        }
        percentage "shading_quality" {
            doc "Increase or decrease the number of samples used during a render but only for the shading. It affects only materials, lights, textures. This value doesn\'t change actually sampling values. Orignal sampling values are kept, it\'s only a multiplier that is applied during evaluation."
            output "shading"
            numeric_range yes 0.0 10
            ui_range yes 0.0 1
            value 1
        }
    }
    attribute_group "layers" {
        object[] "layers" {
            doc "List of the layers of the image."
            filter "Layer"
            dirtiness_pass_through yes
            value <empty>
        }
    }
    attribute_group "output" {
        collapsed yes
        bool "render_to_disk" {
            doc "If checked, the image is flagged to be rendered and saved to disk at the specified output path. Note the image supports rendering sequences. If you wish to export a still, make sure first frame and last frame have the same value."
            dg_active no
            value no
        }
        filename_save "save_as" {
            doc "Set the image output filename. Please note frame number is automatically appended to the filename."
            dg_active no
            read_only yes
            value ""
        }
        frame "first_frame" {
            doc "Set the first output render frame range. If set to 10, the rendering of the image will start at frame 10."
            dg_active no
            read_only yes
            value 1
        }
        frame "last_frame" {
            doc "Set the last output render frame range. If set to 20, the rendering of the image will stop at frame 20."
            dg_active no
            read_only yes
            value 1
        }
        frame "frame_step" {
            doc "Set the output render frame step. The frame step is simply the frame increment between two renders in the frame range defined by first and last frame."
            numeric_range yes 1 1000000
            ui_range yes 1 10
            dg_active no
            read_only yes
            value 1
        }
    }
    attribute_group "output>format" {
        collapsed yes
        long "format" {
            doc "Image output fileformat."
            dg_active no
            read_only yes
            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
        }
        enum "LUT" {
            doc "Select the color correction to apply to the output image."
            filter "color_space"
            dg_active no
            read_only yes
            value "__invalid_enum_label__"
        }
        long "open_exr_output_compression_mode" {
            doc "Set the OpenEXR output compression mode."
            dg_active no
            read_only yes
            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 "Declare custom metadata to write in the EXR header."
            filter ""
            dg_active no
            value ""
        }
    }
}