Documentation EffectsNative

Name	Type	Description
`value`	`Buffer` \| `string` \| `any`

# adaptiveBlur(value, sigma) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAdaptiveBlur` \| `number`
`sigma`	`number`

View Source EffectsNative.ts, line 1743

Returns:

Type: void

# adaptiveResize(value, height, x, y) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAdaptiveResize` \| `number` \| `string`
`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 1753

Returns:

Type: void

# adaptiveSharpen(value, sigma) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAdaptiveSharpen` \| `number`
`sigma`	`number`

View Source EffectsNative.ts, line 1761

Returns:

Type: void

# adaptiveSharpenChannel(value, radius, sigma) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAdaptiveSharpenChannel` \| `IChannelType`
`radius`	`number`
`sigma`	`number`

View Source EffectsNative.ts, line 1770

Returns:

Type: void

# adaptiveThreshold(value, height, bias) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAdaptiveThreshold` \| `number`
`height`	`number`
`bias`	`number`

View Source EffectsNative.ts, line 1779

Returns:

Type: void

# addAffine(sx, sy, rx, ry, tx, ty) → {void}

Parameters:

Name	Type	Description
`sx`	`number`
`sy`	`number`
`rx`	`number`
`ry`	`number`
`tx`	`number`
`ty`	`number`

View Source EffectsNative.ts, line 1791

Returns:

Type: void

# addArc(startX, startY, endX, endY, startDegrees, endDegrees) → {void}

Parameters:

Name	Type	Description
`startX`	`number`
`startY`	`number`
`endX`	`number`
`endY`	`number`
`startDegrees`	`number`
`endDegrees`	`number`

View Source EffectsNative.ts, line 1803

Returns:

Type: void

# addBorder(value, height, x, y) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAddBorder` \| `number`
`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 1813

Returns:

Type: void

# addCircle(originX, originY, perimX, perimY) → {void}

Parameters:

Name	Type	Description
`originX`	`number`
`originY`	`number`
`perimX`	`number`
`perimY`	`number`

View Source EffectsNative.ts, line 1823

Returns:

Type: void

# addFrame(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative`

View Source EffectsNative.ts, line 1830

Returns:

Type: void

# addNoise(type) → {void}

Parameters:

Name	Type	Description
`type`	`INoiseType`

View Source EffectsNative.ts, line 1837

Returns:

Type: void

# addNoiseChannel(channel, type) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`type`	`INoiseType`

View Source EffectsNative.ts, line 1845

Returns:

Type: void

# addPolygon(polygons) → {void}

Parameters:

Name	Type	Description
`polygons`	`Array.<Array.<Pos>>`

View Source EffectsNative.ts, line 1852

Returns:

Type: void

# addRoundRectangle(value, upperLeftY, lowerRightX, lowerRightY, cornerWidth, cornerHeight) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAddRoundRectangle` \| `number`
`upperLeftY`	`number`
`lowerRightX`	`number`
`lowerRightY`	`number`
`cornerWidth`	`number`
`cornerHeight`	`number`

View Source EffectsNative.ts, line 1864

Returns:

Type: void

# addSource(value, height, x, y) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAddSource.<(EffectsNative\|any)>` \| `number`
`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 1874

Returns:

Type: void

# addText(value) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAddText`

View Source EffectsNative.ts, line 1881

Returns:

Type: void

# adjoin(flag) → {void}

Parameters:

Name	Type	Description
`flag`	`boolean`

View Source EffectsNative.ts, line 1888

Returns:

Type: void

# affineTransform(value, sy, rx, ry, tx, ty) → {void}

Parameters:

Name	Type	Description
`value`	`number`
`sy`	`number`
`rx`	`number`
`ry`	`number`
`tx`	`number`
`ty`	`number`

View Source EffectsNative.ts, line 1900

Returns:

Type: void

# alpha(flag) → {void}

Parameters:

Name	Type	Description
`flag`	`boolean` \| `number`

View Source EffectsNative.ts, line 1907

Returns:

Type: void

# animationDelay(delay) → {void}

Parameters:

Name	Type	Description
`delay`	`number`

View Source EffectsNative.ts, line 1914

Returns:

Type: void

# animationIterations(iterations) → {void}

Parameters:

Name	Type	Description
`iterations`	`number`

View Source EffectsNative.ts, line 1921

