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. |