CIContext Class

Definition

Orchestrates the rendering of a CIFilter pipeline.

[Foundation.Register("CIContext", true)]
public class CIContext : Foundation.NSObject
type CIContext = class
    inherit NSObject
Inheritance
CIContext
Attributes

Remarks

The CIContext class is used to orchestrate the rendering of a pipeline of filters into one of the supported output surfaces.

The CGContext can render its results into a CoreGraphics CGImage, render directly into the screen with one of the various Draw methods, into a CoreVideo CVPixelBuffer or into a CoreGraphics context.

Constructors

CIContext()
CIContext(CIContextOptions)

Creates a new Core Image context with the specified options.

CIContext(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

CIContext(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

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)
InputImageMaximumSize

Gets the maximum allowed input image size.

IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
OfflineGPUCount
OutputImageMaximumSize

Gets the maximum allowed output image size.

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)
WorkingColorSpace

The working CGColorSpace.

WorkingFormat

The working pixel format.

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) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
ClearCaches()

Frees data in the cache and runs the garbage collector.

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)
Create()

Creates a new CIContext with default options.

CreateCGImage(CIImage, CGRect)

Creates a new CGImage from the fromRectangle region of image.

CreateCGImage(CIImage, CGRect, CIFormat, CGColorSpace)
CreateCGImage(CIImage, CGRect, CIFormat, CGColorSpace, Boolean)
CreateCGImage(CIImage, CGRect, Int32, CGColorSpace)
CreateCGLayer(CGSize)
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)
DrawImage(CIImage, CGPoint, CGRect)

Developers should not use this deprecated method. Developers should use 'DrawImage (image, CGRect, CGRect)' instead.

DrawImage(CIImage, CGRect, CGRect)

Draws the fromRect portion of inRectangle into the rectangle in the context that is specified by atPoint.

Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
FromContext(CGContext)

Creates a new CIContext from an existing one.

FromContext(CGContext, CIContextOptions)

Creates a new CIContext from an existing one, along with the provided

FromContext(EAGLContext)

Creates a new CIContext from the provided eaglContext.

FromContext(EAGLContext, CIContextOptions)

Creates a CIContext based on the eaglContext, with the specified options.

FromContext(EAGLContext, NSDictionary)

Creates a new CIContext from the provided eaglContext and by using the options that are named in dictionary.

FromMetalDevice(IMTLDevice)

Creates a new CIContext from the provided Metal device.

FromMetalDevice(IMTLDevice, CIContextOptions)

Creates a new CIContext from the provided Metal device, along with the specified context.

FromMetalDevice(IMTLDevice, NSDictionary<NSString,NSObject>)

Creates a new CIContext from the provided Metal device, applying the specified options.

FromOfflineGpu(Int32)
FromOptions(CIContextOptions)

Creates a new CIContext from the options that are named in options.

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)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (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) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (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, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
ReclaimResources()
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(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, String)

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)
Render(CIImage, CVPixelBuffer)

Renders image to buffer.

Render(CIImage, CVPixelBuffer, CGRect, CGColorSpace)
Render(CIImage, IMTLTexture, IMTLCommandBuffer, CGRect, CGColorSpace)
Render(CIImage, IOSurface, CGRect, CGColorSpace)
RenderToBitmap(CIImage, IntPtr, nint, CGRect, Int32, CGColorSpace)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) (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) (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)
GetDepthBlurEffectFilter(CIContext, CIImage, CIImage, CIImage, CGImagePropertyOrientation, NSDictionary)
GetDepthBlurEffectFilter(CIContext, NSData, NSDictionary)
GetDepthBlurEffectFilter(CIContext, NSUrl, NSDictionary)
PrepareRender(CIContext, CIImage, CGRect, CIRenderDestination, CGPoint, NSError)
StartTaskToClear(CIContext, CIRenderDestination, NSError)
StartTaskToRender(CIContext, CIImage, CGRect, CIRenderDestination, CGPoint, NSError)
StartTaskToRender(CIContext, CIImage, CIRenderDestination, NSError)
GetHeifRepresentation(CIContext, CIImage, CIFormat, CGColorSpace, CIImageRepresentationOptions)
GetHeifRepresentation(CIContext, CIImage, CIFormat, CGColorSpace, NSDictionary)
GetJpegRepresentation(CIContext, CIImage, CGColorSpace, CIImageRepresentationOptions)
GetJpegRepresentation(CIContext, CIImage, CGColorSpace, NSDictionary)

Applies the processing of This to the image and returns a JPEG image of the result.

GetPngRepresentation(CIContext, CIImage, CIFormat, CGColorSpace, CIImageRepresentationOptions)
GetPngRepresentation(CIContext, CIImage, CIFormat, CGColorSpace, NSDictionary)
GetTiffRepresentation(CIContext, CIImage, CIFormat, CGColorSpace, CIImageRepresentationOptions)
GetTiffRepresentation(CIContext, CIImage, CIFormat, CGColorSpace, NSDictionary)

Applies the processing of This to the image and returns a TIFF image of the result.

WriteHeifRepresentation(CIContext, CIImage, NSUrl, CIFormat, CGColorSpace, CIImageRepresentationOptions, NSError)
WriteHeifRepresentation(CIContext, CIImage, NSUrl, CIFormat, CGColorSpace, NSDictionary, NSError)
WriteJpegRepresentation(CIContext, CIImage, NSUrl, CGColorSpace, CIImageRepresentationOptions, NSError)
WriteJpegRepresentation(CIContext, CIImage, NSUrl, CGColorSpace, NSDictionary, NSError)

Applies the processing of This to the image and writes a JPEG image of the result to url.

WritePngRepresentation(CIContext, CIImage, NSUrl, CIFormat, CGColorSpace, CIImageRepresentationOptions, NSError)
WritePngRepresentation(CIContext, CIImage, NSUrl, CIFormat, CGColorSpace, NSDictionary, NSError)
WriteTiffRepresentation(CIContext, CIImage, NSUrl, CIFormat, CGColorSpace, CIImageRepresentationOptions, NSError)
WriteTiffRepresentation(CIContext, CIImage, NSUrl, CIFormat, CGColorSpace, NSDictionary, NSError)

Applies the processing of This to the image and writes a TIFF image of the result to url.

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

See also