Returns:

Type: void

# annotate(value, gravity) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsAnnotate` \| `string`
`gravity`	`IGravityType`

View Source EffectsNative.ts, line 1929

Returns:

Type: void

# artifact(name) → {void}

Parameters:

Name	Type	Description
`name`	`string`

View Source EffectsNative.ts, line 1936

Returns:

Type: void

# attribute(key, value) → {void}

Parameters:

Name	Type	Description
`key`	`ParamsAttribute` \| `string`
`value`	`string`

View Source EffectsNative.ts, line 1944

Returns:

Type: void

# autoGamma() → {void}

View Source EffectsNative.ts, line 1949

Returns:

Type: void

# autoGammaChannel(channel) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`

View Source EffectsNative.ts, line 1956

Returns:

Type: void

# autoLevel() → {void}

View Source EffectsNative.ts, line 1961

Returns:

Type: void

# autoLevelChannel(channel) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`

View Source EffectsNative.ts, line 1968

Returns:

Type: void

# autoOrient() → {void}

View Source EffectsNative.ts, line 1973

Returns:

Type: void

# autoThreshold(type) → {void}

Parameters:

Name	Type	Description
`type`	`IAutoThresholdMethod`

View Source EffectsNative.ts, line 1980

Returns:

Type: void

# backgroundColor(color) → {void}

Parameters:

Name	Type	Description
`color`	`string`

View Source EffectsNative.ts, line 1987

Returns:

Type: void

# backgroundTexture(name) → {void}

Parameters:

Name	Type	Description
`name`	`string`

View Source EffectsNative.ts, line 1994

Returns:

Type: void

# blackThreshold(threshold) → {void}

Parameters:

Name	Type	Description
`threshold`	`string`

View Source EffectsNative.ts, line 2001

Returns:

Type: void

# blackThresholdChannel(channel, threshold) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`threshold`	`string`

View Source EffectsNative.ts, line 2009

Returns:

Type: void

# blueShift(radius) → {void}

Parameters:

Name	Type	Description
`radius`	`number`

View Source EffectsNative.ts, line 2016

Returns:

Type: void

# blur(value, sigma) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsBlur` \| `number`
`sigma`	`number`

View Source EffectsNative.ts, line 2024

Returns:

Type: void

# blurChannel(channel, radius, sigma) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`radius`	`number`
`sigma`	`number`

View Source EffectsNative.ts, line 2033

Returns:

Type: void

# border(value, height, x, y) → {void}

Parameters:

Name	Type	Description
`value`	`number` \| `string`
`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2043

Returns:

Type: void

# borderColor(color) → {void}

Parameters:

Name	Type	Description
`color`	`string`

View Source EffectsNative.ts, line 2050

Returns:

Type: void

# boundingBox()

View Source EffectsNative.ts, line 2056

Returns:

# boxColor(color) → {void}

Parameters:

Name	Type	Description
`color`	`string`

View Source EffectsNative.ts, line 2063

Returns:

Type: void

# cannyEdge(radius, sigma, lower, upper) → {void}

Parameters:

Name	Type	Description
`radius`	`number`
`sigma`	`number`
`lower`	`number`
`upper`	`number`

View Source EffectsNative.ts, line 2073

Returns:

Type: void

# cdl(cdl) → {void}

Parameters:

Name	Type	Description
`cdl`	`string`

View Source EffectsNative.ts, line 2080

Returns:

Type: void

# channel(channel) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`

View Source EffectsNative.ts, line 2087

Returns:

Type: void

# channelDepth(channel, depth) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`depth`	`number`

View Source EffectsNative.ts, line 2095

Returns:

Type: void

# charcoal(radius, sigma) → {void}

Parameters:

Name	Type	Description
`radius`	`number`
`sigma`	`number`

View Source EffectsNative.ts, line 2103

Returns:

Type: void

# charcoalChannel(channel, radius, sigma) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`radius`	`number`
`sigma`	`number`

View Source EffectsNative.ts, line 2112

Returns:

Type: void

# chop(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2122

Returns:

Type: void

# clamp() → {void}

View Source EffectsNative.ts, line 2127

Returns:

Type: void

# clampChannel(channel) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`

View Source EffectsNative.ts, line 2134

Returns:

Type: void

# clip() → {void}

View Source EffectsNative.ts, line 2139

