Postprocess

class Postprocess

property id

The id of the postprocess.

property name

The name of the postprocess.

property group

The group of the postprocess.

property apply_to_background

Whether the postprocess is applied to the background.

property apply_to_overlays

Whether the postprocess is applied to overlays.

list_effects()

List the postprocessing effects of this postprocess, in top to bottom order.

duplicate()

Duplicate this postprocess.

export_kfx(filename)

Export the postprocess to a KFX file.

Parameters: filename (str) -- KFX filename.
Raises: FileNotFoundError -- If the destination directory does not exist.

remove(force=False)

Delete this postprocess

Note

By default, only not used postprocess can be deleted (InUseError is raised otherwise), use force to force deletion of used postprocesses.

Parameters

force (bool) -- Force the deletion of the postprocess even if it is in use.

Raises

create_blur_postprocessing()

Create a new blur postprocessing effect.

create_bloom_postprocessing()

Create a new bloom postprocessing effect.

create_sharpen_postprocessing()

Create a new sharpen postprocessing effect.

create_add_multiply_postprocessing()

Create a new add/multiply postprocessing effect.