Share via


CIContext Class

Definition

Orchestrates the rendering of a CIFilter pipeline.

[Foundation.Register("CIContext", true)]
public class CIContext : Foundation.NSObject
[<Foundation.Register("CIContext", true)>]
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

Name Description
CIContext()
CIContext(CIContextOptions)

Creates a new Core Image context with the specified options.

CIContext(NativeHandle)

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

Name Description
AccessibilityAttributedUserInputLabels (Inherited from NSObject)
AccessibilityRespondsToUserInteraction (Inherited from NSObject)
AccessibilityTextualContext (Inherited from NSObject)
AccessibilityUserInputLabels (Inherited from NSObject)
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)
InputImageMaximumSize

Gets the maximum allowed input image size.

IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
MemoryLimit
Obsolete.

Represents the value associated with the constant 'kCIContextMemoryLimit'.

OfflineGPUCount
OutputImageMaximumSize

Gets the maximum allowed output image size.

RetainCount (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

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)
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, NSBindingOptions) (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
CalculateHdrStats(CGImage)
CalculateHdrStats(CIImage)
CalculateHdrStats(CVPixelBuffer)
CalculateHdrStats(IOSurface)
ClearCaches()

Frees data in the cache and runs the garbage collector.

CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(NativeHandle) (Inherited from NSObject)
Copy() (Inherited from NSObject)
Create()

Creates a new CIContext with default options.

Create(IMTLCommandQueue, NSDictionary<NSString,NSObject>)
Create(IMTLCommandQueue)
CreateCGImage(CIImage, CGRect, CIFormat, CGColorSpace, Boolean)
CreateCGImage(CIImage, CGRect, CIFormat, CGColorSpace)
CreateCGImage(CIImage, CGRect, Int32, CGColorSpace, Boolean, Boolean)
CreateCGImage(CIImage, CGRect, Int32, CGColorSpace)
CreateCGImage(CIImage, CGRect)

Creates a new CGImage from the fromRectangle region of image.

CreateCGLayer(CGSize)
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)
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 fromRectangle portion of image into the rectangle specified by inRectangle.

Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
FromContext(CGContext, CIContextOptions)

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

FromContext(CGContext)

Creates a new CIContext from an existing one.

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.

FromContext(EAGLContext)

Creates a new CIContext from the provided eaglContext.

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.

FromMetalDevice(IMTLDevice)

Creates a new CIContext from the provided Metal device.

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[]) (Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetOpenEXRRepresentation(CIImage, NSDictionary<NSString,NSObject>, NSError)
Init() (Inherited from NSObject)
InitializeHandle(NativeHandle, String) (Inherited from NSObject)
InitializeHandle(NativeHandle) (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() (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)
ReclaimResources()
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)
Render(CIImage, CVPixelBuffer, CGRect, CGColorSpace)
Render(CIImage, CVPixelBuffer)

Renders image to buffer.

Render(CIImage, IMTLTexture, IMTLCommandBuffer, CGRect, CGColorSpace)
Render(CIImage, IOSurface, CGRect, CGColorSpace)
RenderToBitmap(CIImage, IntPtr, IntPtr, CGRect, Int32, CGColorSpace)
RespondsToSelector(Selector) (Inherited from NSObject)
SetNilValueForKey(NSString) (Inherited from NSObject)
SetValueForKey(NSObject, NSString) (Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString) (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)
WriteOpenExrRepresentation(CIImage, NSUrl, NSDictionary<NSString,NSObject>, NSError)

Extension Methods

Name Description
ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
GetDepthBlurEffectFilter(CIContext, CIImage, CIImage, CIImage, CIImage, CIImage, CIImage, CGImagePropertyOrientation, NSDictionary)
GetDepthBlurEffectFilter(CIContext, CIImage, CIImage, CIImage, CIImage, CGImagePropertyOrientation, NSDictionary)
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)
GetHeif10Representation(CIContext, CIImage, CGColorSpace, CIImageRepresentationOptions, NSError)
GetHeif10Representation(CIContext, CIImage, CGColorSpace, NSDictionary, 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 context 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 context to the image and returns a TIFF image of the result.

WriteHeif10Representation(CIContext, CIImage, NSUrl, CGColorSpace, CIImageRepresentationOptions, NSError)
WriteHeif10Representation(CIContext, CIImage, NSUrl, CGColorSpace, NSDictionary, NSError)
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 context 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 context to the image and writes a TIFF image of the result to url.

ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
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.

AccessibilityHitTest(NSObject, CGPoint, UIEvent)
GetAccessibilityNextTextNavigationElement(NSObject)
GetAccessibilityNextTextNavigationElementBlock(NSObject)
GetAccessibilityPreviousTextNavigationElement(NSObject)
GetAccessibilityPreviousTextNavigationElementBlock(NSObject)
SetAccessibilityNextTextNavigationElement(NSObject, NSObject)
SetAccessibilityNextTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
SetAccessibilityPreviousTextNavigationElement(NSObject, NSObject)
SetAccessibilityPreviousTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
GetAccessibilityTextInputResponder(NSObject)
GetAccessibilityTextInputResponderHandler(NSObject)
SetAccessibilityTextInputResponder(NSObject, IUITextInput)
SetAccessibilityTextInputResponderHandler(NSObject, UITextInputReturnHandler)

Applies to

See also