Returns:

Type: void

# clipPath(pathname, inside) → {void}

Parameters:

Name	Type	Description
`pathname`	`string`
`inside`	`string`

View Source EffectsNative.ts, line 2147

Returns:

Type: void

# clut(source, pixel_interpolate) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`
`pixel_interpolate`	`IPixelInterpolateMethod`

View Source EffectsNative.ts, line 2155

Returns:

Type: void

# clutChannel(channel, source, pixel_interpolate) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`source`	`EffectsNative` \| `any`
`pixel_interpolate`	`IPixelInterpolateMethod`

View Source EffectsNative.ts, line 2164

Returns:

Type: void

# colorFuzz(fuzz) → {void}

Parameters:

Name	Type	Description
`fuzz`	`number`

View Source EffectsNative.ts, line 2171

Returns:

Type: void

# colorMatrix(value, matrix) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsColorMatrix` \| `number`
`matrix`	`Array.<number>`

View Source EffectsNative.ts, line 2187

Returns:

Type: void

# colorize(value, color) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsColorize` \| `number`
`color`	`Partial.<Color>` \| `string`

View Source EffectsNative.ts, line 2179

Returns:

Type: void

# compare(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`

View Source EffectsNative.ts, line 2194

Returns:

Type: void

# compose(type) → {void}

Parameters:

Name	Type	Description
`type`	`ICompositeOperator`

View Source EffectsNative.ts, line 2201

Returns:

Type: void

# composite(type, source, value) → {void}

Parameters:

Name	Type	Description
`type`	`"gravity"` \| `"geometry"`
`source`	`EffectsNative` \| `any`
`value`	`string`

View Source EffectsNative.ts, line 2210

Returns:

Type: void

# context()

View Source EffectsNative.ts, line 1735

# contrast(sharpen) → {void}

Parameters:

Name	Type	Description
`sharpen`	`number`

View Source EffectsNative.ts, line 2217

Returns:

Type: void

# contrastStretch(blackPoint, whitePoint) → {void}

Parameters:

Name	Type	Description
`blackPoint`	`number`
`whitePoint`	`number`

View Source EffectsNative.ts, line 2225

Returns:

Type: void

# contrastStretchChannel(channel, blackPoint, whitePoint) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`blackPoint`	`number`
`whitePoint`	`number`

View Source EffectsNative.ts, line 2234

Returns:

Type: void

# crop(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2244

Returns:

Type: void

# defineSet(magick, key, flag) → {void}

Parameters:

Name	Type	Description
`magick`	`string`
`key`	`string`
`flag`	`boolean`

View Source EffectsNative.ts, line 2253

Returns:

Type: void

# defineValue(magick, key, value) → {void}

Parameters:

Name	Type	Description
`magick`	`string`
`key`	`string`
`value`	`string`

View Source EffectsNative.ts, line 2262

Returns:

Type: void

# display(title) → {void}

Parameters:

Name	Type	Description
`title`	`string`

View Source EffectsNative.ts, line 2269

Returns:

Type: void

# encipher(passphrase) → {void}

Parameters:

Name	Type	Description
`passphrase`	`string`

View Source EffectsNative.ts, line 2276

Returns:

Type: void

# enhance() → {void}

View Source EffectsNative.ts, line 2281

Returns:

Type: void

# extent(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2291

Returns:

Type: void

# fillColor(color) → {void}

Parameters:

Name	Type	Description
`color`	`string`

View Source EffectsNative.ts, line 2298

Returns:

Type: void

# fillPattern(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`

View Source EffectsNative.ts, line 2305

Returns:

Type: void

# fillRule(rule) → {void}

Parameters:

Name	Type	Description
`rule`	`IFillRule`

View Source EffectsNative.ts, line 2312

Returns:

Type: void

# flip() → {void}

View Source EffectsNative.ts, line 2317

Returns:

Type: void

# floodFillAlpha(value, y, alpha, …args) → {void}

Parameters:

Name	Type	Attributes
`value`	`ParamsFloodFillAlpha` \| `number`
`y`	`number`
`alpha`	`number`
`args`	`Array.<args>`	<repeatable>

View Source EffectsNative.ts, line 2327

Returns:

Type: void

# floodFillColor(value, color, …args) → {void}

Parameters:

