Skip to content

Class: effector_params ​

Mutable post-process state passed to effectors.

Source ​

C++ class effector_params

Custom Constructor ​

effector_params

Remarks ​

Defaults match the neutral post-process state: no blur, gray, duality, or noise intensity.

Extends ​

Constructors ​

Constructor ​

ts
new effector_params(): effector_params;

Create default post-process parameters.

Returns ​

effector_params

Overrides ​

EngineBinding.constructor

Methods ​

assign() ​

ts
assign(params: effector_params): void;

Copy all post-process values from another params object.

Parameters ​

ParameterTypeDescription
paramseffector_paramsSource values.

Returns ​

void

Remarks ​

Copies the current values. Later changes to params are not linked back to this object.

Properties ​

__name ​

ts
readonly __name: string;

LuaBind instance constructor name.

Inherited from ​

EngineBinding.__name


blur ​

ts
blur: number;

Blur amount.


color_add ​

ts
color_add: color;

Additive color applied over the frame.


color_base ​

ts
color_base: color;

Base color tint.


color_gray ​

ts
color_gray: color;

Grayscale color tint.


dual ​

ts
dual: duality;

Double-vision settings.


gray ​

ts
gray: number;

Grayscale amount.


noise ​

ts
noise: noise;

Noise settings.


__name ​

ts
readonly static __name: string;

LuaBind class constructor name.

Inherited from ​

EngineBinding.__name