CIFilter Class

Reference

Definition

Namespace:: CoreImage

Assembly:: Xamarin.iOS.dll

Assembly:: Xamarin.Mac.dll

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

type CIFilter = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding

Inheritance: Object

NSObject
CIFilter

Derived: CoreImage.CIAccordionFoldTransition

CoreImage.CIAffineFilter

CoreImage.CIAreaAverage

CoreImage.CIAreaHistogram

CoreImage.CIBarcodeGenerator

More…

Attributes: RegisterAttribute

Implements: INSCoding INSCopying INSSecureCoding INativeObject IDisposable

Remarks

On iOS 7.0, the following are the built-in filters:

Compositing Filters:

Affine Filters (CIAffineFilter):

Blend Filters (CIBlendFilter):

Compositing Filters (CICompositingFilter):

Convolution Filters (CIConvolutionCore):

Distortion Filters (CIDistortionFilter):

Photo Effects (CIPhotoEffect):

Transition Filters (CITransitionFilter):

Specialized Filters:

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

CIFilter()	Creates a new CIFilter with default values.
CIFilter(IntPtr)	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

Attributes	Configurable attributes of the filter.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
Image	Gets or sets an image to filter.
InputKeys	Gets an array that contains the names of the input keys for the filter.
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
Item[NSString]	Gets the value that is identified by `key`.
Name	Gets the filter name.
OutputImage	Gets the image that results from applying the filter to Image.
OutputKeys	Gets an array that contains the names of the output keys for the filter.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
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

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (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()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (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(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (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 `pixelBuffer` by applying the settings in `options`.
CreateRawFilter(CVPixelBuffer, NSDictionary, NSDictionary)	Creates a RAW processing filter for converting the data in `pixelBuffer` by applying the settings in `options`.
CreateRawFilter(NSData, CIRawFilterOptions)	Creates a CIFilter that applies the `options` to the RAW data in `data`.
CreateRawFilter(NSData, NSDictionary)	Creates a CIFilter that applies the `options` to the RAW data in `data`.
CreateRawFilter(NSUrl, CIRawFilterOptions)	Creates a CIFilter that applies the `options` to the RAW data read from `url`.
CreateRawFilter(NSUrl, NSDictionary)	Creates a CIFilter that applies the `options` to the RAW data read from `url`.
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (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)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
EncodeTo(NSCoder)	Encodes the state of the object on the provided encoder
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(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 `categories`.
FilterNamesInCategory(String)	Returns an array of strings that specifies the filters taht the system provides for the specified `category`.
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[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetFilter(String, NSDictionary)	Returns a CIFilter that corresponds to `name` and is initialized with the parameters that are named in `inputParameters`.
GetFilterUIView(NSDictionary, NSArray)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously 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()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (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, NSObject, NSDictionary)
RegisterFilterName(String, NSObject, NSDictionary<NSString,NSObject>)	Registers the filter generated by the `constructorObject` factory.
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified 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.
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to

Share via