Name	Type	Attributes
`value`	`ParamsFloodFillColor` \| `string`
`color`	`string`
`args`	`Array.<args>`	<repeatable>

View Source EffectsNative.ts, line 2336

Returns:

Type: void

# floodFillTexture(point, source, …args) → {void}

Parameters:

Name	Type	Attributes
`point`	`string`
`source`	`EffectsNative` \| `any`
`args`	`Array.<args>`	<repeatable>

View Source EffectsNative.ts, line 2345

Returns:

Type: void

# font(name) → {void}

Parameters:

Name	Type	Description
`name`	`string`

View Source EffectsNative.ts, line 2352

Returns:

Type: void

# fontFamily(family) → {void}

Parameters:

Name	Type	Description
`family`	`string`

View Source EffectsNative.ts, line 2359

Returns:

Type: void

# fontPointsize(size) → {void}

Parameters:

Name	Type	Description
`size`	`number`

View Source EffectsNative.ts, line 2366

Returns:

Type: void

# fontStyle(style) → {void}

Parameters:

Name	Type	Description
`style`

View Source EffectsNative.ts, line 2373

Returns:

Type: void

# fontTypeMetrics() → {FontMetrics}

View Source EffectsNative.ts, line 2379

Returns:

Type: FontMetrics

# fontTypeMetricsMultiline() → {FontMetricsMultiline}

View Source EffectsNative.ts, line 2385

Returns:

Type: FontMetricsMultiline

# fontWeight(weight) → {void}

Parameters:

Name	Type	Description
`weight`	`number`

View Source EffectsNative.ts, line 2392

Returns:

Type: void

# fx(expression, channel) → {void}

Parameters:

Name	Type	Description
`expression`	`string`
`channel`	`IChannelType`

View Source EffectsNative.ts, line 2400

Returns:

Type: void

# gamma(gamma) → {void}

Parameters:

Name	Type	Description
`gamma`	`number`

View Source EffectsNative.ts, line 2407

Returns:

Type: void

# getPixels() → {Buffer}

View Source EffectsNative.ts, line 2412

Returns:

Type: Buffer

# haldClut(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`

View Source EffectsNative.ts, line 2419

Returns:

Type: void

# height() → {number}

View Source EffectsNative.ts, line 1730

Returns:

Type: number

# implode(radius) → {void}

Parameters:

Name	Type	Description
`radius`	`number`

View Source EffectsNative.ts, line 2426

Returns:

Type: void

# label(label) → {void}

Parameters:

Name	Type	Description
`label`	`string`

View Source EffectsNative.ts, line 2433

Returns:

Type: void

# liquid(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2443

Returns:

Type: void

# medianFilter(radius) → {void}

Parameters:

Name	Type	Description
`radius`	`number`

View Source EffectsNative.ts, line 2450

Returns:

Type: void

# modify() → {void}

View Source EffectsNative.ts, line 2455

Returns:

Type: void

# modulate(value, saturation, hue) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsModulate` \| `number`
`saturation`	`number`
`hue`	`number`

View Source EffectsNative.ts, line 2464

Returns:

Type: void

# motionBlur(radius, sigma, angle) → {void}

Parameters:

Name	Type	Description
`radius`	`number`
`sigma`	`number`
`angle`	`number`

View Source EffectsNative.ts, line 2473

Returns:

Type: void

# negate(grayscale) → {void}

Parameters:

Name	Type	Description
`grayscale`	`boolean`

View Source EffectsNative.ts, line 2480

Returns:

Type: void

# negateChannel(channel, grayscale) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`grayscale`	`boolean`

View Source EffectsNative.ts, line 2488

Returns:

Type: void

# opaque(value, pen, invert) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsOpaque` \| `string`
`pen`	`string`
`invert`	`boolean`

View Source EffectsNative.ts, line 2497

Returns:

Type: void

# orderedDither(thresholdMap) → {void}

Parameters:

Name	Type	Description
`thresholdMap`	`string`

View Source EffectsNative.ts, line 2504

Returns:

Type: void

# orderedDitherChannel(channel, thresholdMap) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`thresholdMap`	`string`

View Source EffectsNative.ts, line 2512

Returns:

Type: void

# perceptible(epsilon) → {void}

Parameters:

Name	Type	Description
`epsilon`	`number`

View Source EffectsNative.ts, line 2519

