Struct CIContext 

#[repr(C)]
pub struct CIContext { /* private fields */ }

Available on crate feature CIContext only.

Apple’s documentation

Implementations

impl CIContext

pub unsafe fn contextWithCGContext_options( cgctx: &CGContext, options: Option<&NSDictionary<CIContextOption, AnyObject>>, ) -> Retained<CIContext>

Available on crate feature objc2-core-graphics only.

pub unsafe fn contextWithOptions( options: Option<&NSDictionary<CIContextOption, AnyObject>>, ) -> Retained<CIContext>

pub unsafe fn context() -> Retained<CIContext>

pub unsafe fn initWithOptions( this: Allocated<Self>, options: Option<&NSDictionary<CIContextOption, AnyObject>>, ) -> Retained<Self>

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn contextWithMTLDevice( device: &ProtocolObject<dyn MTLDevice>, ) -> Retained<CIContext>

Available on crate feature objc2-metal only.

pub unsafe fn contextWithMTLDevice_options( device: &ProtocolObject<dyn MTLDevice>, options: Option<&NSDictionary<CIContextOption, AnyObject>>, ) -> Retained<CIContext>

Available on crate feature objc2-metal only.

pub unsafe fn contextWithMTLCommandQueue( command_queue: &ProtocolObject<dyn MTLCommandQueue>, ) -> Retained<CIContext>

Available on crate feature objc2-metal only.

pub unsafe fn contextWithMTLCommandQueue_options( command_queue: &ProtocolObject<dyn MTLCommandQueue>, options: Option<&NSDictionary<CIContextOption, AnyObject>>, ) -> Retained<CIContext>

Available on crate feature objc2-metal only.

pub unsafe fn workingColorSpace(&self) -> Option<Retained<CGColorSpace>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn workingFormat(&self) -> CIFormat

Available on crate feature CIImage only.

pub unsafe fn drawImage_atPoint_fromRect( &self, image: &CIImage, at_point: CGPoint, from_rect: CGRect, )

👎Deprecated

Available on crate features CIImage and objc2-core-foundation only.

pub unsafe fn drawImage_inRect_fromRect( &self, image: &CIImage, in_rect: CGRect, from_rect: CGRect, )

Available on crate features CIImage and objc2-core-foundation only.

pub unsafe fn createCGLayerWithSize_info( &self, size: CGSize, info: Option<&CFDictionary>, ) -> Option<Retained<CGLayer>>

👎Deprecated

Available on crate features objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn render_toBitmap_rowBytes_bounds_format_colorSpace( &self, image: &CIImage, data: NonNull<c_void>, row_bytes: isize, bounds: CGRect, format: CIFormat, color_space: Option<&CGColorSpace>, )

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn render_toIOSurface_bounds_colorSpace( &self, image: &CIImage, surface: &IOSurfaceRef, bounds: CGRect, color_space: Option<&CGColorSpace>, )

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics and objc2-io-surface only.

pub unsafe fn render_toCVPixelBuffer( &self, image: &CIImage, buffer: &CVPixelBuffer, )

Available on crate features CIImage and objc2-core-video only.

pub unsafe fn render_toCVPixelBuffer_bounds_colorSpace( &self, image: &CIImage, buffer: &CVPixelBuffer, bounds: CGRect, color_space: Option<&CGColorSpace>, )

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics and objc2-core-video only.

pub unsafe fn render_toMTLTexture_commandBuffer_bounds_colorSpace( &self, image: &CIImage, texture: &ProtocolObject<dyn MTLTexture>, command_buffer: Option<&ProtocolObject<dyn MTLCommandBuffer>>, bounds: CGRect, color_space: &CGColorSpace, )

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics and objc2-metal only.

pub unsafe fn reclaimResources(&self)

pub unsafe fn clearCaches(&self)

pub unsafe fn inputImageMaximumSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub unsafe fn outputImageMaximumSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

impl CIContext

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

impl CIContext

createCGImage.

pub unsafe fn createCGImage_fromRect( &self, image: &CIImage, from_rect: CGRect, ) -> Option<Retained<CGImage>>

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn createCGImage_fromRect_format_colorSpace( &self, image: &CIImage, from_rect: CGRect, format: CIFormat, color_space: Option<&CGColorSpace>, ) -> Option<Retained<CGImage>>

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn createCGImage_fromRect_format_colorSpace_deferred( &self, image: &CIImage, from_rect: CGRect, format: CIFormat, color_space: Option<&CGColorSpace>, deferred: bool, ) -> Option<Retained<CGImage>>

