Struct CIImage

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

Available on crate feature CIImage only.

Apple’s documentation

Implementations

impl CIImage

pub unsafe fn imageWithCGImage(image: &CGImage) -> Retained<CIImage>

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageWithCGImage_options( image: &CGImage, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageWithCGLayer(layer: &CGLayer) -> Retained<CIImage>

👎Deprecated

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageWithCGLayer_options( layer: &CGLayer, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

👎Deprecated

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageWithBitmapData_bytesPerRow_size_format_colorSpace( data: &NSData, bytes_per_row: usize, size: CGSize, format: CIFormat, color_space: Option<&CGColorSpace>, ) -> Retained<CIImage>

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

pub unsafe fn imageWithTexture_size_flipped_colorSpace( name: c_uint, size: CGSize, flipped: bool, color_space: Option<&CGColorSpace>, ) -> Retained<CIImage>

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

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

pub unsafe fn imageWithTexture_size_flipped_options( name: c_uint, size: CGSize, flipped: bool, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

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

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageWithMTLTexture_options( texture: &ProtocolObject<dyn MTLTexture>, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Option<Retained<CIImage>>

Available on crate feature objc2-metal only.

pub unsafe fn imageWithContentsOfURL(url: &NSURL) -> Option<Retained<CIImage>>

pub unsafe fn imageWithContentsOfURL_options( url: &NSURL, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Option<Retained<CIImage>>

pub unsafe fn imageWithData(data: &NSData) -> Option<Retained<CIImage>>

pub unsafe fn imageWithData_options( data: &NSData, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Option<Retained<CIImage>>

pub unsafe fn imageWithCVImageBuffer( image_buffer: &CVImageBuffer, ) -> Retained<CIImage>

Available on crate feature objc2-core-video only.

pub unsafe fn imageWithCVImageBuffer_options( image_buffer: &CVImageBuffer, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

Available on crate feature objc2-core-video only.

pub unsafe fn imageWithCVPixelBuffer( pixel_buffer: &CVPixelBuffer, ) -> Retained<CIImage>

Available on crate feature objc2-core-video only.

pub unsafe fn imageWithCVPixelBuffer_options( pixel_buffer: &CVPixelBuffer, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

Available on crate feature objc2-core-video only.

pub unsafe fn imageWithIOSurface(surface: &IOSurfaceRef) -> Retained<CIImage>

Available on crate feature objc2-io-surface only.

pub unsafe fn imageWithIOSurface_options( surface: &IOSurfaceRef, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

Available on crate feature objc2-io-surface only.

pub unsafe fn imageWithColor(color: &CIColor) -> Retained<CIImage>

Available on crate feature CIColor only.

pub unsafe fn emptyImage() -> Retained<CIImage>

pub unsafe fn blackImage() -> Retained<CIImage>

pub unsafe fn whiteImage() -> Retained<CIImage>

pub unsafe fn grayImage() -> Retained<CIImage>

pub unsafe fn redImage() -> Retained<CIImage>

pub unsafe fn greenImage() -> Retained<CIImage>

pub unsafe fn blueImage() -> Retained<CIImage>

pub unsafe fn cyanImage() -> Retained<CIImage>

pub unsafe fn magentaImage() -> Retained<CIImage>

pub unsafe fn yellowImage() -> Retained<CIImage>

pub unsafe fn clearImage() -> Retained<CIImage>

pub unsafe fn initWithCGImage( this: Allocated<Self>, image: &CGImage, ) -> Retained<Self>

Available on crate feature objc2-core-graphics only.

pub unsafe fn initWithCGImage_options( this: Allocated<Self>, image: &CGImage, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

Available on crate feature objc2-core-graphics only.

pub unsafe fn initWithCGLayer( this: Allocated<Self>, layer: &CGLayer, ) -> Retained<Self>

👎Deprecated: Use initWithCGImage: instead.

Available on crate feature objc2-core-graphics only.

pub unsafe fn initWithCGLayer_options( this: Allocated<Self>, layer: &CGLayer, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

👎Deprecated: Use initWithCGImage:options instead.

Available on crate feature objc2-core-graphics only.

pub unsafe fn initWithData( this: Allocated<Self>, data: &NSData, ) -> Option<Retained<Self>>

pub unsafe fn initWithData_options( this: Allocated<Self>, data: &NSData, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Option<Retained<Self>>

pub unsafe fn initWithBitmapData_bytesPerRow_size_format_colorSpace( this: Allocated<Self>, data: &NSData, bytes_per_row: usize, size: CGSize, format: CIFormat, color_space: Option<&CGColorSpace>, ) -> Retained<Self>

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

pub unsafe fn initWithTexture_size_flipped_colorSpace( this: Allocated<Self>, name: c_uint, size: CGSize, flipped: bool, color_space: Option<&CGColorSpace>, ) -> Retained<Self>

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

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

pub unsafe fn initWithTexture_size_flipped_options( this: Allocated<Self>, name: c_uint, size: CGSize, flipped: bool, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

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

Available on crate feature objc2-core-foundation only.

pub unsafe fn initWithMTLTexture_options( this: Allocated<Self>, texture: &ProtocolObject<dyn MTLTexture>, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Option<Retained<Self>>

Available on crate feature objc2-metal only.

pub unsafe fn initWithContentsOfURL( this: Allocated<Self>, url: &NSURL, ) -> Option<Retained<Self>>

pub unsafe fn initWithContentsOfURL_options( this: Allocated<Self>, url: &NSURL, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Option<Retained<Self>>

pub unsafe fn initWithIOSurface( this: Allocated<Self>, surface: &IOSurfaceRef, ) -> Retained<Self>

Available on crate feature objc2-io-surface only.

pub unsafe fn initWithIOSurface_options( this: Allocated<Self>, surface: &IOSurfaceRef, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

Available on crate feature objc2-io-surface only.

pub unsafe fn initWithIOSurface_plane_format_options( this: Allocated<Self>, surface: &IOSurfaceRef, plane: usize, format: CIFormat, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

👎Deprecated

Available on crate feature objc2-io-surface only.

pub unsafe fn initWithCVImageBuffer( this: Allocated<Self>, image_buffer: &CVImageBuffer, ) -> Retained<Self>

Available on crate feature objc2-core-video only.

pub unsafe fn initWithCVImageBuffer_options( this: Allocated<Self>, image_buffer: &CVImageBuffer, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

Available on crate feature objc2-core-video only.

pub unsafe fn initWithCVPixelBuffer( this: Allocated<Self>, pixel_buffer: &CVPixelBuffer, ) -> Retained<Self>

Available on crate feature objc2-core-video only.

pub unsafe fn initWithCVPixelBuffer_options( this: Allocated<Self>, pixel_buffer: &CVPixelBuffer, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

Available on crate feature objc2-core-video only.

pub unsafe fn initWithColor( this: Allocated<Self>, color: &CIColor, ) -> Retained<Self>

Available on crate feature CIColor only.

pub unsafe fn imageByApplyingTransform( &self, matrix: CGAffineTransform, ) -> Retained<CIImage>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageByApplyingTransform_highQualityDownsample( &self, matrix: CGAffineTransform, high_quality_downsample: bool, ) -> Retained<CIImage>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageByApplyingOrientation( &self, orientation: c_int, ) -> Retained<CIImage>

pub unsafe fn imageByCompositingOverImage( &self, dest: &CIImage, ) -> Retained<CIImage>

pub unsafe fn imageByCroppingToRect(&self, rect: CGRect) -> Retained<CIImage>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageByClampingToExtent(&self) -> Retained<CIImage>

pub unsafe fn imageByClampingToRect(&self, rect: CGRect) -> Retained<CIImage>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageByApplyingFilter_withInputParameters( &self, filter_name: &NSString, params: &NSDictionary<NSString, AnyObject>, ) -> Retained<CIImage>

pub unsafe fn imageByApplyingFilter( &self, filter_name: &NSString, ) -> Retained<CIImage>

pub unsafe fn imageByColorMatchingColorSpaceToWorkingSpace( &self, color_space: &CGColorSpace, ) -> Option<Retained<CIImage>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageByColorMatchingWorkingSpaceToColorSpace( &self, color_space: &CGColorSpace, ) -> Option<Retained<CIImage>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageByPremultiplyingAlpha(&self) -> Retained<CIImage>

pub unsafe fn imageByUnpremultiplyingAlpha(&self) -> Retained<CIImage>

pub unsafe fn imageBySettingAlphaOneInExtent( &self, extent: CGRect, ) -> Retained<CIImage>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageByApplyingGaussianBlurWithSigma( &self, sigma: c_double, ) -> Retained<CIImage>

pub unsafe fn imageBySettingProperties( &self, properties: &NSDictionary, ) -> Retained<CIImage>

pub unsafe fn imageBySamplingLinear(&self) -> Retained<CIImage>

pub unsafe fn imageBySamplingNearest(&self) -> Retained<CIImage>

pub unsafe fn imageByInsertingIntermediate(&self) -> Retained<CIImage>

pub unsafe fn imageByInsertingIntermediate_( &self, cache: bool, ) -> Retained<CIImage>

pub unsafe fn imageByApplyingGainMap( &self, gainmap: &CIImage, ) -> Retained<CIImage>

pub unsafe fn imageByApplyingGainMap_headroom( &self, gainmap: &CIImage, headroom: c_float, ) -> Retained<CIImage>

pub unsafe fn extent(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn isOpaque(&self) -> bool

pub unsafe fn properties(&self) -> Retained<NSDictionary<NSString, AnyObject>>

pub unsafe fn definition(&self) -> Retained<CIFilterShape>

Available on crate feature CIFilterShape only.

pub unsafe fn url(&self) -> Option<Retained<NSURL>>

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

Available on crate feature objc2-core-graphics only.

pub unsafe fn contentHeadroom(&self) -> c_float

pub unsafe fn pixelBuffer(&self) -> Option<Retained<CVPixelBuffer>>

Available on crate feature objc2-core-video only.

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

Available on crate feature objc2-core-graphics only.

pub unsafe fn metalTexture( &self, ) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>

Available on crate feature objc2-metal only.

pub unsafe fn regionOfInterestForImage_inRect( &self, image: &CIImage, rect: CGRect, ) -> CGRect

Available on crate feature objc2-core-foundation only.

impl CIImage

Methods declared on superclass NSObject.

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

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

impl CIImage

AutoAdjustment.

pub unsafe fn autoAdjustmentFilters(&self) -> Retained<NSArray<CIFilter>>

Available on crate feature CIFilter only.

pub unsafe fn autoAdjustmentFiltersWithOptions( &self, options: Option<&NSDictionary<CIImageAutoAdjustmentOption, AnyObject>>, ) -> Retained<NSArray<CIFilter>>

Available on crate feature CIFilter only.

impl CIImage

LabConversion.

pub unsafe fn imageByConvertingWorkingSpaceToLab(&self) -> Retained<CIImage>

pub unsafe fn imageByConvertingLabToWorkingSpace(&self) -> Retained<CIImage>

impl CIImage

CIImageProvider.

pub unsafe fn imageWithImageProvider_size__format_colorSpace_options( p: &AnyObject, width: usize, height: usize, f: CIFormat, cs: Option<&CGColorSpace>, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<CIImage>

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

pub unsafe fn initWithImageProvider_size__format_colorSpace_options( this: Allocated<Self>, p: &AnyObject, width: usize, height: usize, f: CIFormat, cs: Option<&CGColorSpace>, options: Option<&NSDictionary<CIImageOption, AnyObject>>, ) -> Retained<Self>

Available on crate features CIImageProvider and objc2-core-graphics 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 CIImage

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CIImage> for CIImage

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CIImage

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CIImage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CIImage

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CIImage

const NAME: &'static str = "CIImage"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CIImage 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 CopyingHelper for CIImage

type Result = CIImage

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for CIImage

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

Formats the value using the given formatter.

impl Deref for CIImage

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CIImage

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 CIImage

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for CIImage

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for CIImage

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 NSSecureCoding for CIImage

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CIImage

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 CIImage

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

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

impl DowncastTarget for CIImage

impl Eq for CIImage

impl NSCoding for CIImage