Returns:

Type: void

# perceptibleChannel(channel, epsilon) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`epsilon`	`number`

View Source EffectsNative.ts, line 2527

Returns:

Type: void

# process(value, args) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsProcess` \| `string`
`args`	`Array.<string>`

View Source EffectsNative.ts, line 2535

Returns:

Type: void

# putPixels(pixels) → {void}

Parameters:

Name	Type	Description
`pixels`	`Buffer`

View Source EffectsNative.ts, line 2542

Returns:

Type: void

# quality(quality) → {void}

Parameters:

Name	Type	Description
`quality`	`number`

View Source EffectsNative.ts, line 2549

Returns:

Type: void

# quantize(measureError) → {void}

Parameters:

Name	Type	Description
`measureError`	`boolean`

View Source EffectsNative.ts, line 2556

Returns:

Type: void

# read(value, height, format, buffer) → {void}

Parameters:

Name	Type	Description
`value`	`ParamsRead` \| `number`
`height`	`number`
`format`	`string`
`buffer`	`Buffer`

View Source EffectsNative.ts, line 2566

Returns:

Type: void

# renderingIntent(type) → {void}

Parameters:

Name	Type	Description
`type`	`IRenderingIntent`

View Source EffectsNative.ts, line 2573

Returns:

Type: void

# repage() → {void}

View Source EffectsNative.ts, line 2578

Returns:

Type: void

# resize(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2588

Returns:

Type: void

# roll(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2598

Returns:

Type: void

# rotate(degrees) → {void}

Parameters:

Name	Type	Description
`degrees`	`number`

View Source EffectsNative.ts, line 2605

Returns:

Type: void

# rotationalBlur(angle) → {void}

Parameters:

Name	Type	Description
`angle`	`number`

View Source EffectsNative.ts, line 2612

Returns:

Type: void

# rotationalBlurChannel(channel, angle) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`angle`	`number`

View Source EffectsNative.ts, line 2620

Returns:

Type: void

# scale(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2630

Returns:

Type: void

# size(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2640

Returns:

Type: void

# splice(…args) → {void}

Parameters:

Name	Type	Attributes	Description
`args`	`Array.<any>`	<repeatable>

View Source EffectsNative.ts, line 2647

Returns:

Type: void

# stereo(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`

View Source EffectsNative.ts, line 2654

Returns:

Type: void

# strokeAntiAlias(flag) → {void}

Parameters:

Name	Type	Description
`flag`	`boolean`

View Source EffectsNative.ts, line 2661

Returns:

Type: void

# strokeColor(color) → {void}

Parameters:

Name	Type	Description
`color`	`string`

View Source EffectsNative.ts, line 2668

Returns:

Type: void

# strokeDashArray(dash_array) → {void}

Parameters:

Name	Type	Description
`dash_array`	`Array.<number>`

View Source EffectsNative.ts, line 2675

Returns:

Type: void

# strokeDashOffset(dash_offset) → {void}

Parameters:

Name	Type	Description
`dash_offset`	`number`

View Source EffectsNative.ts, line 2682

Returns:

Type: void

# strokeLineCap(lineCap) → {void}

Parameters:

Name	Type	Description
`lineCap`	`ILineCap`

View Source EffectsNative.ts, line 2689

Returns:

Type: void

# strokeLineJoin(lineJoin) → {void}

Parameters:

Name	Type	Description
`lineJoin`	`ILineJoin`

View Source EffectsNative.ts, line 2696

Returns:

Type: void

# strokeMiterLimit(miter_limit) → {void}

Parameters:

Name	Type	Description
`miter_limit`	`number`

View Source EffectsNative.ts, line 2703

Returns:

Type: void

# strokePattern(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`

View Source EffectsNative.ts, line 2710

Returns:

Type: void

# strokeWidth() → {number}

View Source EffectsNative.ts, line 1718

Returns:

Type: number

# subImage(sub_image) → {void}

Parameters:

Name	Type	Description
`sub_image`	`number`

View Source EffectsNative.ts, line 2717

Returns:

Type: void

# subRange(sub_range) → {void}

Parameters:

Name	Type	Description
`sub_range`	`number`

View Source EffectsNative.ts, line 2724

Returns:

Type: void

# textAntiAlias(flag) → {void}

Parameters:

Name	Type	Description
`flag`	`boolean`

