1. Home
  2. Actions.Effect.StyleTransfer

new StyleTransfer( imageSource )

Description
  • This Action, while belonging to Effect, acts as a modified overlay. The class implements the Builder pattern, where strength() and preserveColor() are applied to the instance, and toString() is responsible to combining them into the right result.
Parameters
Name Type Description
imageSource ImageSource
Details

SDK.Action

actions/effect/styleTransfer.ts, line 13

Visit Effect for an example

Methods

getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns
Details

SDK.Action#getActionTag

SDK.Action#getActionTag

internal/Action.ts, line 27

strength( [ effectStrength ] ) → {this}

Description

Determines the strength in which the styleTransfer is applied.

Parameters
Name Type Attributes Default Description
effectStrength number <optional>

The strength level, 1-100, default: 100
Returns
Details

actions/effect/styleTransfer.ts, line 30

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns
Details

SDK.Action#setActionTag

SDK.Action#setActionTag

internal/Action.ts, line 34

preserveColor( bool ) → {this}

Description

More aggressively preserves the colors of the the target photo, Can be used with strength() to enhance this behaviour

Parameters
Name Type Default Description
bool boolean true
Returns
Details

actions/effect/styleTransfer.ts, line 40

toString() → {string}

Description

The build phase of the Action, used internally to concat all the options received into a single string. The result of this method is the toString() of the imageLayer provided in the constructor.

Returns
Details

SDK.Action#toString

actions/effect/styleTransfer.ts, line 49

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns
Details

SDK.Action#addQualifier

SDK.Action#addQualifier

internal/Action.ts, line 51

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details

SDK.Action#addFlag

SDK.Action#addFlag

internal/Action.ts, line 75