CIFilter Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
CoreImage image filter.
[Foundation.Register("CIFilter", true)]
public class CIFilter : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable[<Foundation.Register("CIFilter", true)>]
type CIFilter = class
inherit NSObject
interface INSCoding
interface INativeObject
interface IDisposable
interface INSCopying
interface INSSecureCoding- Inheritance
- Derived
- Attributes
- Implements
Remarks
On iOS 7.0, the following are the built-in filters:
Compositing Filters:
- CIAdditionCompositing:
- CIMaximumCompositing:
- CIMinimumCompositing:
- CIMultiplyCompositing:
- CISourceAtopCompositing:
- CISourceInCompositing:
- CISourceOutCompositing:
- CISourceOverCompositing:
Affine Filters (CIAffineFilter):
Blend Filters (CIBlendFilter):
- CIBlendWithMask:
- CIColorBlendMode:
- CIColorBurnBlendMode:
- CIColorDodgeBlendMode:
- CIDarkenBlendMode:
- CIDifferenceBlendMode:
- CIExclusionBlendMode:
- CIHardLightBlendMode:
- CIHueBlendMode:
- CILightenBlendMode:
- CILuminosityBlendMode:
- CIMultiplyBlendMode:
- CIOverlayBlendMode:
- CISaturationBlendMode:
- CIScreenBlendMode:
- CISoftLightBlendMode:
Compositing Filters (CICompositingFilter):
- CIAdditionCompositing:
- CIMaximumCompositing:
- CIMinimumCompositing:
- CIMultiplyCompositing:
- CISourceAtopCompositing:
- CISourceInCompositing:
- CISourceOutCompositing:
- CISourceOverCompositing:
Convolution Filters (CIConvolutionCore):
Distortion Filters (CIDistortionFilter):
- CIBumpDistortion:
- CIBumpDistortionLinear:
- CICircleSplashDistortion:
- CIHoleDistortion:
- CIPinchDistortion:
- CITwirlDistortion:
- CIVortexDistortion:
Photo Effects (CIPhotoEffect):
- CIPhotoEffectChrome:
- CIPhotoEffectFade:
- CIPhotoEffectInstant:
- CIPhotoEffectMono:
- CIPhotoEffectNoir:
- CIPhotoEffectProcess:
- CIPhotoEffectTonal:
- CIPhotoEffectTransfer:
Transition Filters (CITransitionFilter):
- CIBarsSwipeTransition:
- CICopyMachineTransition:
- CIDisintegrateWithMaskTransition:
- CIDissolveTransition:
- CIFlashTransition:
- CIModTransition:
- CISwipeTransition:
Specialized Filters:
- CIBloom:
- CICheckerboardGenerator:
- CIColorClamp:
- CIColorControls:
- CIColorCrossPolynomial:
- CIColorCube:
- CIColorInvert:
- CIColorMap:
- CIColorMatrix:
- CIColorMonochrome:
- CIColorPosterize:
- CIConstantColorGenerator:
- CICrop:
- CIExposureAdjust:
- CIFaceBalance:
- CIFalseColor:
- CIGammaAdjust:
- CIGaussianBlur:
- CIGaussianGradient:
- CIGloom:
- CIHighlightShadowAdjust:
- CIHueAdjust:
- CILanczosScaleTransform:
- CILightTunnel:
- CILinearGradient:
- CILinearToSRGBToneCurve:
- CIMaskToAlpha:
- CIMaximumComponent:
- CIMinimumComponent:
- CIPerspectiveTile:
- CIPerspectiveTransform:
- CIPixellate:
- CIQRCodeGenerator:
- CIRadialGradient:
- CIRandomGenerator:
- CIScreenFilter:
- CISepiaTone:
- CISharpenLuminance:
- CISRGBToneCurveToLinear:
- CIStarShineGenerator:
- CIStraightenFilter:
- CIStripesGenerator:
- CITemperatureAndTint:
- CITileFilter:
- CIToneCurve:
- CITriangleKaleidoscope:
- CIUnsharpMask:
- CIVibrance:
- CIVignette:
- CIVignetteEffect:
- CIWhitePointAdjust:
To create a filter of the specified type, instantiate an instance of one of the above types, assign values to their properties and extract the result by using the OutputImage property.
var sepiaFilter = new CISepiaTone () {
Image = mySourceImage,
Intensity = 0.8f
};
You can chain your filters as well:
var sepiaFilter = new CISepiaTone () {
Image = mySourceImage,
Intensity = .8f
};
var invert = new CIColorInvert () {
Image = sepia.OutputImage
};
Constructors
| Name | Description |
|---|---|
| CIFilter() |
Creates a new CIFilter with default values. |
| CIFilter(NativeHandle) |
A constructor used when creating managed representations of unmanaged objects. Called by the runtime. |
| CIFilter(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| CIFilter(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
Properties
| Name | Description |
|---|---|
| AccessibilityAttributedUserInputLabels | (Inherited from NSObject) |
| AccessibilityRespondsToUserInteraction | (Inherited from NSObject) |
| AccessibilityTextualContext | (Inherited from NSObject) |
| AccessibilityUserInputLabels | (Inherited from NSObject) |
| Attributes |
Configurable attributes of the filter. |
| BlurredRectangleGeneratorFilter | |
| CannyEdgeDetectorFilter | |
| Class | (Inherited from NSObject) |
| ClassHandle |
The Objective-C class handle for this class. |
| DebugDescription | (Inherited from NSObject) |
| Description | (Inherited from NSObject) |
| ExposedBindings | (Inherited from NSObject) |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| InputKeys |
Gets an array that contains the names of the input keys for the filter. |
| IsDirectBinding |
Gets or sets a value indicating whether this instance uses direct Objective-C binding. (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| Item[NSString] |
Gets the value that is identified by |
| Name |
Gets the filter name. |
| OutputImage |
Gets the image that results from applying the filter. |
| OutputKeys |
Gets an array that contains the names of the output keys for the filter. |
| RetainCount | (Inherited from NSObject) |
| RoundedRectangleStrokeGeneratorFilter | |
| Self | (Inherited from NSObject) |
| SobelGradientsFilter | |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| Zone | (Inherited from NSObject) |
Methods
| Name | Description |
|---|---|
| AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) | (Inherited from NSObject) |
| AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) | (Inherited from NSObject) |
| AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| Apply(CIKernel, NSArray, NSDictionary) | |
| AwakeFromNib() | (Inherited from NSObject) |
| BeginInvokeOnMainThread(Action) |
Invokes the specified action asynchronously on the main UI thread. (Inherited from NSObject) |
| BeginInvokeOnMainThread(Selector, NSObject) |
Invokes asynchronously the specified code on the main UI thread. (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSBindingOptions) | (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSDictionary) | (Inherited from NSObject) |
| CategoryLocalizedName(String) |
Returns the localized name for the specified category. |
| CommitEditing() | (Inherited from NSObject) |
| CommitEditing(NSObject, Selector, IntPtr) | (Inherited from NSObject) |
| ConformsToProtocol(NativeHandle) | (Inherited from NSObject) |
| Copy() | (Inherited from NSObject) |
| Copy(NSZone) |
Performs a copy of the underlying Objective-C object. |
| CreateRawFilter(CVPixelBuffer, NSDictionary, CIRawFilterOptions) |
Creates a RAW processing filter for converting the data in |
| CreateRawFilter(CVPixelBuffer, NSDictionary, NSDictionary) |
Creates a RAW processing filter for converting the data in |
| CreateRawFilter(NSData, CIRawFilterOptions) |
Creates a CIFilter that applies the |
| CreateRawFilter(NSData, NSDictionary) |
Creates a CIFilter that applies the |
| CreateRawFilter(NSUrl, CIRawFilterOptions) |
Creates a CIFilter that applies the |
| CreateRawFilter(NSUrl, NSDictionary) |
Creates a CIFilter that applies the |
| DangerousAutorelease() |
Calls the 'autorelease' selector on this object. (Inherited from NSObject) |
| DangerousRelease() |
Calls the 'release' selector on this object. (Inherited from NSObject) |
| DangerousRetain() |
Calls the 'retain' selector on this object. (Inherited from NSObject) |
| DidChange(NSKeyValueChange, NSIndexSet, NSString) | (Inherited from NSObject) |
| DidChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| DidChangeValue(String) | (Inherited from NSObject) |
| Dispose() |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| Dispose(Boolean) |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| DoesNotRecognizeSelector(Selector) | (Inherited from NSObject) |
| EncodeTo(NSCoder) |
Encodes the state of the object using the provided encoder. |
| Equals(NSObject) |
Determines whether the specified NSObject is equal to the current NSObject. (Inherited from NSObject) |
| Equals(Object) |
Determines whether the specified object is equal to the current NSObject. (Inherited from NSObject) |
| FilterLocalizedDescription(String) |
Gets the localized description for the specified filter name. |
| FilterLocalizedName(String) |
Gets the localized name for the specified filter name. |
| FilterLocalizedReferenceDocumentation(String) |
Gets the localized reference documentation for the specified filter name. |
| FilterNamesInCategories(String[]) |
Returns an array of strings that specifies the filters taht the system provides for the specified |
| FilterNamesInCategory(String) |
Returns an array of strings that specifies the filters taht the system provides for the specified |
| FromName(String) |
Returns a CIFilter for the specific effect. |
| FromSerializedXMP(NSData, CGRect, NSError) | |
| GetBindingInfo(NSString) | (Inherited from NSObject) |
| GetBindingOptionDescriptions(NSString) | (Inherited from NSObject) |
| GetBindingValueClass(NSString) | (Inherited from NSObject) |
| GetDictionaryOfValuesFromKeys(NSString[]) | (Inherited from NSObject) |
| GetFilter(String, NSDictionary) |
Returns a CIFilter that corresponds to |
| GetFilterUIView(NSDictionary, NSArray) | |
| GetHashCode() |
Generates a hash code for the current instance. (Inherited from NSObject) |
| GetMethodForSelector(Selector) | (Inherited from NSObject) |
| GetNativeHash() | (Inherited from NSObject) |
| Init() |
Initializes the object by calling the Objective-C |
| InitializeHandle(NativeHandle, String) | (Inherited from NSObject) |
| InitializeHandle(NativeHandle) | (Inherited from NSObject) |
| Invoke(Action, Double) |
Invokes the specified action after the specified delay. (Inherited from NSObject) |
| Invoke(Action, TimeSpan) |
Invokes the specified action after the specified delay. (Inherited from NSObject) |
| InvokeOnMainThread(Action) |
Invokes the specified action synchronously on the main UI thread. (Inherited from NSObject) |
| InvokeOnMainThread(Selector, NSObject) |
Invokes synchronously the specified code on the main UI thread. (Inherited from NSObject) |
| IsEqual(NSObject) | (Inherited from NSObject) |
| IsKindOfClass(Class) | (Inherited from NSObject) |
| IsMemberOfClass(Class) | (Inherited from NSObject) |
| MarkDirty() |
Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject) |
| MutableCopy() | (Inherited from NSObject) |
| ObjectDidEndEditing(NSObject) | (Inherited from NSObject) |
| ObserveValue(NSString, NSObject, NSDictionary, IntPtr) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, Double, NSString[]) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, Double) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean) | (Inherited from NSObject) |
| PerformSelector(Selector) | (Inherited from NSObject) |
| PrepareForInterfaceBuilder() | (Inherited from NSObject) |
| RegisterFilterName(String, ICIFilterConstructor, NSDictionary<NSString,NSObject>) |
Registers the filter generated by the |
| RemoveObserver(NSObject, NSString, IntPtr) | (Inherited from NSObject) |
| RemoveObserver(NSObject, NSString) | (Inherited from NSObject) |
| RemoveObserver(NSObject, String, IntPtr) | (Inherited from NSObject) |
| RemoveObserver(NSObject, String) | (Inherited from NSObject) |
| RespondsToSelector(Selector) | (Inherited from NSObject) |
| SerializedXMP(CIFilter[], CGRect) |
Returns a list of filters for an extent as serialized XMP data. |
| SetDefaults() |
Sets all input values to their defaults. |
| SetNilValueForKey(NSString) | (Inherited from NSObject) |
| SetValueForKey(NSObject, NSString) | (Inherited from NSObject) |
| SetValueForKeyPath(NativeHandle, NSString) |
Sets the value for the property identified by a given key path to a given value. (Inherited from NSObject) |
| SetValueForKeyPath(NSObject, NSString) | (Inherited from NSObject) |
| SetValueForUndefinedKey(NSObject, NSString) | (Inherited from NSObject) |
| SetValuesForKeysWithDictionary(NSDictionary) | (Inherited from NSObject) |
| ToString() |
Returns a string representation of the value of the current instance. (Inherited from NSObject) |
| Unbind(NSString) | (Inherited from NSObject) |
| ValueForKey(NSString) | (Inherited from NSObject) |
| ValueForKeyPath(NSString) | (Inherited from NSObject) |
| ValueForUndefinedKey(NSString) | (Inherited from NSObject) |
| WillChange(NSKeyValueChange, NSIndexSet, NSString) | (Inherited from NSObject) |
| WillChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| WillChangeValue(String) | (Inherited from NSObject) |