PostprocessingEffect

class PostprocessingEffect

property id

The id of the postprocessing effect.

Type

str, read-only

property name

The name of the postprocessing effect.

Type

str, read-only

property postprocess

The parent postprocess.

Type

Postprocess, read-only

property description

The description of the postprocessing effect.

Type

str, read-only

property index

The index of this postprocessing effect in the postprocessing effect list.

Type

int

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

Whether the postprocessing effect is enabled.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force=False)

Delete this postprocessing effect

Note

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

Parameters

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

Raises

• InUseError -- If force is False and the postprocessing effect is used.

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

PostprocessingEffectBloom

class PostprocessingEffectBloom

Base class: PostprocessingEffect

property id

The id of the postprocessing effect.

Type

str, read-only

property name

The name of the postprocessing effect.

Type

str, read-only

property postprocess

The parent postprocess.

Type

Postprocess, read-only

property description

The description of the postprocessing effect.

Type

str, read-only

property index

The index of this postprocessing effect in the postprocessing effect list.

Type

int

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

Whether the postprocessing effect is enabled.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property threshold

The threshold for the blooom effect.

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.

property factor

The factor applied to the bloom effect.

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.

property radius

The radius of the bloom effect.

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force=False)

Delete this postprocessing effect

Note

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

Parameters

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

Raises

• InUseError -- If force is False and the postprocessing effect is used.

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

PostprocessingEffectBlur

class PostprocessingEffectBlur

Base class: PostprocessingEffect

property id

The id of the postprocessing effect.

Type

str, read-only

property name

The name of the postprocessing effect.

Type

str, read-only

property postprocess

The parent postprocess.

Type

Postprocess, read-only

property description

The description of the postprocessing effect.

Type

str, read-only

property index

The index of this postprocessing effect in the postprocessing effect list.

Type

int

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

Whether the postprocessing effect is enabled.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property radius

The radius of the blur effect.

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force=False)

Delete this postprocessing effect

Note

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

Parameters

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

Raises

• InUseError -- If force is False and the postprocessing effect is used.

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