Postprocess

class Postprocess

property id

The id of the postprocess.

Type

str, read-only

property name

The name of the postprocess.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property group

The group of the postprocess.

Type

PostprocessGroup

Raises

ReadOnlyError -- If Database is in read only mode.

property apply_to_background

Whether the postprocess is applied to the background.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property apply_to_overlays

Whether the postprocess is applied to overlays.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

list_effects()

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

Returns

The list of effects in the postprocess.

Return type

list(PostprocessingEffect)

duplicate()

Duplicate this postprocess.

Returns

The duplicated postprocess.

Return type

Postprocess

Raises

ReadOnlyError -- If Database is in read only mode.

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

• InUseError -- If force is False and the postprocess is used.

• ReadOnlyError -- If Database is in read only mode.

create_blur_postprocessing()

Create a new blur postprocessing effect.

Returns

The newly created postprocessing effect.

Return type

PostprocessingEffectBlur

Raises

ReadOnlyError -- If Database is in read only mode.

create_bloom_postprocessing()

Create a new bloom postprocessing effect.

Returns

The newly created postprocessing effect.

Return type

PostprocessingEffectBloom

Raises

ReadOnlyError -- If Database is in read only mode.