Available on crate features CIImage and objc2-core-foundation and objc2-core-graphics only.

impl CIContext

OfflineGPUSupport.

pub unsafe fn offlineGPUCount() -> c_uint

pub unsafe fn contextForOfflineGPUAtIndex( index: c_uint, ) -> Option<Retained<CIContext>>

👎Deprecated: Core Image OpenGL API deprecated. (Define CI_SILENCE_GL_DEPRECATION to silence these warnings)

impl CIContext

ImageRepresentation.

pub unsafe fn TIFFRepresentationOfImage_format_colorSpace_options( &self, image: &CIImage, format: CIFormat, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Option<Retained<NSData>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn JPEGRepresentationOfImage_colorSpace_options( &self, image: &CIImage, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Option<Retained<NSData>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn HEIFRepresentationOfImage_format_colorSpace_options( &self, image: &CIImage, format: CIFormat, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Option<Retained<NSData>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn HEIF10RepresentationOfImage_colorSpace_options_error( &self, image: &CIImage, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn PNGRepresentationOfImage_format_colorSpace_options( &self, image: &CIImage, format: CIFormat, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Option<Retained<NSData>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn OpenEXRRepresentationOfImage_options_error( &self, image: &CIImage, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate feature CIImage only.

pub unsafe fn writeTIFFRepresentationOfImage_toURL_format_colorSpace_options_error( &self, image: &CIImage, url: &NSURL, format: CIFormat, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn writePNGRepresentationOfImage_toURL_format_colorSpace_options_error( &self, image: &CIImage, url: &NSURL, format: CIFormat, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn writeJPEGRepresentationOfImage_toURL_colorSpace_options_error( &self, image: &CIImage, url: &NSURL, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn writeHEIFRepresentationOfImage_toURL_format_colorSpace_options_error( &self, image: &CIImage, url: &NSURL, format: CIFormat, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn writeHEIF10RepresentationOfImage_toURL_colorSpace_options_error( &self, image: &CIImage, url: &NSURL, color_space: &CGColorSpace, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate features CIImage and objc2-core-graphics only.

pub unsafe fn writeOpenEXRRepresentationOfImage_toURL_options_error( &self, image: &CIImage, url: &NSURL, options: &NSDictionary<CIImageRepresentationOption, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate feature CIImage only.

impl CIContext

CIDepthBlurEffect.

pub unsafe fn depthBlurEffectFilterForImageURL_options( &self, url: &NSURL, options: Option<&NSDictionary>, ) -> Option<Retained<CIFilter>>

Available on crate feature CIFilter only.

pub unsafe fn depthBlurEffectFilterForImageData_options( &self, data: &NSData, options: Option<&NSDictionary>, ) -> Option<Retained<CIFilter>>

Available on crate feature CIFilter only.

impl CIContext

CIRenderDestination.

pub unsafe fn startTaskToRender_fromRect_toDestination_atPoint_error( &self, image: &CIImage, from_rect: CGRect, destination: &CIRenderDestination, at_point: CGPoint, ) -> Result<Retained<CIRenderTask>, Retained<NSError>>

Available on crate features CIRenderDestination and CIImage and objc2-core-foundation only.

pub unsafe fn startTaskToRender_toDestination_error( &self, image: &CIImage, destination: &CIRenderDestination, ) -> Result<Retained<CIRenderTask>, Retained<NSError>>

Available on crate features CIRenderDestination and CIImage only.

pub unsafe fn prepareRender_fromRect_toDestination_atPoint_error( &self, image: &CIImage, from_rect: CGRect, destination: &CIRenderDestination, at_point: CGPoint, ) -> Result<(), Retained<NSError>>

Available on crate features CIRenderDestination and CIImage and objc2-core-foundation only.

pub unsafe fn startTaskToClear_error( &self, destination: &CIRenderDestination, ) -> Result<Retained<CIRenderTask>, Retained<NSError>>

Available on crate feature CIRenderDestination only.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for CIContext

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CIContext> for CIContext

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for CIContext

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for CIContext

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CIContext

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CIContext

const NAME: &'static str = "CIContext"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CIContext as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for CIContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for CIContext

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for CIContext

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for CIContext

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CIContext

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for CIContext

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for CIContext

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for CIContext

impl Eq for CIContext