Filter Parameter Keys

Keys for input parameters to filters.

Overview

These keys represent some of the most commonly used input parameters. A filter can use other kinds of input parameters.

Topics

Constants

kCIOutputImageKey

A key for the CIImage object produced by a filter.

kCIInputBackgroundImageKey

A key for the CIImage object to use as a background image.

kCIInputImageKey

A key for the CIImage object to use as an input image. For filters that also use a background image, this key refers to the foreground image.

kCIInputTimeKey

A key for z scalar value (NSNumber) that specifies a time.

kCIInputDepthImageKey

A key for an image with depth values.

kCIInputDisparityImageKey

A key for an image with disparity values.

kCIInputTransformKey

A key for an NSAffineTransform object that specifies a transformation to apply.

kCIInputScaleKey

A key for a scalar value (NSNumber) that specifies the amount of the effect.

kCIInputAspectRatioKey

A key for a scalar value (NSNumber) that specifies a ratio.

kCIInputCenterKey

A key for a CIVector object that specifies the center of the area, as x and y- coordinates, to be filtered.

kCIInputRadiusKey

A key for a scalar value (NSNumber) that specifies that specifies the distance from the center of an effect.

kCIInputAngleKey

A key for a scalar value (NSNumber) that specifies an angle.

kCIInputRefractionKey

A key for a scalar value (NSNumber) that specifies the index of refraction of the material (such as glass) used in the effect.

kCIInputWidthKey

A key for a scalar value (NSNumber) that specifies the width of the effect.

kCIInputSharpnessKey

A key for a scalar value (NSNumber) that specifies the amount of sharpening to apply.

kCIInputIntensityKey

A key for a scalar value (NSNumber) that specifies an intensity value.

kCIInputEVKey

A key for a scalar value (NSNumber) that specifies how many F-stops brighter or darker the image should be.

kCIInputSaturationKey

A key for a scalar value (NSNumber) that specifies the amount to adjust the saturation.

kCIInputColorKey

A key for a CIColor object that specifies a color value.

kCIInputBrightnessKey

A key for a scalar value (NSNumber) that specifies a brightness level.

kCIInputContrastKey

A key for a scalar value (NSNumber) that specifies a contrast level.

kCIInputWeightsKey

A key for a CIVector object that describes a weight matrix for use with a convolution filter.

kCIInputGradientImageKey

A key for a CIImage object that specifies an environment map with alpha. Typically, this image contains highlight and shadow.

kCIInputMaskImageKey

A key for a CIImage object to use as a mask.

kCIInputShadingImageKey

A key for a CIImage object that specifies an environment map with alpha values. Typically this image contains highlight and shadow.

kCIInputTargetImageKey

A key for a CIImage object that is the target image for a transition.

kCIInputExtentKey

A key for a CIVector object that specifies a rectangle that defines the extent of the effect.

kCIInputVersionKey

A key for an NSNumber object that specifies a version number.

kCIInputBaselineExposureKey

A key for an NSNumber object containing a float that expresses the amount of baseline exposure applied to an image.

kCIInputDisableGamutMapKey

A key for an NSNumber object containing a Boolean value that determines whether or not to disable gamut mapping.

kCIInputMoireAmountKey

A key for an NSNumber object containing a double that expresses the amount of moiré reduction applied to an image.