CIImage 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.
Represents a set of instructions to create an image for use by CoreImage.
[Foundation.Register("CIImage", true)]
public class CIImage : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposabletype CIImage = class
inherit NSObject
interface INSCoding
interface INativeObject
interface IDisposable
interface INSCopying
interface INSSecureCoding- Inheritance
- Attributes
- Implements
Remarks
Unlike CoreGraphics images (CGImage) that are objects that hold the actual image data to be processed, CIImages represents a set of instructions to obtain an image. These recipes are used during the CoreImage filtering, analysis or rendering pipeline to actually create the bitmap representation.
CIImages are either the result of loading an image from disk, an NSData array, a CoreVideo buffer a CoreGraphics image, or the result of processing an image pipeline by CoreImage.
CIImages for example are used when chaining various filters (CIFilter) together and only their abstract representation is passed between the output of one filter and the input to another one. The image might not even reside in the main memory, it could reside entirely on the GPU space as an intermediate step between two filters.
Auto Enhancement Filters
The GetAutoAdjustmentFilters(CIAutoAdjustmentFilterOptions) method can be used to obtain a list of CIImage filters that can be used to correct various problems found in photos.
These typically include:
- Adjusts the shadow details (using the CIHighlightShadowAdjust filter). :
- Adjusts the image contrast (using the CIToneCurve filter). :
- Adjusts the image saturation (using the CIVibrance filter). :
- Adjusts the face color balance, adjust the tone of the skin (using the CIFaceBalance filter). :
- Red Eye Correction (using the T:CoreImage.CIRedEyeCorrection filter). :
You can configure which kind of filters you want to get or configure by setting the properties of an CIAutoAdjustmentFilterOptions instance and then calling the appropriate method.
void PrepareFixes (CIImage img)
{
var opt = new CIAutoAdjustmentFilterOptions () {
RedEye = true,
AutoAdjustCrop = true
};
foreach (var filter in img.GetAutoAdjustmentFilters (opt)) {
filter.Image = img;
img = filter.OutputImage;
}
}
Constructors
| CIImage(AVDepthData, NSDictionary) | |
| CIImage(AVDepthData) | |
| CIImage(AVPortraitEffectsMatte, NSDictionary) | |
| CIImage(AVPortraitEffectsMatte) | |
| CIImage(CGImage, CIImageInitializationOptionsWithMetadata) |
Initializes a CoreImage Image from a CoreGraphics bitmap representation |
| CIImage(CGImage, NSDictionary) |
Initializes a CoreImage Image from a CoreGraphics bitmap representation |
| CIImage(CGImage) |
Initializes a CoreImage Image from a CoreGraphics bitmap representation |
| CIImage(CGLayer, CIImageInitializationOptions) | |
| CIImage(CGLayer, NSDictionary) | |
| CIImage(CGLayer) | |
| CIImage(CIColor) |
Creates an image with infinite dimensions that is filled with the specified color. |
| CIImage(CVImageBuffer, CIImageInitializationOptions) |
Initializes a CoreImage image from the contents of the specified CoreVideo image buffer. |
| CIImage(CVImageBuffer, NSDictionary) | |
| CIImage(CVImageBuffer, NSDictionary<NSString,NSObject>) |
Constructs a CIImage using the options in |
| CIImage(CVImageBuffer) |
Initializes a CoreImage image from the contents of the specified CoreVideo image buffer. |
| CIImage(CVPixelBuffer, CIImageInitializationOptions) |
Constructs a CIImage using |
| CIImage(CVPixelBuffer, NSDictionary) |
Constructs a CIImage from the data in |
| CIImage(CVPixelBuffer) |
Constructs a CIImage with the supplied |
| CIImage(ICIImageProvider, nuint, nuint, CIFormat, CGColorSpace, CIImageProviderOptions) | |
| CIImage(IMTLTexture, NSDictionary) |
Constructs a CIImage using the |
| CIImage(Int32, CGSize, Boolean, CGColorSpace) | |
| CIImage(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| CIImage(IOSurface, CIImageInitializationOptions) | |
| CIImage(IOSurface, NSDictionary) | |
| CIImage(IOSurface) | |
| CIImage(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| CIImage(NSData, CIImageInitializationOptionsWithMetadata) |
Creates a new CIImage from the specified data. The image data must be premultiplied. |
| CIImage(NSData, nint, CGSize, Int32, CGColorSpace) | |
| CIImage(NSData, NSDictionary) |
Creates a new CIImage from the specified data. The image data must be premultiplied. |
| CIImage(NSData) |
Creates a new CIImage from the specified data. The image data must be premultiplied. |
| CIImage(NSImageRep) | |
| CIImage(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
| CIImage(NSUrl, CIImageInitializationOptions) |
Initializes a CoreImage image from the contents of the file pointed by the specified url. |
| CIImage(NSUrl, NSDictionary) |
Initializes a CoreImage image from the contents of the file pointed by the specified url. |
| CIImage(NSUrl) |
Initializes a CoreImage image from the contents of the file pointed by the specified url. |
| CIImage(UIImage, CIImageInitializationOptions) |
Initializes a CoreImage image from a UIKit image. |
| CIImage(UIImage, NSDictionary) |
Initializes a CoreImage image from a UIKit image. |
| CIImage(UIImage) |
Initializes a CoreImage image from a UIKit image. |
Properties
| CGImage | |
| Class | (Inherited from NSObject) |
| ClassHandle |
The handle for this class. |
| ColorSpace | |
| DebugDescription |
A developer-meaningful description of this object. (Inherited from NSObject) |
| Definition | |
| DepthData | |
| Description |
Description of the object, the Objective-C version of ToString. (Inherited from NSObject) |
| EmptyImage |
The empty image. |
| Extent |
Returns the extent of the image. |
| FormatA16 |
Represents the value associated with the constant kCIFormatA16. |
| FormatA8 |
Represents the value associated with the constant kCIFormatA8. |
| FormatABGR8 |
Represents the value associated with the constant kCIFormatABGR8. |
| FormatAf |
Represents the value associated with the constant kCIFormatAf. |
| FormatAh |
Represents the value associated with the constant kCIFormatAh. |
| FormatARGB8 |
Represents the value associated with the constant kCIFormatARGB8 |
| FormatBGRA8 |
Represents the value associated with the constant kCIFormatBGRA8 |
| FormatL16 | |
| FormatL8 | |
| FormatLA16 | |
| FormatLA8 | |
| FormatLAf | |
| FormatLAh | |
| FormatLf | |
| FormatLh | |
| FormatR16 |
Represents the value associated with the constant kCIFormatR16. |
| FormatR8 |
Represents the value associated with the constant kCIFormatR8. |
| FormatRf |
Represents the value associated with the constant kCIFormatRf. |
| FormatRG16 |
Represents the value associated with the constant kCIFormatRG16. |
| FormatRG8 |
Represents the value associated with the constant kCIFormatRG8. |
| FormatRGBA16 | |
| FormatRGBA8 |
Represents the value associated with the constant kCIFormatRGBA8 |
| FormatRGBAf |
Represents the value associated with the constant kCIFormatRGBAf |
| FormatRGBAh |
Represents the value associated with the constant kCIFormatRGBAh |
| FormatRGf |
Represents the value associated with the constant kCIFormatRGf. |
| FormatRGh |
Represents the value associated with the constant kCIFormatRGh. |
| FormatRh |
Represents the value associated with the constant kCIFormatRh. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| PixelBuffer |
The image data, as a CVPixelBuffer. |
| PortraitEffectsMatte | |
| Properties |
Gets a collection of metadata for this CIImage. |
| 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) |
| Url |
If not |
| 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) |
| 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)
|
| 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. |
| CreateByApplyingGaussianBlur(Double) |
Creates a new CIImage by applying a Gaussian blur with the provided |
| CreateByApplyingOrientation(CGImagePropertyOrientation) | |
| CreateByClamping(CGRect) |
Creates a new CIImage of infinite extent by cropping this CIImage to the |
| CreateByClampingToExtent() |
Creates a new image by clamping the current image to the rectangle that is defined by its Extent property. |
| CreateByColorMatchingColorSpaceToWorkingSpace(CGColorSpace) |
Creates a new CGImage by matching colors from |
| CreateByColorMatchingWorkingSpaceToColorSpace(CGColorSpace) |
Creates a new CGImage by matching colors from the working space into colors in the specified |
| CreateByCompositingOverImage(CIImage) |
Creates a new image by compositing this CIImage over |
| CreateByFiltering(String, NSDictionary) |
Creates a new image by applying |
| CreateByFiltering(String) | |
| CreateByInsertingIntermediate() | |
| CreateByInsertingIntermediate(Boolean) | |
| CreateByPremultiplyingAlpha() |
Creates a new image whose RGB values are created by multiplying this image's RGB values by this image's alpha value. |
| CreateBySamplingLinear() | |
| CreateBySamplingNearest() | |
| CreateBySettingAlphaOne(CGRect) |
Creates a new image by copying |
| CreateBySettingProperties(NSDictionary) |
Creates a new CIImage by copying |
| CreateByUnpremultiplyingAlpha() |
Creates a new image whose RGB values are created by dividing this image's RGB values by this image's alpha value. |
| CreateWithOrientation(CIImageOrientation) |
Creates a new image by applying the |
| 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) |
| Draw(CGPoint, CGRect, NSCompositingOperation, nfloat) | |
| Draw(CGRect, CGRect, NSCompositingOperation, nfloat) | |
| 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) |
| FromCGImage(CGImage, CGColorSpace) | |
| FromCGImage(CGImage, CIImageInitializationOptionsWithMetadata) |
Creates a CIImage from a CGImage with the specified |
| FromCGImage(CGImage, NSDictionary) |
Creates a CIImage from a CGImage with the specified metadata, |
| FromCGImage(CGImage) | |
| FromData(NSData, CIImageInitializationOptionsWithMetadata) |
Creates a new image from the specified |
| FromData(NSData, nint, CGSize, CIFormat, CGColorSpace) | |
| FromData(NSData, NSDictionary) |
Creates a new image from the specified |
| FromData(NSData) |
Creates a new image from the specified |
| FromDepthData(AVDepthData, NSDictionary) | |
| FromDepthData(AVDepthData) | |
| FromImageBuffer(CVImageBuffer, CIImageInitializationOptions) |
Creates a new CIImage based on the data in the |
| FromImageBuffer(CVImageBuffer, NSDictionary) | |
| FromImageBuffer(CVImageBuffer, NSDictionary<NSString,NSObject>) |
Creates a new CIImage based on the data in |
| FromImageBuffer(CVImageBuffer) |
Creates a new CIImage based on the data in the |
| FromImageBuffer(CVPixelBuffer, CIImageInitializationOptions) |
Creates a new image from the data that is contained in |
| FromImageBuffer(CVPixelBuffer, NSDictionary) |
Creates a new image from the data that is contained in |
| FromImageBuffer(CVPixelBuffer) |
Creates a new image from the data that is contained in |
| FromLayer(CGLayer, NSDictionary) | |
| FromLayer(CGLayer) | |
| FromMetalTexture(IMTLTexture, NSDictionary<NSString,NSObject>) |
Creates a new CIImage from |
| FromPortraitEffectsMatte(AVPortraitEffectsMatte, NSDictionary) | |
| FromPortraitEffectsMatte(AVPortraitEffectsMatte) | |
| FromProvider(ICIImageProvider, nuint, nuint, CIFormat, CGColorSpace, CIImageProviderOptions) | |
| FromSurface(IOSurface, CIImageInitializationOptions) | |
| FromSurface(IOSurface, NSDictionary) | |
| FromSurface(IOSurface) | |
| FromUrl(NSUrl, CIImageInitializationOptions) |
Creates a new CIImage from |
| FromUrl(NSUrl, NSDictionary) |
Creates a new CIImage from |
| FromUrl(NSUrl) |
Creates a new CIImage from |
| GetAutoAdjustmentFilters() |
Gets the filters that are required to perform some common image correction steps to an image. |
| GetAutoAdjustmentFilters(CIAutoAdjustmentFilterOptions) |
Gets the filters requires to perform some common image correction steps to an image. |
| 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) |
| GetHashCode() |
Generates a hash code for the current instance. (Inherited from NSObject) |
| GetImageTransform(CGImagePropertyOrientation) | |
| GetImageTransform(CIImageOrientation) |
Gets a transformation that results in |
| GetMethodForSelector(Selector) | (Inherited from NSObject) |
| GetNativeField(String) |
Obsolete.
(Inherited from NSObject)
|
| GetNativeHash() | (Inherited from NSObject) |
| GetRegionOfInterest(CIImage, CGRect) |
Gets a rectangle that describes the region in |
| ImageByApplyingTransform(CGAffineTransform) |
Returns a new image that results from applying the affine transform |
| ImageByCroppingToRect(CGRect) |
Creates a new image by cropping this CIImage to the rectangle |
| ImageWithColor(CIColor) |
Creates a new single-color image. |
| ImageWithTexture(UInt32, CGSize, Boolean, CGColorSpace) | |
| 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 |
| 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) |
| 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) |
| 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) |
Operators
| Implicit(CGImage to CIImage) |
Implicit constructor that wraps a CGImage as a CIImage. |