voltmx.filter Namespace
The voltmx.filter namespace provides your apps with the ability to create and manage filters for use with the Image widget. Information about the voltmx.filter namespace is presented in the following topics:
Functions
The voltmx.filter namespace provides the following function:
voltmx.filter.createFilter Function
Creates a new filter object for use with the Image widget.
Syntax
voltmx.filter.createFilter()
Example
var filterObj = voltmx.filter.createFilter();
Input Parameters
None.
Return Values
A new filter object.
Platform Availability
Available on iOS and Android.
Constants
The voltmx.filter namespace contains the following constants:
Android Filters
The following filters are available on Android devices.
| Filter Name | Filter Type | Description |
|---|---|---|
| AdditionCompositing | voltmx.filter.ADDITION_COMPOSITING | This filter is available from Android 3.0 and above. |
| BoxBlur | voltmx.filter.BOX_BLUR | Increase or decreases the blurriness of image. |
| Brightness | voltmx.filter.BRIGHTNESS | Increases or decreases the brightness of an image. |
| ClearCompositing | voltmx.filter.CLEAR_COMPOSITING | This filter is available from Android 3.0 and above. |
| ColorClamp | voltmx.filter.COLOR_CLAMP | This filter clamps the colors of input image within the given range. |
| ColorInversion | voltmx.filter.COLOR_INVERSION | Inverts the colors of given image. When this filter is applied, for each pixel having [R,G,B] components in given image, this filter inverts the color components of those pixels to [255-R, 255-G, 255-B]. Transparency or Alpha component is untouched |
| ColorMatrix | voltmx.filter.COLOR_MATRIX | This filter transforms the colors of given image as per the input parameters |
| DarkenCompositing | voltmx.filter.DARKEN_COMPOSITING | This filter is available from Android 3.0 and above. |
| EdgeDetection | voltmx.filter.EDGE_DETECTION | Detects or Highlight the edges of given image. |
| Emboss | voltmx.filter.EMBOSS | Applies an embossing effect for a given image. |
| GaussianBlur | voltmx.filter.GAUSSIAN_BLUR | Spreads source pixels by an amount specified by a Gaussian distribution to increase the blurriness. Blurriness of this filter is smooth compared to BoxBlur. |
| Greyscale | voltmx.filter.GREYSCALE | Converts given image to black & white or monochrome image. |
| MultiplyCompositing | voltmx.filter.MULTIPLY_COMPOSITING | This filter is available from Android 3.0 and above. |
| LightenCompositing | voltmx.filter.LIGHTEN_COMPOSITING | This filter is available from Android 3.0 and above. |
| OverlayCompositing | voltmx.filter.OVERLAY_COMPOSITING | This filter is available from Android 3.0 and above. |
| SourceAtopCompositing | voltmx.filter.SOURCE_ATOP_COMPOSITING | This filter is available from Android 3.0 and above. |
| ScreenCompositing | voltmx.filter.SCREEN_COMPOSITING | This filter is available from Android 3.0 and above. |
| Sharpen | voltmx.filter.SHARPEN | Increases the sharpness of image. |
| SourceInCompositing | voltmx.filter.SOURCE_IN_COMPOSITING | This filter is available from Android 3.0 and above. |
| SourceOutCompositing | voltmx.filter.SOURCE_OUT_COMPOSITING | This filter is available from Android 3.0 and above. |
| SourceOverCompositing | voltmx.filter.SOURCE_OVER_COMPOSITING | This filter is available from Android 3.0 and above. |
| XorCompositing | voltmx.filter.XOR_COMPOSITING | This filter is available from Android 3.0 and above. |
Filter Input Parameters
The filter object uses the following input parameters.
| Parameter | Description |
|---|---|
| inputImage | Image object |
| inputRadius | Floating point number |
| inputMask | Masking image |
| inputAngle | Floating point number |
| inputNoiseLevel | Floating point number |
| inputCenter | Array of two values defining the (x,y) location of the center |
| inputScale | Floating point number |
| inputAmount | Floating point number |
| inputSharpness | Floating point number |
| inputMinComponents | Array of four floating values |
| inputMaxComponents | Array of four floating values |
| inputSaturation | Floating point number |
| inputBrightness | Floating point number |
| inputIntensity | Floating point number |
| inputContrast | Floating point number |
| inputRVector | Array of four floats |
| inputGVector | Array of four floats |
| inputBVector | Array of four floats |
| inputAVector | Array of four floats |
| inputBiasVector | Array of four floats |
| inputRedCoefficients | Array of four floats |
| inputGreenCoefficients | Array of four floats |
| inputBlueCoefficients | Array of four floats |
| inputAlphaCoefficients | Array of four floats |
| inputEV | Floating point number |
| inputPower | Floating point number |
| inputNeutral | Array of two floating point numbers |
| inputTargetNeutral | Array of two floating point numbers |
| inputPoint0 | Array of two floating point numbers |
| inputPoint1 | Array of two floating point numbers |
| inputPoint2 | Array of two floating point numbers |
| inputPoint3 | Array of two floating point numbers |
| inputPoint4 | Array of two floating point numbers |
| inputColor | Array of four numbers representing the color |
| inputRedCoefficients | Array of ten floating point numbers |
| inputGreenCoefficients | Array of ten floating point numbers |
| inputBlueCoefficients | Array of ten floating point numbers |
| inputGradientImage | Gradient Image |
| inputBackgroundImage | Background Image |
| inputLevels | Floating point number |
| inputColor0 | Array of four hex numbers representing the color |
| inputColor1 | Array of four hex numbers representing the color |
| inputInsetPoint0 | Array of two floating point numbers |
| inputInsetPoint1 | Array of two floating point numbers |
| inputStrands | Floating point number |
| inputPeriodicity | Floating point number |
| inputRotation | Floating point number |
| inputZoom | Floating point number |
| inputDisplacementImage | Image object |
| inputTexture | Image object |
| inputRefraction | Floating point number |
| inputCropAmount | Floating point number |
| inputCenterStretchAmount | Floating point number |
| inputWidth | Floating point number |
| inputTransform | Array of nine floats representing the transform |
| inputRectangle | Array of four floating point numbers |
| inputAspectRatio | Floating point number |
| inputTopLeft | Array of two floating point numbers |
| inputTopRight | Array of two floating point numbers |
| inputBottomRight | Array of two floating point numbers |
| inputBottomLeft | Array of two floating point numbers |
| inputExtent | Array of four floating point numbers |
| inputRadius0 | Floating point number |
| inputRadius1 | Floating point number |
| inputGCR | Floating point number |
| inputUCR | Floating point number |
| inputCount | Integer |
| inputHeight | Floating point number |
| inputHighLimit | Floating point number |
| inputLowLimit | Floating point number |
| inputMaskImage | Masking image |
| inputWeights | Array of floating point numbers |
| inputBias | Floating point number |
| inputUnsharpMaskRadius | Floating point number |
| inputUnsharpMaskIntensity | Floating point number |
| inputHighlightAmount | Floating point number |
| inputShadowAmount | Floating point number |
| inputNRNoiseLevel | Floating point number |
| inputNRSharpness | Floating point number |
| inputEdgeIntensity | Floating point number |
| inputThreshold | Floating point number |
| inputContrast | Floating point number |
| inputShadingImage | Image object |
| inputLightPosition | Array of three floating point numbers |
| inputLightPointsAt | Array of three floating point numbers |
| inputConcentration | Floating point number |
Filter Type Constants
| Filter Type | Parameters | Description |
|---|---|---|
| voltmx.filter.ADDITION_COMPOSITING | filterName:- voltmx.filter.ADDITION_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | Adds color components to achieve a brightening effect. This filter is available from Android 3.0 and above. This filter is available in iOS 6 and above. |
| voltmx.filter.AFFINE_TRANSFORM | filterName :- voltmx.filter.AFFINE_TRANSFORM inputImage :- Image widget inputTransform:- transform object | This filter is available in iOS 5 and above. |
| voltmx.filter.BLEND_WITH_MASK | filterName :- voltmx.filter.BLEND_WITH_MASK inputImage :-Image widget inputBackgroundImage :- Image widget inputMaskImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.BLEND_WITH_ALPHA_MASK | filterName :- voltmx.filter.BLEND_WITH_ALPHA_MASK inputImage :- Image widget, inputBackgroundImage :- Image widget inputMaskImage :- Image widget | This filter is available in iOS 7 and above. |
| voltmx.filter.BLOOM | filterName :- voltmx.filter.BLOOM inputImage :- Image widget inputRadius :- Number inputIntensity: Number | This filter is available in iOS 6 and above. |
| voltmx.filter.BOX_BLUR | filterName:- voltmx.filter.BOX_BLUR inputImage:- Image widget inputRadius:- number(1 to 25) | Increase or decreases the blurriness of image. Available on Android. This filter is available in iOS 9 and above. |
| voltmx.filter.BRIGHTNESS | inputImage :- Image widget inputBrightness :- number (0.0 to infinite) | Increases or decreases the brightness of an image. Available on Android. |
| voltmx.filter.COLOR_BLEND_MODE | filterName :- voltmx.filter.COLOR_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Uses the luminance values of the background with the hue and saturation values of the source image. This filter is available in iOS 6 and above. |
| voltmx.filter.CLEAR_COMPOSITING | filterName:- voltmx.filter.CLEAR_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. |
| voltmx.filter.COLOR_CLAMP | filterName:- voltmx.filter.COLOR_CLAMP inputImage:- Image widget inputMinComponents:- array of four floats representing [R,G,B,A] in that order where each float ranges between 0.0 to 1.0. inputMaxComponents:- array of four floats representing [R,G,B,A] in that order where each float ranges between 0.0 to 1.00 | This filter clamps the colors of the input image within the given range specified by inputMinComponents and inputMaxComponents. At each pixel, color component values less than those in inputMinComponents will be increased to match those in inputMinComponents, and color component values greater than those in inputMaxComponents will be decreased to match those in inputMaxComponents. Available on Android. This filter is available in iOS 7 and above. |
| voltmx.filter.COLOR_CONTROLS | filterName :- voltmx.filter.COLOR_CONTROLS inputImage :- Image widget inputSaturation:- number (0.0 - 1.0) inputBrightness:- number (0.0 - 1.0) inputContrast:- number (0.0 - 1.0) | Adjusts saturation, brightness, and contrast values. This filter is available in iOS 5 and above. |
| voltmx.filter.COLOR_CROSS_POLYNOMIAL | filterName :- voltmx.filter.COLOR_CROSS_POLYNOMIAL inputImage :- Image widget inputRedCoefficients:- Array of 10 numbers [x,y,z,w,...] (0.0 - 1.0) inputGreenCoefficients:- Array of 10 numbers [x,y,z,w,….] (0.0 - 1.0) inputBlueCoefficients:- Array of 10 numbers [x,y,z,w,…..] (0.0 - 1.0) | Modifies the pixel values in an image by applying a set of polynomial cross-products. This filter is available in iOS 6 and above. |
| voltmx.filter.COLOR_DODGE_BLEND_MODE | filterName :- voltmx.filter.COLOR_DODGE_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Brightens the background image samples to reflect the source image samples. This filter is available in iOS 6 and above. |
| voltmx.filter.COLOR_INVERSION | filterName:- voltmx.filter.COLOR_INVERSION inputImage:- Image widget | Inverts the colors of given image. Available on Android. Available on iOS 6 and above. |
| voltmx.filter.COLOR_MAP | filterName :- voltmx.filter.COLOR_MAP inputImage :- Image widget inputGradientImage :- Image widget | Performs a nonlinear transformation of source color values using mapping values provided in a table. inputGradientImage is an nx1 or nxn gradient image used to describe a color ramp. This filter is available in iOS 6 and above. |
| voltmx.filter.COLOR_MATRIX | filterName :- voltmx.filter.COLOR_MATRIX inputImage :- Image widget inputRVector:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputGVector:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputBVector:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputAVector:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputBiasVector:- Array of four numbers [x,y,z,w] (0.0 - 1.0) | Multiplies source color values and adds a bias factor to each color component. Available on iOS 5 and above. |
| voltmx.filter.COLOR_MATRIX | filterName:- voltmx.filter.COLOR_MATRIX inputImage:- Image widget inputRVector:- array of four numbers representing [R,G,B,A] in that order. inputGVector:- array of four numbers representing [R,G,B,A] in that order. inputBVector:- array of four numbers representing [R,G,B,A] in that order. inputAVector:- array of four numbers representing [R,G,B,A] in that order. inputBiasVector:- array of four values where each value should be added to each channel of RGBA in that order. | This filter transforms the colors of given image as per the input parameters. For a given color [R,G,B,A] of a pixel in the input image, the resulting color [rR, rG, rB, rA] is computed as follows: rR = R*Rv[0] + G*Rv[1] + B*Rv[2] + A*Rv[3] + bias[0] rG = R*Gv[0] + G*Gv[1] + B*Gv[2] + A*Gv[3] + bias[1] rB = R*Bv[0] + G*Bv[1] + B*Bv[2] + A*Bv[3] + bias[2] rA = R*Av[0] + G*Av[1] + B*Av[2] + A*Av[3] + bias[3] where Rv is inputRVector, Gv is inputGVector, Bv is inputBVector, Av is inputAVector and bias is inputBiasVector. The resulting color values [rR, rG, rB, rA] are clamped to 255 if exceeded beyond 255. Available on Android. |
| voltmx.filter.COLOR_MONOCHROME | filterName :- voltmx.filter.COLOR_MONOCHROME inputImage :- Image widget inputColor :- Array of three numbers [r,g,b] (0.0 - 1.0) inputIntensity:- Number | Remaps colors so they fall within shades of a single color. As inputColor only opaque color needs to be passed, ie, only red, blue, green components and no alpha. inputColor values should be in the range of 0.0 - 1.0. inputIntensity accepts the values in range 0.0 - 1.0. This filter is available on iOS 6 and above. |
| voltmx.filter.COLOR_POLYNOMIAL | filterName :- voltmx.filter.COLOR_POLYNOMIAL inputImage :- Image widget inputRedCoefficients:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputGreenCoefficients:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputBlueCoefficients:- Array of four numbers [x,y,z,w] (0.0 - 1.0) inputAlphaCoefficients:- Array of four numbers [x,y,z,w] (0.0 - 1.0) | Modifies the pixel values in an image by applying a set of cubic polynomials. This filter is available in iOS 7 and above. |
| voltmx.filter.COLOR_POSTERIZE | filterName :- voltmx.filter.COLOR_POSTERIZE inputImage :- Image widget inputLevels :- Number | Remaps red, green, and blue color components to the number of brightness values you specify for each color component. This filter is available on iOS 6 and above. |
| voltmx.filter.COMIC_EFFECT | filterName :- voltmx.filter.COMIC_EFFECT inputImage :- Image widget | This filter is available on iOS 9 and above. |
| voltmx.filter.CONVOLUTION_3X3 | filterName :- voltmx.filter.CONVOLUTION_3X3 inputImage :- Image widget inputWeights :- Array of 9 numbers (0.0 - 1.0) inputBias :- number (0.0 - 1.0) | This filter is available on iOS 7 and above. |
| voltmx.filter.CONVOLUTION_5X5 | filterName :- voltmx.filter.CONVOLUTION_5X5 inputImage :- Image widget inputWeights :- Array of 25 numbers (0.0 - 1.0) inputBias :- number (0.0 - 1.0) | This filter is available on iOS 7 and above. |
| voltmx.filter.CONVOLUTION_7X7 | filterName :- voltmx.filter.CONVOLUTION_7X7 inputImage :- Image widget, inputWeights :- Array of 7x7 = 49 numbers (0.0 - 1.0) inputBias :- number (0.0 - 1.0) | This filter is available on iOS 9 and above. |
| voltmx.filter.CONVOLUTION_9_HORIZONTAL | filterName :- voltmx.filter.CONVOLUTION_9_HORIZONTAL inputImage :- Image widget, inputWeights :- Array of 9 numbers (0.0 - 1.0) inputBias :- number (0.0 - 1.0) | This filter is available on iOS 7 and above. |
| voltmx.filter.CONVOLUTION_9_VERTICAL | filterName :- voltmx.filter.CONVOLUTION_9_VERTICAL inputImage :- Image widget, inputWeights :- Array of 9 numbers (0.0 - 1.0) inputBias :- number (0.0 - 1.0) | This filter is available on iOS 7 and above. |
| voltmx.filter.CRYSTALLIZE | filterName :- voltmx.filter.CRYSTALLIZE inputImage :- Image widget, inputRadius:- number inputCenter :- Array of two numbers [x,y] | This filter is available on iOS 9 and above. |
| voltmx.filter.DARKEN_BLEND_MODE | filterName :- voltmx.filter.DARKEN_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Creates composite image samples by choosing the darker samples. This filter is available on iOS 6 and above. |
| voltmx.filter.DARKEN_COMPOSITING | filterName:- voltmx.filter.DARKEN_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. |
| voltmx.filter.DIFFERENCE_BLEND_MODE | filterName :- voltmx.filter.DIFFERENCE_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Subtracts the greater brightness values from lower. This filter is available on iOS 6 and above. |
| voltmx.filter.DISC_BLUR | filterName :- voltmx.filter.DISC_BLUR inputImage :- Image widget inputRadius:- number | This filter is available on iOS 9 and above. |
| voltmx.filter.DIVIDE_BLEND_MODE | filterName :- voltmx.filter.DIVIDE_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Divides the backgroundImage color from source image color. This filter is available on iOS 8 and above. |
| voltmx.filter.EDGES | filterName :- voltmx.filter.EDGES inputImage :- Image widget, inputIntensity :- number | This filter is available on iOS 9 and above. |
| voltmx.filter.EDGE_WORK | filterName :- voltmx.filter.EDGE_WORK inputImage :- Image widget, inputRadius :- number | This filter is available on iOS 9 and above. |
| voltmx.filter.EXCLUSION_BLEND_MODE | filterName :- voltmx.filter.EXCLUSION_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Producess the similar effect as CIDifferenceBlend mode but has lower contrast.This filter is available on iOS 6 and above. |
| voltmx.filter.EXPOSURE_ADJUST | filterName :- voltmx.filter.EXPOSURE_ADJUST inputImage :- Image widget inputEV:- number (0.0 - 1.0) | Adjusts the exposure setting for an image similar to the way you control exposure for a camera when you change the F-stop. This filter is available on iOS 5 and above. |
| voltmx.filter.EDGE_DETECTION | filterName:- voltmx.filter.EDGE_DETECTION inputImage:- Image widget inputRadius:- number(1 or 2) | Detects or Highlight the edges of given image. Available on Android. |
| voltmx.filter.EMBOSS | filterName:- voltmx.filter.EMBOSS inputImage:- Image widget inputRadius:- number(1 or 2) | Applies an embossing effect for a given image. Available on Android. |
| voltmx.filter.FALSE_COLOR | filterName :- voltmx.filter.FALSE_COLOR inputImage :- Image widget inputColor0 :- Array of four numbers of 0.0 - 1.0 [r,g,b,a] inputColor1 :- Array of four numbers of 0.0 - 1.0 [r,g,b,a] | Maps luminance to a color ramp of two colors. This filter is available in iOS 6 and above. |
| voltmx.filter.GAMMA_ADJUST | filterName :- voltmx.filter.GAMMA_ADJUST inputImage :- Image widget inputPower:- number (0.0 - 1.0) | This filter is available in iOS 5 and above. |
| voltmx.filter.GAUSSIAN_BLUR | filterName:- voltmx.filter.GAUSSIAN_BLUR inputImage:- Image widget inputRadius:- number(1 to 25) | Spreads source pixels by an amount specified by a Gaussian distribution to increase the blurriness. The blurriness of this filter is smooth compared to BoxBlur. Available on Android. Available on iOS 6 and above. |
| voltmx.filter.GLOOM | filterName :- voltmx.filter.GLOOM inputImage :- Image widget inputRadius :- Number inputIntensity: Number | This filter is available in iOS 6 and above. |
| voltmx.filter.GREYSCALE | filterName:- voltmx.filter.GREYSCALE inputImage:- Image widget | Converts given image to black & white or monochrome image. Available on Android. |
| voltmx.filter.HARD_LIGHT_BLEND_MODE | filterName :- voltmx.filter.HARD_LIGHT_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | If input image sample is lighter than 50% grey then backgroundImage sample is lightened. If input image sample is greater that 50% grey then backgroundImage sample is darkened. This filter is available in iOS 6 and above. |
| voltmx.filter.HUE_ADJUST | filterName :- voltmx.filter.HUE_ADJUST inputImage :- Image widget inputAngle:- number (angle in Radians) | Changes the overall hue, or tint, of the source pixels. This filter is available in iOS 5 and above. |
| voltmx.filter.HUE_BLEND_MODE | filterName :- voltmx.filter.HUE_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | Uses luminance and saturation values from backgroundImage with the hue values on input image. This filter is available in iOS 6 and above. |
| voltmx.filter.LIGHTEN_BLEND_MODE | filterName :- voltmx.filter.LIGHTEN_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | The lighter samples are taken from both the images and will be used in resultant image. This filter is available in iOS 6 and above. |
| voltmx.filter.LIGHTEN_COMPOSITING | filterName:- voltmx.filter.LIGHTEN_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. |
| voltmx.filter.LINEAR_BURN_BLEND_MODE | filterName :- voltmx.filter.LINEAR_BURN_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 8 and above. |
| voltmx.filter.LINEAR_DODGE_BLEND_MODE | filterName :- voltmx.filter.LINEAR_DODGE_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 8 and above. |
| voltmx.filter.LINEAR_TO_SRGB_TONE_CURVE | filterName :- voltmx.filter.LINEAR_TO_SRGB_TONE_CURVE inputImage :- Image widget | This filter is available in iOS 7 and above. |
| voltmx.filter.LUMINOSITY_BLEND_MODE | filterName :- voltmx.filter.LUMINOSITY_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.MASK_TO_ALPHA | filterName :- voltmx.filter.MASK_TO_ALPHA inputImage :- Image widget | Converts a grayscale image to a white image that is masked by alpha. This filter is available in iOS 6 and above. |
| voltmx.filter.MAXIMUM_COMPONENT | filterName :- voltmx.filter.MAXIMUM_COMPONENT inputImage :- Image widget | Returns a grayscale image from max(r,g,b). This filter is available in iOS 6 and above. |
| voltmx.filter.MAXIMUM_COMPOSITING | filterName :- voltmx.filter.MAXIMUM_COMPOSITING inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.MEDIAN_FILTER | filterName :- voltmx.filter.MEDIAN_FILTER inputImage :- Image widget | This filter is available in iOS 9 and above. |
| voltmx.filter.MINIMUM_COMPONENT | filterName :- voltmx.filter.MINIMUM_COMPONENT inputImage :- Image widget | This filter is available in iOS 5 and above. |
| voltmx.filter.MINIMUM_COMPOSITING | filterName :- voltmx.filter.MINIMUM_COMPOSITING inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.MOTION_BLUR | filterName :- voltmx.filter.MOTION_BLUR inputImage :- Image widget inputRadius:- number inputAngle:- number (angle in radians) | This filter is available in iOS 9 and above. |
| voltmx.filter.MULTIPLY_BLEND_MODE | filterName :- voltmx.filter.MULTIPLY_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.MULTIPLY_COMPOSITING | filterName:- voltmx.filter.MULTIPLY_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. This filter is available in iOS 6 and above. |
| voltmx.filter.NOISE_REDUCTION | filterName :- voltmx.filter.NOISE_REDUCTION inputImage :- Image widget inputNoiseLevel:- number (0.0 - 1.0) inputSharpness:- number (0.0 - 1.0) | This filter is available in iOS 9 and above. |
| voltmx.filter.OVERLAY_BLEND_MODE | filterName :- voltmx.filter.OVERLAY_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.OVERLAY_COMPOSITING | filterName:- voltmx.filter.OVERLAY_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. |
| voltmx.filter.PHOTO_EFFECT_CHROME | filterName :- voltmx.filter.PHOTO_EFFECT_CHROME inputImage :- Image widget | Applies a preconfigured set of effects that imitate vintage photography film with exaggerated color.This filter is available in iOS 6 and above. |
| voltmx.filter.PHOTO_EFFECT_FADE | filterName :- voltmx.filter.PHOTO_EFFECT_FADE inputImage :- Image widget | Applies a preconfigured set of effects that imitate vintage photography film with diminished color. This filter is available in iOS 7 and above. |
| voltmx.filter.PHOTO_EFFECT_INSTANT | filterName :- voltmx.filter.PHOTO_EFFECT_INSTANT inputImage :- Image widget | Applies a preconfigured set of effects that imitate vintage photography film with distorted colors. This filter is available in iOS 7 and above. |
| voltmx.filter.PHOTO_EFFECT_MONO | filterName :- voltmx.filter.PHOTO_EFFECT_MONO inputImage :- Image widget | Applies a preconfigured set of effects that imitate black-and-white photography film with low contrast. This filter is available in iOS 7 and above. |
| voltmx.filter.PHOTO_EFFECT_PROCESS | filterName :- voltmx.filter.PHOTO_EFFECT_PROCESS inputImage :- Image widget | Applies a preconfigured set of effects that imitate vintage photography film with emphasized cool colors. This filter is available in iOS 7 and above. |
| voltmx.filter.PHOTO_EFFECT_TONAL | filterName :- voltmx.filter.PHOTO_EFFECT_TONAL inputImage :- Image widget | Applies a preconfigured set of effects that imitate black-and-white photography film without significantly altering contrast.This filter is available in iOS 7 and above. |
| voltmx.filter.PHOTO_EFFECT_TRANSFER | filterName :- voltmx.filter.PHOTO_EFFECT_TRANSFER inputImage :- Image widget | Applies a preconfigured set of effects that imitate vintage photography film with emphasized warm colors. This filter is available in iOS 7 and above. |
| voltmx.filter.PIN_LIGHT_BLEND_MODE | filterName :- voltmx.filter.PIN_LIGHT_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 8 and above. |
| voltmx.filter.SATURATION_BLEND_MODE | filterName :- voltmx.filter.SATURATION_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.SCREEN_BLEND_MODE | filterName :- voltmx.filter.SCREEN_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.SCREEN_COMPOSITING | filterName:- voltmx.filter.SCREEN_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. |
| voltmx.filter.SEPIA_TONE | filterName :- voltmx.filter.SEPIA_TONE inputImage :- Image widget inputInternsity:- number | Maps the colors of an image to various shades of brown. This filter is available in iOS 5 and above. |
| voltmx.filter.SHARPEN | filterName:- voltmx.filter.SHARPEN inputImage:- Image widget inputRadius:- number(1 or 2) | Increases the sharpness of image. Available on Android. |
| voltmx.filter.SOFT_LIGHT_BLEND_MODE | filterName :- voltmx.filter.SOFT_LIGHT_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 6 and above. |
| voltmx.filter.SOURCE_ATOP_COMPOSITING | filterName:- voltmx.filter.SOURCE_ATOP_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. This filter is available in iOS 6 and above. |
| voltmx.filter.SOURCE_IN_COMPOSITING | filterName:- voltmx.filter.SOURCE_IN_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. This filter is available in iOS 6 and above. |
| voltmx.filter.SOURCE_OUT_COMPOSITING | filterName:- voltmx.filter.SOURCE_OUT_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. This filter is available in iOS 6 and above. |
| voltmx.filter.SOURCE_OVER_COMPOSITING | filterName:- voltmx.filter.SOURCE_OVER_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. This filter is available in iOS 5 and above. |
| voltmx.filter.SRGB_TONE_CURVE_TO_LINEAR | filterName :- voltmx.filter.SRGB_TONE_CURVE_TO_LINEAR inputImage :- Image widget | This filter is available in iOS 7 and above. |
| voltmx.filter.SUBTRACT_BLEND_MODE | filterName :- voltmx.filter.SUBTRACT_BLEND_MODE inputImage :- Image widget inputBackgroundImage :- Image widget | This filter is available in iOS 8 and above. |
| voltmx.filter.TEMPERATURE_AND_TINT | filterName :- voltmx.filter.TEMPERATURE_AND_TINT inputImage :- Image widget inputNeutral:- Array of two numbers [x,y] inputTargetNeutral:- Array of two numbers [x,y] | Adapts the reference white point for an image. This filter is available in iOS 5 and above. |
| voltmx.filter.TONE_CURVE | filterName :- voltmx.filter.TONE_CURVE inputImage :- Image widget inputPoint0:- Array of two numbers [x,y](0.0 - 1.0) inputPoint1:- Array of two numbers [x,y](0.0 - 1.0) inputPoint2:- Array of two numbers [x,y](0.0 - 1.0) inputPoint3:- Array of two numbers [x,y](0.0 - 1.0) inputPoint4:- Array of two numbers [x,y](0.0 - 1.0) | Adjusts tone response of the R, G, and B channels of an image. This filter is available in iOS 5 and above. |
| voltmx.filter.VIGNETTE | filterName :- voltmx.filter.VIGNETTE inputImage :- Image widget inputRadius :- number inputInternsity:- number (0.0 - 1.0) | Reduces the brightness of an image at the periphery. This filter is available in iOS 5 and above. |
| voltmx.filter.VIGNETTE_EFFECT | filterName :- voltmx.filter.VIGNETTE_EFFECT inputImage :- Image widget inputCenter :- Array of two numbers [x,y] inputIntensity :- number (0.0 - 1.0) inputRadius:- number | Modifies the brightness of an image around the periphery of a specified region. This filter is available in iOS 7 and above. |
| voltmx.filter.WHITE_POINT_ADJUST | filterName :- voltmx.filter.WHITE_POINT_ADJUST inputImage :- Image widget inputColor:- Array of four numbers [0.0 - 1.0] | Adjusts the reference white point for an image and maps all colors in the source using the new reference. This filter is available in iOS 5 and above. |
| voltmx.filter.XOR_COMPOSITING | filterName:- voltmx.filter.XOR_COMPOSITING inputImage:- Image widget inputBackgroundImage:- Image widget | This filter is available from Android 3.0 and above. |
| voltmx.filter.ZOOM_BLUR | filterName :- voltmx.filter.ZOOM_BLUR inputImage :- Image widget inputCenter:- Array of two numbers [x,y] inputAmount:- number (default : 20.0) | This filter is available in iOS 9 and above. |
iOS Filters
The following filters are available on iOS devices.
| Filter Name | Filter Type | Description |
|---|---|---|
| CIAdditionCompositing | voltmx.filter.ADDITION_COMPOSITING | Adds color components to achieve a brightening effect. This filter is available in iOS 6 and above. |
| CIAffineTransform | voltmx.filter.AFFINE_TRANSFORM | This filter is available in iOS 5 and above. |
| CIBlendWithMask | voltmx.filter.BLEND_WITH_MASK | This filter is available in iOS 6 and above. |
| CIBlendWithAlphaMask | voltmx.filter.BLEND_WITH_ALPHA_MASK | This filter is available in iOS 7 and above. |
| CIBloom | voltmx.filter.BLOOM | This filter is available in iOS 6 and above. |
| CIBoxBlur | voltmx.filter.BOX_BLUR | This filter is available in iOS 9 and above. |
| CIColorBlendMode | voltmx.filter.COLOR_BLEND_MODE | Uses the luminance values of the background with the hue and saturation values of the source image. This filter is available in iOS 6 and above. |
| CIColorClamp | voltmx.filter.COLOR_CLAMP | This filter is available in iOS 7 and above. |
| CIColorControls | voltmx.filter.COLOR_CONTROLS | Adjusts saturation, brightness, and contrast values. This filter is available in iOS 5 and above. |
| CIColorCrossPolynomial | voltmx.filter.COLOR_CROSS_POLYNOMIAL | Modifies the pixel values in an image by applying a set of polynomial cross-products. This filter is available in iOS 7 and above. |
| CIColorDodgeBlendMode | voltmx.filter.COLOR_DODGE_BLEND_MODE | Brightens the background image samples to reflect the source image samples. This filter is available in iOS 6 and above. |
| CIColorInvert | voltmx.filter.COLOR_INVERSION | Inverts the colors in an image. This filter is available in iOS 6 and above. |
| CIColorMap | voltmx.filter.COLOR_MAP | Performs a nonlinear transformation of source color values using mapping values provided in a table. inputGradientImage is an nx1 or nxn gradient image used to describe a color ramp. This filter is available in iOS 6 and above. |
| CIColorMatrix | voltmx.filter.COLOR_MATRIX | Multiplies source color values and adds a bias factor to each color component. This filter is available in iOS 5 and above. |
| CIColorMonochrome | voltmx.filter.COLOR_MONOCHROME | Remaps colors so they fall within shades of a single color. This filter is available in iOS 6 and above. |
| CIColorPolynomial | voltmx.filter.COLOR_POLYNOMIAL | Modifies the pixel values in an image by applying a set of cubic polynomials. This filter is available in iOS 6 and above. |
| CIColorPosterize | voltmx.filter.COLOR_POSTERIZE | Remaps red, green, and blue color components to the number of brightness values you specify for each color component. This filter is available on iOS 6 and above. |
| CIComicEffect | voltmx.filter.COMIC_EFFECT | This filter is available on iOS 9 and above. |
| CIConvolution3X3 | voltmx.filter.CONVOLUTION_3X3 | This filter is available on iOS 7 and above. |
| CIConvolution5X5 | voltmx.filter.CONVOLUTION_5X5 | This filter is available on iOS 7 and above. |
| CIConvolution7X7 | voltmx.filter.CONVOLUTION_7X7 | This filter is available on iOS 9 and above. |
| CIConvolution9Horizontal | voltmx.filter.CONVOLUTION_9_HORIZONTAL | This filter is available on iOS 7 and above. |
| CIConvolution9Vertical | voltmx.filter.CONVOLUTION_9_VERTICAL | This filter is available on iOS 7 and above. |
| CICrystallize | voltmx.filter.CRYSTALLIZE | This filter is available on iOS 9 and above. |
| CIDarkenBlendMode | voltmx.filter.DARKEN_BLEND_MODE | Creates composite image samples by choosing the darker samples. This filter is available on iOS 6 and above. |
| CIDifferenceBlendMode | voltmx.filter.DIFFERENCE_BLEND_MODE | Subtracts the greater brightness values from lower. This filter is available on iOS 6 and above. |
| CIDiscBlur | voltmx.filter.DISC_BLUR | This filter is available on iOS 9 and above. |
| CIDivideBlendMode | voltmx.filter.DIVIDE_BLEND_MODE | Divides the backgroundImage color from source image color. This filter is available on iOS 8 and above. |
| CIEdges | voltmx.filter.EDGES | This filter is available on iOS 9 and above. |
| CIEdgeWork | voltmx.filter.EDGE_WORK | This filter is available on iOS 9 and above. |
| CIExclusionBlendMode | voltmx.filter.EXCLUSION_BLEND_MODE | Produces an effect similar to CIDifferenceBlend mode but has lower contrast. This filter is available on iOS 6 and above. |
| CIExposureAdjust | voltmx.filter.EXPOSURE_ADJUST | Adjusts the exposure setting for an image similar to the way you control exposure for a camera when you change the F-stop. This filter is available in iOS 5 and above. |
| CIFalseColor | voltmx.filter.FALSE_COLOR | Maps luminance to a color ramp of two colors. This filter is available in iOS 6 and above. |
| CIGammaAdjust | voltmx.filter.GAMMA_ADJUST | This filter is available in iOS 5 and above. |
| CIGaussianBlur | voltmx.filter.GAUSSIAN_BLUR | Spreads source pixels by an amount specified by a Gaussian distribution to increase the blurriness. This filter is available in iOS 6 and above. |
| CIGloom | voltmx.filter.GLOOM | This filter is available in iOS 6 and above. |
| CIHardLightBlendMode | voltmx.filter.HARD_LIGHT_BLEND_MODE | If input image sample is lighter than 50% grey then backgroundImage sample is lightened. If input image sample is greater that 50% grey then backgroundImage sample is darkened. This filter is available in iOS 6 and above. |
| CIHueAdjust | voltmx.filter.HUE_ADJUST | Changes the overall hue, or tint, of the source pixels. This filter is available in iOS 5 and above. |
| CIHueBlendMode | voltmx.filter.HUE_BLEND_MODE | Uses luminance and saturation values from backgroundImage with the hue values on input image. This filter is available in iOS 6 and above. |
| CILightenBlendMode | voltmx.filter.LIGHTEN_BLEND_MODE | The lighter samples are taken from both the images and will be used in resultant image. This filter is available in iOS 7 and above. |
| CILinearBurnBlendMode | voltmx.filter.LINEAR_BURN_BLEND_MODE | This filter is available in iOS 8 and above. |
| CILinearDodgeBlendMode | voltmx.filter.LINEAR_DODGE_BLEND_MODE | This filter is available in iOS 8 and above. |
| CILinearToSRGBToneCurve | voltmx.filter.LINEAR_TO_SRGB_TONE_CURVE | This filter is available in iOS 6 and above. |
| CILuminosityBlendMode | voltmx.filter.LUMINOSITY_BLEND_MODE | This filter is available in iOS 6 and above. |
| CIMaskToAlpha | voltmx.filter.MASK_TO_ALPHA | Converts a grayscale image to a white image that is masked by alpha. This filter is available in iOS 6 and above. |
| CIMaximumComponent | voltmx.filter.MAXIMUM_COMPONENT | Returns a grayscale image from max(r,g,b). This filter is available in iOS 6 and above. |
| CIMaximumCompositing | voltmx.filter.MAXIMUM_COMPOSITING | This filter is available in iOS 6 and above. |
| CIMedianFilter | voltmx.filter.MEDIAN_FILTER | This filter is available in iOS 9 and above. |
| CIMinimumComponent | voltmx.filter.MINIMUM_COMPONENT | Returns a grayscale image from min(r,g,b). This filter is available in iOS 6 and above. |
| CIMinimumCompositing | voltmx.filter.MINIMUM_COMPOSITING | This filter is available in iOS 6 and above. |
| CIMotionBlur | voltmx.filter.MOTION_BLUR | This filter is available in iOS 9 and above. |
| CIMultiplyBlendMode | voltmx.filter.MULTIPLY_BLEND_MODE | This filter is available in iOS 6 and above. |
| CIMultiplyCompositing | voltmx.filter.MULTIPLY_COMPOSITING | This filter is available in iOS 6 and above. |
| CINoiseReduction | voltmx.filter.NOISE_REDUCTION | This filter is available in iOS 9 and above. |
| CIOverlayBlendMode | voltmx.filter.OVERLAY_BLEND_MODE | This filter is available in iOS 6 and above. |
| CIPhotoEffectChrome | voltmx.filter.PHOTO_EFFECT_CHROME | Applies a preconfigured set of effects that imitate vintage photography film with exaggerated color.This filter is available in iOS 6 and above. |
| CIPhotoEffectFade | voltmx.filter.PHOTO_EFFECT_FADE | Applies a preconfigured set of effects that imitate vintage photography film with diminished color. This filter is available in iOS 7 and above. |
| CIPhotoEffectInstant | voltmx.filter.PHOTO_EFFECT_INSTANT | Applies a preconfigured set of effects that imitate vintage photography film with distorted colors. This filter is available in iOS 7 and above. |
| CIPhotoEffectMono | voltmx.filter.PHOTO_EFFECT_MONO | Applies a preconfigured set of effects that imitate black-and-white photography film with low contrast. This filter is available in iOS 7 and above. |
| CIPhotoEffectNoir | voltmx.filter.PHOTO_EFFECT_NOIR | Applies a preconfigured set of effects that imitate black-and-white photography film with exaggerated contrast. This filter is available in iOS 7 and above. |
| CIPhotoEffectProcess | voltmx.filter.PHOTO_EFFECT_PROCESS | Applies a preconfigured set of effects that imitate vintage photography film with emphasized cool colors. This filter is available in iOS 7 and above. |
| CIPhotoEffectTonal | voltmx.filter.PHOTO_EFFECT_TONAL | Applies a preconfigured set of effects that imitate black-and-white photography film without significantly altering contrast. This filter is available in iOS 7 and above. |
| CIPhotoEffectTransfer | voltmx.filter.PHOTO_EFFECT_TRANSFER | Applies a preconfigured set of effects that imitate vintage photography film with emphasized warm colors. This filter is available in iOS 7 and above. |
| CIPinLightBlendMode | voltmx.filter.PIN_LIGHT_BLEND_MODE | This filter is available in iOS 8 and above. |
| CISaturationBlendMode | voltmx.filter.SATURATION_BLEND_MODE | This filter is available in iOS 6 and above. |
| CIScreenBlendMode | voltmx.filter.SCREEN_BLEND_MODE | This filter is available in iOS 6 and above. |
| CISoftLightBlendMode | voltmx.filter.SOFT_LIGHT_BLEND_MODE | This filter is available in iOS 6 and above. |
| CISourceAtopCompositing | voltmx.filter.SOURCE_ATOP_COMPOSITING | This filter is available in iOS 6 and above. |
| CISourceInCompositing | voltmx.filter.SOURCE_IN_COMPOSITING | This filter is available in iOS 6 and above. |
| CISourceOutCompositing | voltmx.filter.SOURCE_OUT_COMPOSITING | This filter is available in iOS 6 and above. |
| CISRGBToneCurveToLinear | voltmx.filter.SRGB_TONE_CURVE_TO_LINEAR | Maps color intensity from the sRGB color space to a linear gamma curve. This filter is available in iOS 7 and above. |
| CISubtractBlendMode | voltmx.filter.SUBTRACT_BLEND_MODE | This filter is available in iOS 8 and above. |
| CITemperatureAndTint | voltmx.filter.TEMPERATURE_AND_TINT | Adapts the reference white point for an image. This filter is available in iOS 5 and above. |
| CIToneCurve | voltmx.filter.TONE_CURVE | Adjusts tone response of the R, G, and B channels of an image. This filter is available in iOS 5 and above. |
| CIVibrance | voltmx.filter.VIBRANCE | Adjusts the saturation of an image while keeping pleasing skin tones. This filter is available in iOS 5 and above. |
| CIVignette | voltmx.filter.VIGNETTE | Reduces the brightness of an image at the periphery. This filter is available in iOS 5 and above. |
| CIVignetteEffect | voltmx.filter.VIGNETTE_EFFECT | Modifies the brightness of an image around the periphery of a specified region. |
| CIZoomBlur | voltmx.filter.ZOOM_BLUR | This filter is available in iOS 9 and above. |
Windows Filter Constants
The following filters are available for Windows.
| Filter Type | Parameters | Description |
|---|---|---|
| voltmx.filter.ALPHATOGRAYSCALEFILTER | "filterName": voltmx.filter.ALPHATOGRAYSCALEFILTER, "inputImage": Image Object | Copies the alpha channel in the image to the color channels, resulting in a grayscale representation of the alpha channel. |
| voltmx.filter.AFFINE_TRANSFORM | “filterName” :voltmx.filter.ANTIQUEFILTER, “inputImage” : Image Object | Produces the look of an old color photo. |
| voltmx.filter.AUTOENHANCEFILTER | "filterName": voltmx.filter.AUTOENHANCEFILTER, "inputImage": Image Object, "isContrastAndBrightnessEnhancementEnabled": true, "isLocalBoostEnhancementEnabled": false | Automatically enhances white balance, brightness and contrast, and/or applies local boost to the image. isContrastAndBrightnessEnhancementEnabled [Boolean] - Enables or disables contrast and brightness enhancement. isLocalBoostEnhancementEnabled [Boolean] - Enables or disables local boost enhancement. |
| voltmx.filter.AUTOLEVELSFILTER | "filterName": voltmx.filter.AUTOLEVELSFILTER, "inputImage": Image Object | Balances the intensity level of the image, for example making dark images lighter and vice versa. |
| voltmx.filter.BLENDFILTER | "filterName": voltmx.filter.BLENDFILTER, "inputImage": Image Object,"blendImage": blendimg, "blendFunction": 5 | Blends an image onto the current image, with optional masking, positioning, scaling, and rotation. blendImage [Image] - The image to blend with source image. blendFunction [int] - The blend function to use. Possible values are: 0 - Normal "alpha" blending. 1 - Multiplicative blending. 2 Additive blending (alias of Add). 3 - Color replacement. 4 - "Colorburn" blending. 5 - "Colordodge" blending. 8 - "Screen" blending. 6 - "Overlay" blending. 7 - "Softlight" blending. 9 - "Hardlight" blending. 10 - Darken by taking the minimum. 11 - Lightness by taking the maximum. 12 - Hue replacement. 13 - "Exclusion" blending. 14 - Absolute difference. 15 - "Linearlight" blending. 16 - "Vividlight" blending. 17 - Signed difference. |
| voltmx.filter.BLURFILTER | "filterName": voltmx.filter.BLURFILTER, "inputImage": Image Object,"kernelSize": 25 | Blurs the image with a specific kernel size. kernelSize [int] - The kernel size in pixels. Range [1, 256]. Larger kernel size results in more blur. |
| voltmx.filter.BRIGHTNESSFILTER | "filterName": voltmx.filter.BRIGHTNESSFILTER, "inputImage": Image Object,"level": 0.4 | Adjusts the brightness in the image with a brightness level. level [double] - The brightness level. Range [-1.0, 1.0], where 0.0 results in no adjustment. |
| voltmx.filter.CARTOONFILTER | “filterName” : voltmx.filter.CARTOONFILTER, “inputImage” : Image Object,“distinctEdges”: false (Default value is true) | Transforms the image into a cartoon graphic style. |
| voltmx.filter.CHROMAKEYFILTER | "filterName": voltmx.filter.CHROMAKEYFILTER, "inputImage": Image Object,"chromacolor": "FF123400", "colorDistance": 0.7, "noiseSuppression": 0.4, "invertAlpha": false | Adds transparency to the pixels of a specific color. color [String] - The chroma key color that will be made transparent. The alpha component will be ignored. colorDistance [double] - Specifies how much variation around the chroma key color will be considered for transparency. If the color distance is small, only a small variation around the chroma key color will be considered for transparency. Range [0.0, 1.0]. noiseSuppression [double] - Specifies the noise suppression level. If the noise suppression level is low, only a small amount of noise will be suppressed. Range [0.0, 1.0]. invertAlpha [Boolean] - Controls how the alpha channel is generated. If false, full transparency in the resulting alpha channel is the value 0. If true, full transparency in the resulting alpha channel is the value 255. |
| voltmx.filter.COLORADJUSTFILTER | "filterName": voltmx.filter.COLORADJUSTFILTER, "inputImage": Image Object, "red": 0.4,"green": 0.7,"blue": -0.4 | Adjusts the RGB color composition of the image with specified channel adjustment values. Red [double] - Red channel adjustment. Range [-1.0, 1.0]. Green [double] - Green channel adjustment. Range [-1.0, 1.0]. Blue [double] - Blue channel adjustment. Range [-1.0, 1.0]. |
| voltmx.filter.COLORBOOSTFILTER | "filterName": voltmx.filter.COLORBOOSTFILTER, "inputImage": Image Object,"gain": 12.0 | Amplifies the colors of the image with the specified gain level. Gain [double] - The color boost gain level. Range [-1.0, 20.0]. Negative values reduce the colors. Recommended values are in the range [-1.0, 1.0]. |
| voltmx.filter.COLORSWAPFILTER | "filterName": voltmx.filter.COLORSWAPFILTER, "inputImage": Image Object,"sourceColor": "00FF0000"," swapColor": "FF00FF00", "colorDistance": 0.35, "isMonoColor": false, "swapLuminance": true | Creates ColorSwapEffect with specified settings and applies on the provided image. sourceColor [String] - Specifies the color that should be converted. The alpha-component is ignored. swapColor [String] - Specifies the color to which the source Color should be converted. The alpha-component is ignored. colorDistance [double] - Specifies the tolerance level of the effect. Range [0.0, 1.0]. isMonoColor [Boolean] - Specifies if the other colors should be converted to grayscale or be preserved. swapLuminance [Boolean] - Controls if the luminance should be included in the color swap. |
| voltmx.filter.COLORIZATIONFILTER | "filterName": voltmx.filter.COLORIZATIONFILTER, "inputImage": Image Object,"color": "FF123400","luminance": 1.5,"chrominance": -0.2 | Adjusts color tone and luminance/chrominance levels, adds a single color to an image. Color [string] - The reference color. The alpha-component is ignored. luminance [double] - The luminance adjustment. Range: [-1.0, 2.0]. chrominance [double] - The chrominance adjustment. Range: [-1.0, 2.0]. |
| voltmx.filter.CONTRASTFILTER | "filterName": voltmx.filter.CONTRASTFILTER, "inputImage": Image Object, "level": 0.4 | Adjusts the contrast in the image with a contrast level. level [double] - The contrast level. Range [-1.0, 1.0], where values below zero decrease contrast and above zero increase it. |
| voltmx.filter.CURVESFILTER | "filterName": voltmx.filter.CURVESFILTER, "inputImage": Image Object,"RedCurveIndex": 3,"GreenCurveIndex": 2,"BlueCurveIndex": 5 | Transforms colors in the image using a set of color curve index values. RedCurveIndex [int] - Color curve for the red channel. Range [0, 7] GreenCurveIndex [int] - Color curve for the green channel. Range [0, 7] BlueCurveIndex [int] - Color curve for the blue channel. Range [0, 7] |
| voltmx.filter.DESPECKLEFILTER | "filterName": voltmx.filter.DESPECKLEFILTER, "inputImage": Image Object,"despeckleLevel": 3 | Applies a despeckle effect, removing noise from the image with a specified level. despeckleLevel [int] - The despeckle level. (0-Minimum, 1-Low, 2-High, 3-Maximum) |
| voltmx.filter.EMBOSSFILTER | "filterName": voltmx.filter.EMBOSSFILTER, "inputImage": Image Object, "level": 0.35 | Creates EmbossEffect with specified level and applies on the provided image. Level [double] - The level of the emboss effect. Range: [0.0, 1.0]. |
| voltmx.filter.EXPOSUREFILTER | "filterName": voltmx.filter.EXPOSUREFILTER, "inputImage": Image Object,"exposureMode": 1,"gain": -0.7 | Adjust the brightness of an image with specified exposure mode and gain. exposureMode [int] - The exposure mode. (0 -Natural, 1- Gamma) gain [double] - The desired exposure level. Positive values will make the image brighter, negative values will make it darker. Range is [-1.0, 1.5], but for gamma mode the effect saturates at 1.0, which means that everything between [1.0, 1.5] will be interpreted as 1.0. Recommended range for both gamma and natural mode for normal usage is [-1.0, 1.0]. 0.0 equals no change of exposure. |
| voltmx.filter.FLIPFILTER | "filterName": voltmx.filter.FLIPFILTER, "inputImage": Image Object, "flipMode": 2 | Flips the image horizontally and/or vertically with a specified flip mode. flipMode [int] - The flip mode, around horizontal, vertical or both axes. (0 -None, 1-Vertical, 2-Horizontal, 3-Both) |
| voltmx.filter.FOGFILTER | "filterName": voltmx.filter.FOGFILTER, "inputImage": Image Object | Applies fog effect on the image. |
| voltmx.filter.FOUNDATIONFILTER | "filterName": voltmx.filter.FOUNDATIONFILTER, "inputImage": Image Object | Applies foundation effect on the image. |
| voltmx.filter.GAUSSIANNOISEFILTER | "filterName": voltmx.filter.GAUSSIANNOISEFILTER, "inputImage": Image Object,"level": 1.4 | Applies Gaussian noise to the image. level [double] - The amount of noise, given as the standard deviation of the Gaussian distribution. Must be >= 1.0. |
| voltmx.filter.GRAYSCALEFILTER | "filterName": voltmx.filter.GRAYSCALEFILTER, "inputImage": Image Object, "redWeight": 127.9, "greenWeight": -10.9,"blueWeight": 27.9,"constant": 86 | Converts the image to grayscale using a mixture of the color components. The gray shade is calculated by multiplying each color component of every pixel with the matching Weight and adding a constant: resultShade = redValue * redWeight + greenValue * greenWeight + blueValue * blueWeight + constant. The resulting shade is clamped to the range [0,1]. redWeight [double] - The red component of the equation for mixing weights. Range [-255.0, 255.0]. greenWeight [double] - The green component of the equation for mixing weights. Range [-255.0, 255.0]. blueWeight [double] - The blue component of the equation for mixing weights. Range [-255.0, 255.0]. Constant [double] The constant component of the equation for mixing weights. Range [-255.0, 255.0]. |
| voltmx.filter.GRAYSCALENEGATIVEFILTER | "filterName": voltmx.filter.GRAYSCALENEGATIVEFILTER, "inputImage": Image Object | Converts the image to a grayscale negative. |
| voltmx.filter.HDRFILTER | "filterName": voltmx.filter.HDRFILTER, "inputImage": Image Object,"gamma": 1.9,"noiseSuppression": 0.9,"saturation": 2.9,"strength": 0.2 | Applies local tone mapping to a single image to achieve an HDR-like effect. gamma [double] - Controls global contrast enhancement using a power law. Values lower than 1.0 makes the image more white and values above 1.0 makes it more black. Recommended range is between 0.6 and 1.0. gamma must be > 0. noiseSuppression [double] - Controls supression of noise amplification, value should rise with the noisiness of the input image combined with the strength applied. Recommended value is between 0.1 and 0.3. Range [0.0, 1.0]. saturation [double] - Controls color saturation using a power law. Values lower than 1.0 will decrease the saturation, and values above 1.0 will increase the saturation of the image. Recommended range is between 0.4 and 0.8. saturation must be > 0. Strength [double] - Controls strength of local contrast enhancement. The higher the value, the stronger effect. Recommended range is between 0.1 and 0.30. Having a high value may result in dark noisy images. Range [0.0, 1.0]. |
| voltmx.filter.HUESATURATIONFILTER | "filterName": voltmx.filter.HUESATURATIONFILTER, "inputImage": Image Object,"hue": -0.5,"saturation": 0.2 | Adjusts the hue and saturation of the image with specified hue and saturation. hue [double] - Hue adjustment level. Range [-1.0, 1.0] where 0 implies no adjustment. saturation [double] - Saturation adjustment level. Range [-1.0, 1.0] where 0 implies no adjustment. |
| voltmx.filter.LEVELSFILTER | "filterName": voltmx.filter.LEVELSFILTER, "inputImage": Image Object,"white": 0.7,"gray": 0.2,"black": 0.5 | Adjusts levels in the current image. white The position of the white saturating point. Range [0.0, 1.0]. gray - The relative position of the middle gray point. Range [0.0, 1.0], where 0.0 is at the bright saturating point and 1.0 is at the dark saturating point. black - The position of the black saturating point. Range [0.0, 1.0]. The value of black should be smaller than, or equal to the value of white. |
| voltmx.filter.LOCALBOOSTFILTER | "filterName": voltmx.filter.LOCALBOOSTFILTER, "inputImage": Image Object,"gamma": 3,"darkContrast": 0.9,"lightContrast": 0.7,"sensitivityLevel": 0.2 | Manually boost and enhance images with unequal illumination. gamma [double] - Gamma correction for the dark part of the image. Range [0.1, 5.0]. darkContrast [double] - Contrast amplification of the dark part. Range [0.5, 1.0]. lightContrast [double] - Contrast amplification of the light part. Range [0.5, 1.0]. sensitivityLevel [double] - Specifies how much of the processed image will be blended into the original image. Range: [0.0, 1.0]. |
| voltmx.filter.LOCALBOOSTAUTOMATICFILTER | "filterName": voltmx.filter.LOCALBOOSTAUTOMATICFILTER, "inputImage": Image Object,"level": 10 | Manually boost and enhance images with unequal illumination with the specified level. level [int] - Intensity of the effect. Range [0, 14]. |
| voltmx.filter.LOMOFILTER | "filterName": voltmx.filter.LOMOFILTER, "inputImage":- Image Object,"brightness": 0.7, "saturation": 0.4, "vignetting": 1, "style": 4 | Creates LomoEffect with specified settings and applies on the provided image. Brightness [double] - The brightness adjustment. Range [0.0, 1.0], where 0.0 gives a bright image and 1.0 gives a dark image. Saturation [double] - The color saturation adjustment. Range [0.0, 1.0], where 0.0 implies no saturation. Vignetting [int] - The vignetting level. Possible values are: 0 - Low 1 - High 2 - Medium Style [int] - The color style. Possible values are: 0 - Neutral 1 - Red 2 - Green 3 - Blue 4 - Yellow |
| voltmx.filter.MAGICPENFILTER | "filterName": voltmx.filter.MAGICPENFILTER, "inputImage": Image Object | Applies a mix of edge distinction and color manipulation to the image. |
| voltmx.filter.MILKYFILTER | "filterName": voltmx.filter.MILKYFILTER, "inputImage": Image Object | Applies a milky surface to the image. |
| voltmx.filter.MIRRORFILTER | "filterName": voltmx.filter.MIRRORFILTER, "inputImage": Image Object | Mirrors the left half of the image onto the right half. |
| voltmx.filter.MONOCOLORFILTER | "filterName": voltmx.filter.MONOCOLORFILTER, "inputImage": Image Object, "preserveColor": "FF00FF00", "colorDistance":0.7 | Creates and initializes a new MonoColorEffect with specified settings for the color to be preserved. preserveColor [String] - The color that will be preserved. colorDistance [double] - Specifies the tolerance level of the effect. Range [0.0, 1.0]. |
| voltmx.filter.MOONLIGHTFILTER | "filterName": voltmx.filter.MOONLIGHTFILTER, "inputImage": Image Object, "clock": 22 | Creates a MoonlightEffect specifying the time of day and applies to the image. Clock [int] - Time of night in clock time [0, 23]. The filter has effect only at night time, between 17 and 7. The default value is 0. |
| voltmx.filter.NEGATIVEFILTER | "filterName": voltmx.filter.NEGATIVEFILTER, "inputImage": Image Object | Converts the image to a negative. |
| voltmx.filter.NOISEFILTER | "filterName": voltmx.filter.NOISEFILTER, "inputImage": Image Object,"level": 2 | Applies noise to the image with specified noise level. level [int] - The amount of noise. (0 -Minimum, 1-Medium, 2-Maximum) |
| voltmx.filter.OILYFILTER | "filterName": voltmx.filter.OILYFILTER, "inputImage": Image Object,"oilBrushSize ": 2 | Creates OilyEffect with the specified OilinessLevel and applies to the image. oilBrushSize [int] - Specifies the strength of the effect, where higher oiliness results in higher distortion of the source image. |
| voltmx.filter.PAINTFILTER | "filterName": voltmx.filter.PAINTFILTER, "inputImage": Image Object, "level ": 4 | Creates PaintEffect with the specified level and applies to the image. Level [int] - Paint effect level. Range [1, 4]. |
| voltmx.filter.POSTERIZEFILTER | "filterName": voltmx.filter.POSTERIZEFILTER, "inputImage": Image Object, "colorComponentValueCount": 12 | Applies a painting-like effect to the image. colorComponentValueCount [int] - The number of allowed values for each color component. Range [2, 16]. |
| voltmx.filter.ROTATIONFILTER | "filterName": voltmx.filter.ROTATIONFILTER,"inputImage": Image Object,"rotationAngle": 135.0 | Rotates the image around its center in a clock-wise direction with a specified angle. rotationAngle [double] - The rotation angle in degrees. |
| voltmx.filter.SEPIAFILTER | "filterName": voltmx.filter.SEPIAFILTER, "inputImage": Image Object | Applies a sepia tone to the image. |
| voltmx.filter.SHARPNESSFILTER | "filterName": voltmx.filter.SHARPNESSFILTER, "inputImage": Image Object,"level": 0.7 | Enhances the sharpness of the image, allowing for precise settings. level [double] - Image sharpness level. Level must be greater than 0. Recommended range is [0, 1] however values greater than 1.0 are supported. |
| voltmx.filter.SKETCHFILTER | "filterName": voltmx.filter.SKETCHFILTER, "inputImage": Image Object,"sketchMode": 0 | Applies a sketch effect to the image with the specified SketchMode. sketchMode [int] - The sketch mode. Possible values are: 0 - Gray-Sketch in grayscale 1 - Color-Sketch in color |
| voltmx.filter.SOLARIZEFILTER | "filterName": voltmx.filter.SOLARIZEFILTER, "inputImage": Image Object, " threshold": 0.7 | Applies a solarize effect to the image with the specified threshold. Threshold [double] - The threshold level of the solarize effect. Range [0.0, 1.0]. |
| voltmx.filter.STAMPFILTER | "filterName": voltmx.filter.STAMPFILTER, "inputImage": Image Object, "smoothness": 2, "threshold": 0.6 | Applies a stamp-like effect, resulting in a black and white image with specified smoothness and threshold values. Smoothness [int] - The smoothness level. Range [0, 6]. Threshold [double] - The threshold level. Range [0.0, 1.0]. |
| voltmx.filter.TEMPERATUREANDTINTFILTER | "filterName": voltmx.filter.TEMPERATUREANDTINTFILTER, "inputImage": Image Object,"temperature": -0.4,"tint": 0.7 | Adjusts the color temperature and tint of the image using provided temperature and tint. temperature [double] - Color temperature adjustment. Range [-1.0, 1.0] where 0 implies an unmodified color temperature. tint [double] - Color tint adjustment. Range [-1.0, 1.0] where 0 implies an unmodified color tint. |
| voltmx.filter.VIGNETTINGFILTER | "filterName": voltmx.filter.VIGNETTINGFILTER, "inputImage": Image Object,"vignettingColor": "00FFFF00", "transitionSize": 12 | Applies vignetting effect to the image with specified transition size and vignetting color. transitionSize [double] - The size of the transition region as a fraction of the radius. Range [0.0, 15.0]. Color [String] - The color to use for the vignetting effect. |
| voltmx.filter.WATERCOLORFILTER | "filterName": voltmx.filter.WATERCOLORFILTER,"inputImage": Image Object, "lightIntensity": 0.2, "colorIntensity": 0.7 | Applies a watercolor effect to the image with specified intensities. lightIntensity [double] - The light intensity. Range [0.0, 1.0]. colorIntensity [double] - The color intensity. Range [0.0, 1.0]. |
| voltmx.filter.WARPFILTER | "filterName": voltmx.filter.WARPFILTER,"inputImage": Image Object, "wrapmode": 12, "wraplevel": 0.7 | Applies a warp effect to an image with specified warp effect and level. wrapmode [int] - The warp mode to apply. Possible values are: 0 - Upnose 1-Twister 2 - SmallNose 3 - WideSmile 4 - Grit 5 - BigFace 6 - Professor 7 - Alien 8 - BigNose 9 - AlienHybrid 10 - Gobbler 11 - Square 12 - Sharpchin 13 - LongFaced 14 - HappyFool 15 - Insect. wraplevel [double] - Amount of effect applied. Range [0.0, 1.0], where 0.0 means no effect and 1.0 means full effect. Default is 0.5. |
| voltmx.filter.WHITEBALANCEFILTER | "filterName": voltmx.filter.WHITEBALANCEFILTER, "inputImage": Image Object,"whitePointCalculationMode": 2 | Adjusts the white balance in the image with specified white point calculation mode. whitePointCalculationMode [int] - Possible values are: 0 - Uses the mean value of the 256-bin distribution. 1 - Uses the estimated mean gray for the color correction. 2 - Uses the estimated maximum intensity color. 3 - Uses a specified white reference color. |
| voltmx.filter.WHITEBOARDENHANCEMENTFILTER | "filterName": voltmx.filter.WHITEBOARDENHANCEMENTFILTER, "inputImage": Image Object,"whiteboardEnhancementMode": 0 | Enhances text and drawings in an image of a whiteboard with a specified mode. whiteboardEnhancementMode [int] - Possible values are: 0 - Enhances the contrast. 1 - Preserve colors better. |