CompositorNodeDefocus(CompositorNode)

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeDefocus(CompositorNode)

Apply depth of field in 2D, using a Z depth map or mask

angle

Bokeh shape rotation offset (in [0, 1.5708], default 0.0)

Type:

float

blur_max

Blur limit, maximum CoC radius (in [0, 10000], default 0.0)

Type:

float

bokeh

(default 'CIRCLE')

  • OCTAGON Octagonal – 8 sides.

  • HEPTAGON Heptagonal – 7 sides.

  • HEXAGON Hexagonal – 6 sides.

  • PENTAGON Pentagonal – 5 sides.

  • SQUARE Square – 4 sides.

  • TRIANGLE Triangular – 3 sides.

  • CIRCLE Circular.

Type:

Literal[‘OCTAGON’, ‘HEPTAGON’, ‘HEXAGON’, ‘PENTAGON’, ‘SQUARE’, ‘TRIANGLE’, ‘CIRCLE’]

f_stop

Amount of focal blur, 128 (infinity) is perfect focus, half the value doubles the blur radius (in [0, 128], default 0.0)

Type:

float

scene

Scene from which to select the active camera (render scene if undefined)

Type:

Scene

use_zbuffer

Disable when using an image as input instead of actual z-buffer (auto enabled if node not image based, eg. time node) (default True)

Type:

bool

z_scale

Scale the Z input when not using a z-buffer, controls maximum blur designated by the color white or input value 1 (in [0, 1000], default 0.0)

Type:

float

classmethod is_registered_node_type()

True if a registered node type

Returns:

Result

Return type:

bool

classmethod input_template(index)

Input socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod output_template(index)

Output socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions