Struct UIImage

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

Available on crate feature UIImage only.

Apple’s documentation

Implementations

impl UIImage

This impl block contains no items.

UIAccessibility.

impl UIImage

pub unsafe fn systemImageNamed(name: &NSString) -> Option<Retained<UIImage>>

pub unsafe fn systemImageNamed_withConfiguration( name: &NSString, configuration: Option<&UIImageConfiguration>, ) -> Option<Retained<UIImage>>

Available on crate feature UIImageConfiguration only.

pub unsafe fn systemImageNamed_compatibleWithTraitCollection( name: &NSString, trait_collection: Option<&UITraitCollection>, ) -> Option<Retained<UIImage>>

Available on crate feature UITraitCollection only.

pub unsafe fn systemImageNamed_variableValue_withConfiguration( name: &NSString, value: c_double, configuration: Option<&UIImageConfiguration>, ) -> Option<Retained<UIImage>>

Available on crate feature UIImageConfiguration only.

Retrieve a system-provided image with the specified name and variable value (between 0 and 1).

This will only return system-provided images. If you want a custom image as defined in your own catalogs, you should use +imageNamed:inBundle:variableValue:withConfiguration:. Returns nilif an image with specified name doesn’t exist.

pub unsafe fn imageNamed(name: &NSString) -> Option<Retained<UIImage>>

pub unsafe fn imageNamed_inBundle_withConfiguration( name: &NSString, bundle: Option<&NSBundle>, configuration: Option<&UIImageConfiguration>, ) -> Option<Retained<UIImage>>

Available on crate feature UIImageConfiguration only.

pub unsafe fn imageNamed_inBundle_compatibleWithTraitCollection( name: &NSString, bundle: Option<&NSBundle>, trait_collection: Option<&UITraitCollection>, ) -> Option<Retained<UIImage>>

Available on crate feature UITraitCollection only.

pub unsafe fn imageNamed_inBundle_variableValue_withConfiguration( name: &NSString, bundle: Option<&NSBundle>, value: c_double, configuration: Option<&UIImageConfiguration>, ) -> Option<Retained<UIImage>>

Available on crate feature UIImageConfiguration only.

Retrieve a image with the specified name and variable value (between 0 and 1).

This will only return custom images defined in your own catalogs. If you want a system-provided image, you should use +systemImageNamed:variableValue:withConfiguration:. Returns nilif an image with specified name doesn’t exist.

pub unsafe fn imageWithContentsOfFile( path: &NSString, ) -> Option<Retained<UIImage>>

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

pub unsafe fn imageWithData_scale( data: &NSData, scale: CGFloat, ) -> Option<Retained<UIImage>>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageWithCGImage(cg_image: &CGImage) -> Retained<UIImage>

Available on crate feature objc2-core-graphics only.

pub unsafe fn imageWithCGImage_scale_orientation( cg_image: &CGImage, scale: CGFloat, orientation: UIImageOrientation, ) -> Retained<UIImage>

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

pub unsafe fn imageWithCIImage(ci_image: &CIImage) -> Retained<UIImage>

Available on crate feature objc2-core-image and non-watchOS only.

pub unsafe fn imageWithCIImage_scale_orientation( ci_image: &CIImage, scale: CGFloat, orientation: UIImageOrientation, ) -> Retained<UIImage>

Available on crate feature objc2-core-foundation and crate feature objc2-core-image and non-watchOS only.

pub unsafe fn initWithContentsOfFile( this: Allocated<Self>, path: &NSString, ) -> Option<Retained<Self>>

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

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-graphics only.

pub unsafe fn initWithCGImage_scale_orientation( this: Allocated<Self>, cg_image: &CGImage, scale: CGFloat, orientation: UIImageOrientation, ) -> Retained<Self>

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

pub unsafe fn initWithCIImage( this: Allocated<Self>, ci_image: &CIImage, ) -> Retained<Self>

Available on crate feature objc2-core-image and non-watchOS only.

pub unsafe fn initWithCIImage_scale_orientation( this: Allocated<Self>, ci_image: &CIImage, scale: CGFloat, orientation: UIImageOrientation, ) -> Retained<Self>

Available on crate feature objc2-core-foundation and crate feature objc2-core-image and non-watchOS only.

