Knob reference
This includes all the knob names with their description. These can also be found in the tooltips on the knob itself.
Defocus/main tab
| Label | Name | Description |
|---|---|---|
| channels | channels | Channels that are being processed. |
| Local device | device_name | Device that is used for rendering. This can be a CPU or a GPU. It al its associated graphics API that’s being used (Metal on macOS, Vulkan on Windows/Linux and DirectX 12 for fallback rendering on Windows) |
| mode | mode | Select the render mode that will be used for rendering the defocus. 2D: render a defocus that has the size specified by the size slider. It will be the same size over the entire image. Depth: use the depth map for rendering the defocus. This will be the depth map that is specified in the depth channel knob. Camera: this will use both the depth map as the camera input to render the defocus. Most defocus settings will be specified by the camera and are not modifyable on this node. This is optically accurate according to the camera. This includes the f-stop, focal length, filmback width and height and focal distance. |
| render | render | Rendering mode to use. By default it renders the result, but there are also utility render modes available. Focal plane preview: render an overlay that show the depth channel focus areas. Red means in foreground, green means in focus, blue means in background. |
| show image | show_image | When using focal plane preview, also show the image together with the focal plane, or only render the focal plane preview. When this knob is false, true values are shown that specify the size (in px) used for defocussing. |
| depth channel | depth_channel | Specify which channel to use for fetching the depth channel information. Only available when camera or depth is selected in mode, and the input image is non-deep. |
| math | math | Math that is used in the depth channel. This depends on the render engine that rendered the depth channel. 1/z: compatible with depth maps rendered by Nuke and RenderMan. This depth map is a value between 0 and 1, and can be converted into a real depth map by applying the expression 1/z. real: value in depth map is the real world unit from the camera. This can be in cm, meters, inches, etc. direct: the depth map provides the defocus size. A pixel with a value of 20 would mean that the defocus should be rendered with a size of 20px. This knob is only available in non-deep, as deep is always in real values. |
| world unit | world_unit | World unit the depth map is rendered in. This can be cm, meters, inches, feet etc. |
| quality | quality | Quality mode to set the defocus quality for local rendering. A higher quality means a defocus that is at a higher quality. With the cost of more computational power required to calculate the defocus. - Low: fast rendering, dots visible in bokeh’s. Ideal during compositing workflow and quick iterations. - Medium: medium performance with little dots visible. Can serve as final results with some post-processing. - High: slower rendering but with perfect results. Recommended for rendering on the farm. - Custom: specify the samples yourself. The higher the samples, the better the result. |
| farm quality | farm_quality | Quality mode to set the defocus quality for rendering in a headless environment (the render-farm). A higher quality means a defocus that is at a higher quality. With the cost of more computational power required to calculate the defocus. - Low: fast rendering, dots visible in bokeh’s. Ideal during compositing workflow and quick iterations. - Medium: medium performance with little dots visible. Can serve as final results with some post-processing. - High: slower rendering but with perfect results. Recommended for rendering on the farm. - Custom: specify the samples yourself. The higher the samples, the better the result.This uses the $GUI detection to set the high quality. |
| samples | samples | integer value to specify how many values are used for calculating the defocus. The higher the value, the higher the quality, but costing more computational power. For a higher defocus size, it is recommended to increase the quality as well. Samples define how many sampling points are gathered for calculating the defocus. This is similar to how in other nodes sampling can be used to increase quality. |
| deep slices | deep_slices | Specify how many slices are created when rendering deep. It defines in how many slices the image is sliced in depth value. Usually 1 is enough, but if there are artifacts it can help to increase this value. |
| focal plane (C) | focal_plane | Specify the focal point that is rendered in focus. This is the same as adjusting the lens on the camera to get something in focus. The value corresponds to the value in the depth map. |
| override by focal | use_camera_focal | Use the focal plane set by the camera node instead of the one set on this node. |
| focus point | focus_point | Utility tool to sample the focus point from the depth channel and set the value in the focus plane knob. Note: don’t animate this value, as this is only a utility to sample. If you want animation on focus, set a keyframe on the focal plane instead. |
| protect | protect | Apply a safe-range for focus. This value can help to protect edges from dissolving too much with the background. |
| size | size | Specify the size used for defocussing in pixels. For example a value of 20 will result in a defocus with the size of 20 pixels. |
| max size | max_size | Only available when the mode is not 2D. This is a clamping value of the size. The defocus will not be bigger than this value. Important: set this value to a true expected or wished max size, as the sampling pattern is based on this max size. Having a disproportinate max size will result in heavy artifacts. |
| --- |
Bokeh tab
| Label | Name | Description |
|---|---|---|
| preview filter | preview_filter |
Render the bokeh only, useful for quick creation of the bokeh itself. Disable this knob to render the defocus result. |
| filter type | filter_type |
Select the filter shape type. Circle: Creates a perfect circular shape. Bladed: Creates a bladed shape, specified by the amount of blades. Image: Use your own bokeh kernel provided by the filter input. This will be automatically selected when the filter input is used. When image is selected, none of the bokeh knobs will be available as everything is controlled by the image. |
| bokeh resolution | bokeh_resolution |
Resolution to render the bokeh in. This is in both width and height. |
| ring color | ring_color |
Intensity of ring. 1 is entirely visible, 0.5 is half visible, 0 is no ring. |
| inner color | inner_color |
Intensity of inner color. 1 is entirely visible, 0.5 is half visible, 0 is no inner color. |
| ring size | ring_size |
Size of ring, increase to get a larger ring. |
| outer blur | outer_blur |
Blur outwards of the bokeh. |
| inner blur | inner_blur |
Blur inwards of the bokeh. |
| blades | blades |
Amount of blades, this is used to reproduce the f-stop blades of the lens. |
| angle | angle |
Rotate the bokeh in degrees. |
| curvature | curvature |
Define the amount of curvature of the lens. 1 is entirely circular, 0 is sharp corners depending on the amount of blades. |
| noise size | noise_size |
Scaling factor of bokeh noise. |
| noise intensity | noise_intensity |
Intensity multiplier of the bokeh noise. |
| noise seed | noise_seed |
Random seed to generate noise. Each integer has a completely different result. |
| aspect ratio | aspect_ratio |
Aspect ratio of the bokeh. A lower aspect ratio will result in an anamorphic bokeh. |
Non uniform tab
| Label | Name | Description |
|---|---|---|
| enable catsye | catseye_enable |
Enable the catseye optical effect. This causes the bokeh to appear as a cat eye more towards the edge of the image. This is caused by light being blocked by the lens opening. As this is not blocked in the center, but mostly at sharp edges to the lens, it happens at the edges of the image. |
| amount | catseye_amount |
Control the intensity of the catseye effect. 0 is no effect, 1 is an intense effect. |
| inverse | catseye_inverse |
Inverse the catseye effect. This will change the orientation of the bokeh cut to be in the opposite direction. |
| inverse foreground | catseye_inverse_foreground |
Inverse the catseye effect when it is being applied in the foreground. This is optically accurate due to the way light rays diverge (for background) or converge (for foreground) as they pass through the lens. |
| gamma | catseye_gamma |
Control the falloff of the effect. A lower gamma will make the falloff of the effect cause it to be less visible in the center. The other way around is the effect visible on most of the image. |
| softness | catseye_softness |
Make the cutoff of the bokeh appear softer. A softness of 1 will result in a smooth cutoff of the bokeh. |
| dimension based | catseye_dimension_based |
When this setting is enabled, it will determine the amount of catseye to apply based on the percentage of the screen width or |
| height, and not the absolute distance compared to the largest side. | ||
| enable barndoors | barndoors_enable |
Enable the barndoor optical effect. This causes the bokeh to be cut depending on the position of the bokeh. This is caused by light being blocked by a barndoor/flag that has been attached to the lens. |
| amount | barndoors_amount |
Total amount of barndoors to apply. 0 will be no effect, 1 will be the max effect. |
| inverse | barndoors_inverse |
Inverse the effect of the barndoor cropping. The cropping will happen in the opposite direction. |
| inverse foreground | barndoors_inverse_foreground |
Inverse the effect of the barndoor cropping when it is being applied in the foreground. This is optically accurate due to the way light rays diverge (for background) or converge (for foreground) as they pass through the lens. |
| gamma | barndoors_gamma |
Control the falloff of the effect. A lower gamma will make the falloff of the effect cause it to be less visible in the center. The other way around is the effect visible on most of the image. |
| top | barndoors_top |
Amount multiplier to the total amount in the top direction. 0 will mean that there will be no cropping in the top direction. 50 will mean that it will be half applied. 100 will mean it is completely applied. |
| bottom | barndoors_bottom |
Amount multiplier to the total amount in the bottom direction. 0 will mean that there will be no cropping in the bottom direction. 50 will mean that it will be half applied. 100 will mean it is completely applied. |
| left | barndoors_left |
Amount multiplier to the total amount in the left direction. 0 will mean that there will be no cropping in the left direction. 50 will mean that it will be half applied. 100 will mean it is completely applied. |
| right | barndoors_right |
Amount multiplier to the total amount in the right direction. 0 will mean that there will be no cropping in the right direction. 50 will mean that it will be half applied. 100 will mean it is completely applied. |
| enable astigmatism | astigmatism_enable |
Enable the astigmatism optical effect. This causes the bokeh to appear stretched in the edges of the image. It is caused by light rays from different parts of the image that don't focus at the same distance along the lens's center line. |
| amount | astigmatism_amount |
Control the amount of astigmatism. 0 means no astigmatism, 1 will result in the max effect. |
| gamma | astigmatism_gamma |
Control the falloff of the effect. A lower gamma will make the falloff of the effect cause it to be less visible in the center. The other way around is the effect visible on most of the image. |
| enable axial aberration | axial_aberration_enable |
Enable the axial aberration effect. This results in chromatic aberration depending on the depth of the image. This is caused by different light frequencies having a different rate of entering the lens. When using this effect, it is recommended to increase the quality setting of the defocus to at least medium or high. |
| amount | axial_aberration_amount |
Control the amount of axial aberration. 0 means no axial aberration, 1 will result in the max effect. |
| type | axial_aberration_type |
Set the type of axial aberration. This controls the color combination that appears when having chromatic aberration. |
| inverse bokeh shape in foreground | inverse_foreground_bokeh_shape |
Inverse the effect of the barndoor cropping when it is being applied in the foreground. This is optically accurate due to the way light rays diverge (for background) or converge (for |
| foreground) as they pass through the lens. |
Advanced tab
| Label | Name | Description |
|---|---|---|
| size multiplier | size_multiplier |
Multiply the overall size of the defocus by this factor. It multiplies both the size and max size. This means a value of 2 will double the size. |
| focal plane offset | focal_plane_offset |
Offset the focal plane focus point by this value. Works for both camera focal point as focal point knob on this node. |
License tab
| Label | Name | Description |
|---|---|---|
| licensed until | licensed_until |
Shows the date until when this license is valid. |
| open license manager | open_license_manager |
Opens a dialog to install a licensee key on this system. Disabled if VINKVFXLS env is set. |
| open documentation | open_documentation |
Opens the documentation hosted on https://docs.magicdefocus.com/ in the web browser on this system. |