View Source EffectsNative.ts, line 2731

Returns:

Type: void

# textDirection(direction) → {void}

Parameters:

Name	Type	Description
`direction`	`IDirectionType`

View Source EffectsNative.ts, line 2738

Returns:

Type: void

# textGravity(gravity) → {void}

Parameters:

Name	Type	Description
`gravity`	`IGravityType`

View Source EffectsNative.ts, line 2745

Returns:

Type: void

# textInterlineSpacing(spacing) → {void}

Parameters:

Name	Type	Description
`spacing`	`number`

View Source EffectsNative.ts, line 2752

Returns:

Type: void

# textInterwordSpacing(spacing) → {void}

Parameters:

Name	Type	Description
`spacing`	`number`

View Source EffectsNative.ts, line 2759

Returns:

Type: void

# textKerning(kerning) → {void}

Parameters:

Name	Type	Description
`kerning`	`number`

View Source EffectsNative.ts, line 2766

Returns:

Type: void

# textUnderColor(color) → {void}

Parameters:

Name	Type	Description
`color`	`string`

View Source EffectsNative.ts, line 2773

Returns:

Type: void

# texture(source) → {void}

Parameters:

Name	Type	Description
`source`	`EffectsNative` \| `any`

View Source EffectsNative.ts, line 2780

Returns:

Type: void

# thumbnail(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2790

Returns:

Type: void

# tint(opacity) → {void}

Parameters:

Name	Type	Description
`opacity`	`number`

View Source EffectsNative.ts, line 2797

Returns:

Type: void

# toBase64(format) → {string}

Parameters:

Name	Type	Description
`format`	`string`

View Source EffectsNative.ts, line 2804

Returns:

Type: string

# toBuffer(format) → {Buffer}

Parameters:

Name	Type	Description
`format`	`string`

View Source EffectsNative.ts, line 2811

Returns:

Type: Buffer

# transformOrigin(x, y) → {void}

Parameters:

Name	Type	Description
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2819

Returns:

Type: void

# transformReset() → {void}

View Source EffectsNative.ts, line 2824

Returns:

Type: void

# transformRotation(angle) → {void}

Parameters:

Name	Type	Description
`angle`	`number`

View Source EffectsNative.ts, line 2831

Returns:

Type: void

# transformScale(sx, sy) → {void}

Parameters:

Name	Type	Description
`sx`	`number`
`sy`	`number`

View Source EffectsNative.ts, line 2839

Returns:

Type: void

# transformSkewX(x) → {void}

Parameters:

Name	Type	Description
`x`	`number`

View Source EffectsNative.ts, line 2846

Returns:

Type: void

# transformSkewY(y) → {void}

Parameters:

Name	Type	Description
`y`	`number`

View Source EffectsNative.ts, line 2853

Returns:

Type: void

# transparent(color, inverse) → {void}

Parameters:

Name	Type	Description
`color`	`string`
`inverse`	`boolean`

View Source EffectsNative.ts, line 2861

Returns:

Type: void

# transparentChroma(low, high) → {void}

Parameters:

Name	Type	Description
`low`	`string`
`high`	`string`

View Source EffectsNative.ts, line 2869

Returns:

Type: void

# transpose() → {void}

View Source EffectsNative.ts, line 2874

Returns:

Type: void

# transverse() → {void}

View Source EffectsNative.ts, line 2879

Returns:

Type: void

# trim() → {void}

View Source EffectsNative.ts, line 2884

Returns:

Type: void

# unsharpmask(radius, sigma, amount, threshold) → {void}

Parameters:

Name	Type	Description
`radius`	`number`
`sigma`	`number`
`amount`	`number`
`threshold`	`number`

View Source EffectsNative.ts, line 2894

Returns:

Type: void

# unsharpmaskChannel(channel, radius, sigma, amount, threshold) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`radius`	`number`
`sigma`	`number`
`amount`	`number`
`threshold`	`number`

View Source EffectsNative.ts, line 2905

Returns:

Type: void

# verbose(flag) → {void}

Parameters:

Name	Type	Description
`flag`	`boolean`

View Source EffectsNative.ts, line 2912

Returns:

Type: void

# vignette(radius, sigma, x, y) → {void}

Parameters:

Name	Type	Description
`radius`	`number`
`sigma`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2922