pub unsafe fn size(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-graphics only.

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

Available on crate feature objc2-core-image and non-watchOS only.

pub unsafe fn imageOrientation(&self) -> UIImageOrientation

pub unsafe fn scale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn isSymbolImage(&self) -> bool

pub unsafe fn animatedImageNamed_duration( name: &NSString, duration: NSTimeInterval, ) -> Option<Retained<UIImage>>

pub unsafe fn animatedResizableImageNamed_capInsets_duration( name: &NSString, cap_insets: UIEdgeInsets, duration: NSTimeInterval, ) -> Option<Retained<UIImage>>

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

pub unsafe fn animatedResizableImageNamed_capInsets_resizingMode_duration( name: &NSString, cap_insets: UIEdgeInsets, resizing_mode: UIImageResizingMode, duration: NSTimeInterval, ) -> Option<Retained<UIImage>>

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

pub unsafe fn animatedImageWithImages_duration( images: &NSArray<UIImage>, duration: NSTimeInterval, ) -> Option<Retained<UIImage>>

pub unsafe fn images(&self) -> Option<Retained<NSArray<UIImage>>>

pub unsafe fn duration(&self) -> NSTimeInterval

pub unsafe fn drawAtPoint(&self, point: CGPoint)

Available on crate feature objc2-core-foundation only.

pub unsafe fn drawAtPoint_blendMode_alpha( &self, point: CGPoint, blend_mode: CGBlendMode, alpha: CGFloat, )

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

pub unsafe fn drawInRect(&self, rect: CGRect)

Available on crate feature objc2-core-foundation only.

pub unsafe fn drawInRect_blendMode_alpha( &self, rect: CGRect, blend_mode: CGBlendMode, alpha: CGFloat, )

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

pub unsafe fn drawAsPatternInRect(&self, rect: CGRect)

Available on crate feature objc2-core-foundation only.

pub unsafe fn resizableImageWithCapInsets( &self, cap_insets: UIEdgeInsets, ) -> Retained<UIImage>

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

pub unsafe fn resizableImageWithCapInsets_resizingMode( &self, cap_insets: UIEdgeInsets, resizing_mode: UIImageResizingMode, ) -> Retained<UIImage>

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

pub unsafe fn capInsets(&self) -> UIEdgeInsets

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

pub unsafe fn resizingMode(&self) -> UIImageResizingMode

pub unsafe fn imageWithAlignmentRectInsets( &self, alignment_insets: UIEdgeInsets, ) -> Retained<UIImage>

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

pub unsafe fn alignmentRectInsets(&self) -> UIEdgeInsets

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

pub unsafe fn imageWithRenderingMode( &self, rendering_mode: UIImageRenderingMode, ) -> Retained<UIImage>

pub unsafe fn renderingMode(&self) -> UIImageRenderingMode

pub unsafe fn imageRendererFormat( &self, ) -> Retained<UIGraphicsImageRendererFormat>

Available on crate features UIGraphicsImageRenderer and UIGraphicsRenderer only.

pub unsafe fn traitCollection(&self) -> Retained<UITraitCollection>

Available on crate feature UITraitCollection only.

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

Available on crate feature UIImageAsset only.

pub unsafe fn imageFlippedForRightToLeftLayoutDirection( &self, ) -> Retained<UIImage>

pub unsafe fn flipsForRightToLeftLayoutDirection(&self) -> bool

pub unsafe fn imageWithHorizontallyFlippedOrientation( &self, ) -> Retained<UIImage>

pub unsafe fn baselineOffsetFromBottom(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn hasBaseline(&self) -> bool

pub unsafe fn imageWithBaselineOffsetFromBottom( &self, baseline_offset: CGFloat, ) -> Retained<UIImage>

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageWithoutBaseline(&self) -> Retained<UIImage>

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

Available on crate feature UIImageConfiguration only.

pub unsafe fn imageWithConfiguration( &self, configuration: &UIImageConfiguration, ) -> Retained<UIImage>

Available on crate feature UIImageConfiguration only.

pub unsafe fn symbolConfiguration( &self, ) -> Option<Retained<UIImageSymbolConfiguration>>

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

pub unsafe fn imageByApplyingSymbolConfiguration( &self, configuration: &UIImageSymbolConfiguration, ) -> Option<Retained<UIImage>>

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

pub unsafe fn imageWithTintColor(&self, color: &UIColor) -> Retained<UIImage>

Available on crate feature UIColor only.

pub unsafe fn imageWithTintColor_renderingMode( &self, color: &UIColor, rendering_mode: UIImageRenderingMode, ) -> Retained<UIImage>

Available on crate feature UIColor only.

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

Decodes an image synchronously and provides a new one for display in views and animations.

Returns: A new version of the image object for display. If the system can’t decode the image, this method returns nil.

Note: The prepared UIImage is not related to the original image. If the properties of the screen (such as its resolution or color gamut) change, or if the image is displayed on a different screen that the one it was prepared for, it may not render correctly.

pub unsafe fn prepareForDisplayWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut UIImage)>, )

