Image#
(Image)
- Default object name:
image
Description#
The layered image manages layers that can be composited.
Attributes#
| Name | Type | Description |
|---|---|---|
| Resolution Mode | long |
Defines the canvas size of the image. |
| Resolution Preset | string |
Defines the canvas size of the image. |
| Resolution | long[2] |
Defines the canvas size of the image. The canvas is the visible area of the image. |
| Resolution Multiplier | long |
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. |
| Display Ratio | double |
Stretches the image in the Image View. |
| Enable Limited Region | bool |
If set, only the part of the image defined by the region below will be rendered. |
| Limited Region | double[4] |
Region of interest to be rendered: x, y, width, height in percentages of the image visible window size. |
| Margin Mode | long |
Set the mode to use to determine the size of the overscan. |
| Margin Pixel | long[4] |
Set the overscan for the current layer: Left, Top, Right, Bottom |
| Margin Ratio | double[4] |
Set the overscan for the current layer: Left, Top, Right, Bottom |
| Sampling Quality | double |
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. |
| Shading Quality | double |
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. |
| Layers | object[] (Layer) |
List of the layers of the image. |
| Render To Disk | bool |
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. |
| Save As | string |
Set the image output filename. Please note frame number is automatically appended to the filename. |
| First Frame | long |
Set the first output render frame range. If set to 10, the rendering of the image will start at frame 10. |
| Last Frame | long |
Set the last output render frame range. If set to 20, the rendering of the image will stop at frame 20. |
| Frame Step | long |
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. |
| Format | long |
Image output fileformat. |
| LUT | string |
Select the color correction to apply to the output image. |
| Open Exr Output Compression Mode | long |
Set the OpenEXR output compression mode. |
| Metadata | string |
Declare custom metadata to write in the EXR header. |