Returns:

Type: void

# virtualPixel(method) → {void}

Parameters:

Name	Type	Description
`method`	`IVirtualPixelMethod`

View Source EffectsNative.ts, line 2929

Returns:

Type: void

# wave(amplitude, wavelength) → {void}

Parameters:

Name	Type	Description
`amplitude`	`number`
`wavelength`	`number`

View Source EffectsNative.ts, line 2937

Returns:

Type: void

# waveletDenoise(threshold, softness) → {void}

Parameters:

Name	Type	Description
`threshold`	`number`
`softness`	`number`

View Source EffectsNative.ts, line 2945

Returns:

Type: void

# whiteThreshold(threshold) → {void}

Parameters:

Name	Type	Description
`threshold`	`string`

View Source EffectsNative.ts, line 2952

Returns:

Type: void

# whiteThresholdChannel(channel, threshold) → {void}

Parameters:

Name	Type	Description
`channel`	`IChannelType`
`threshold`	`string`

View Source EffectsNative.ts, line 2960

Returns:

Type: void

# width() → {number}

View Source EffectsNative.ts, line 1724

Returns:

Type: number

# write(path, format) → {void}

Parameters:

Name	Type	Description
`path`	`string`
`format`	`string`

View Source EffectsNative.ts, line 2968

Returns:

Type: void

# writeFrames(path) → {void}

Parameters:

Name	Type	Description
`path`	`string`

View Source EffectsNative.ts, line 2975

Returns:

Type: void

# zoom(height, x, y) → {void}

Parameters:

Name	Type	Description

`height`	`number`
`x`	`number`
`y`	`number`

View Source EffectsNative.ts, line 2985

Returns:

Type: void

# static createImage(w, h) → {EffectsNative}

Parameters:

Name	Type	Description
`w`	`number`
`h`	`number`

View Source EffectsNative.ts, line 1712

Returns:

Type: EffectsNative

GraphicsNative documentation

# new EffectsNative(value)

Parameters:

Classes

Members

# context

# height

# strokeWidth

# width

Methods

# adaptiveBlur(value, sigma) → {void}

Parameters:

# adaptiveResize(value, height, x, y) → {void}

Parameters:

# adaptiveSharpen(value, sigma) → {void}

Parameters:

# adaptiveSharpenChannel(value, radius, sigma) → {void}

Parameters:

# adaptiveThreshold(value, height, bias) → {void}

Parameters:

# addAffine(sx, sy, rx, ry, tx, ty) → {void}

Parameters:

# addArc(startX, startY, endX, endY, startDegrees, endDegrees) → {void}

Parameters:

# addBorder(value, height, x, y) → {void}

Parameters:

# addCircle(originX, originY, perimX, perimY) → {void}

Parameters:

# addFrame(source) → {void}

Parameters:

# addNoise(type) → {void}

Parameters:

# addNoiseChannel(channel, type) → {void}

Parameters:

# addPolygon(polygons) → {void}

Parameters:

# addRoundRectangle(value, upperLeftY, lowerRightX, lowerRightY, cornerWidth, cornerHeight) → {void}

Parameters:

# addSource(value, height, x, y) → {void}

Parameters:

# addText(value) → {void}

Parameters:

# adjoin(flag) → {void}

Parameters:

# affineTransform(value, sy, rx, ry, tx, ty) → {void}

Parameters:

# alpha(flag) → {void}

Parameters:

# animationDelay(delay) → {void}

Parameters:

# animationIterations(iterations) → {void}

Parameters:

# annotate(value, gravity) → {void}

Parameters:

# artifact(name) → {void}

Parameters:

# attribute(key, value) → {void}

Parameters:

# autoGamma() → {void}

# autoGammaChannel(channel) → {void}

Parameters:

# autoLevel() → {void}

# autoLevelChannel(channel) → {void}

Parameters:

# autoOrient() → {void}

# autoThreshold(type) → {void}

Parameters:

# backgroundColor(color) → {void}

Parameters:

# backgroundTexture(name) → {void}

Parameters:

# blackThreshold(threshold) → {void}

Parameters:

# blackThresholdChannel(channel, threshold) → {void}

Parameters:

# blueShift(radius) → {void}

Parameters:

# blur(value, sigma) → {void}

Parameters:

# blurChannel(channel, radius, sigma) → {void}