Available on crate feature block2 only.

Decodes an image asynchronously and provides a new one for display in views and animations.

The completion handler will be invoked on a private queue. Be sure to return to the main queue before assigning the prepared image to an image view.

Parameter completionHandler: A block to invoke with the prepared image. If preparation failed (for example, because the image data is corrupt), imagewill be nil.

Note: The prepared UIImage is not related to the original image. If the properties of the screen (such as its resolution or color gamut) change, or if the image is displayed on a different screen that the one it was prepared for, it may not render correctly.

pub unsafe fn imageByPreparingThumbnailOfSize( &self, size: CGSize, ) -> Option<Retained<UIImage>>

Available on crate feature objc2-core-foundation only.

pub unsafe fn prepareThumbnailOfSize_completionHandler( &self, size: CGSize, completion_handler: &DynBlock<dyn Fn(*mut UIImage)>, )

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

pub unsafe fn isHighDynamicRange(&self) -> bool

Indicates that this image is tagged for display of high dynamic range content.

pub unsafe fn imageRestrictedToStandardDynamicRange(&self) -> Retained<UIImage>

Returns a new image that will render within the standard range.

impl UIImage

Methods declared on superclass NSObject.

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

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

impl UIImage

PreconfiguredSystemImages.

pub unsafe fn actionsImage() -> Retained<UIImage>

pub unsafe fn addImage() -> Retained<UIImage>

pub unsafe fn removeImage() -> Retained<UIImage>

pub unsafe fn checkmarkImage() -> Retained<UIImage>

pub unsafe fn strokedCheckmarkImage() -> Retained<UIImage>

impl UIImage

This impl block contains no items.

NSItemProvider.

impl UIImage

UIImageDeprecated.

pub unsafe fn stretchableImageWithLeftCapWidth_topCapHeight( &self, left_cap_width: NSInteger, top_cap_height: NSInteger, ) -> Retained<UIImage>

pub unsafe fn leftCapWidth(&self) -> NSInteger

pub unsafe fn topCapHeight(&self) -> NSInteger

impl UIImage

pub unsafe fn png_representation(self: &UIImage) -> Option<Retained<NSData>>

return image as PNG. May return nil if image has no CGImageRef or invalid bitmap format

pub unsafe fn jpeg_representation( self: &UIImage, compression_quality: CGFloat, ) -> Option<Retained<NSData>>

Available on crate feature objc2-core-foundation only.

return image as JPEG. May return nil if image has no CGImageRef or invalid bitmap format. compression is 0(most)..1(least)

pub unsafe fn heic_representation(self: &UIImage) -> Option<Retained<NSData>>

Returns HEIC data representing the image, or nil if such a representation could not be generated. HEIC is recommended for efficiently storing all kinds of images, including those with high dynamic range content.

impl UIImage

pub unsafe fn write_to_saved_photos_album( self: &UIImage, completion_target: Option<&AnyObject>, completion_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate feature UIImagePickerController 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

Available on crate feature UIIndirectScribbleInteraction only.

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.

Available on crate feature UIIndirectScribbleInteraction only.

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,

Available on crate feature UIIndirectScribbleInteraction only.

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 UIImage

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIImage

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIImage> for UIImage

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIImage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIImage

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIImage

const NAME: &'static str = "UIImage"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<UIImage 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 UIImage

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

Formats the value using the given formatter.

impl Deref for UIImage

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIImage

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 UIImage

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIImage

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSItemProviderReading for UIImage

unsafe fn readableTypeIdentifiersForItemProvider() -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

unsafe fn objectWithItemProviderData_typeIdentifier_error( data: &NSData, type_identifier: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

where Self: Sized + ClassType,

impl NSItemProviderWriting for UIImage

unsafe fn writableTypeIdentifiersForItemProvider_class() -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

unsafe fn writableTypeIdentifiersForItemProvider( &self, ) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier_class( type_identifier: &NSString, ) -> NSItemProviderRepresentationVisibility

where Self: Sized + ClassType,

unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier( &self, type_identifier: &NSString, ) -> NSItemProviderRepresentationVisibility

where Self: Sized + Message,

impl NSObjectProtocol for UIImage

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 UIImage

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIImage

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 UIImage

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

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

impl DowncastTarget for UIImage

impl Eq for UIImage

impl Send for UIImage

impl Sync for UIImage