Struct NSBitmapImageRep

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

Available on crate features NSBitmapImageRep and NSImageRep only.

Apple’s documentation

Implementations

impl NSBitmapImageRep

pub unsafe fn initWithFocusedViewRect( this: Allocated<Self>, rect: NSRect, ) -> Option<Retained<Self>>

👎Deprecated: Use -[NSView cacheDisplayInRect:toBitmapImageRep:] to snapshot a view.

pub unsafe fn initWithBitmapDataPlanes_pixelsWide_pixelsHigh_bitsPerSample_samplesPerPixel_hasAlpha_isPlanar_colorSpaceName_bytesPerRow_bitsPerPixel( this: Allocated<Self>, planes: *mut *mut c_uchar, width: NSInteger, height: NSInteger, bps: NSInteger, spp: NSInteger, alpha: bool, is_planar: bool, color_space_name: &NSColorSpaceName, r_bytes: NSInteger, p_bits: NSInteger, ) -> Option<Retained<Self>>

Available on crate feature NSGraphics only.

pub unsafe fn initWithBitmapDataPlanes_pixelsWide_pixelsHigh_bitsPerSample_samplesPerPixel_hasAlpha_isPlanar_colorSpaceName_bitmapFormat_bytesPerRow_bitsPerPixel( this: Allocated<Self>, planes: *mut *mut c_uchar, width: NSInteger, height: NSInteger, bps: NSInteger, spp: NSInteger, alpha: bool, is_planar: bool, color_space_name: &NSColorSpaceName, bitmap_format: NSBitmapFormat, r_bytes: NSInteger, p_bits: NSInteger, ) -> Option<Retained<Self>>

Available on crate feature NSGraphics only.

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

Available on crate feature objc2-core-graphics and Apple only.

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

Available on crate feature objc2-core-image and Apple only.

pub unsafe fn imageRepsWithData(data: &NSData) -> Retained<NSArray<NSImageRep>>

pub unsafe fn imageRepWithData(data: &NSData) -> Option<Retained<Self>>

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

pub unsafe fn bitmapData(&self) -> *mut c_uchar

pub unsafe fn getBitmapDataPlanes(&self, data: NonNull<*mut c_uchar>)

pub unsafe fn isPlanar(&self) -> bool

pub unsafe fn samplesPerPixel(&self) -> NSInteger

pub unsafe fn bitsPerPixel(&self) -> NSInteger

pub unsafe fn bytesPerRow(&self) -> NSInteger

pub unsafe fn bytesPerPlane(&self) -> NSInteger

pub unsafe fn numberOfPlanes(&self) -> NSInteger

pub unsafe fn bitmapFormat(&self) -> NSBitmapFormat

pub unsafe fn getCompression_factor( &self, compression: *mut NSTIFFCompression, factor: *mut c_float, )

pub unsafe fn setCompression_factor( &self, compression: NSTIFFCompression, factor: c_float, )

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

pub unsafe fn TIFFRepresentationUsingCompression_factor( &self, comp: NSTIFFCompression, factor: c_float, ) -> Option<Retained<NSData>>

pub unsafe fn TIFFRepresentationOfImageRepsInArray( array: &NSArray<NSImageRep>, ) -> Option<Retained<NSData>>

pub unsafe fn TIFFRepresentationOfImageRepsInArray_usingCompression_factor( array: &NSArray<NSImageRep>, comp: NSTIFFCompression, factor: c_float, ) -> Option<Retained<NSData>>

pub unsafe fn getTIFFCompressionTypes_count( list: NonNull<*const NSTIFFCompression>, num_types: NonNull<NSInteger>, )

pub unsafe fn localizedNameForTIFFCompressionType( compression: NSTIFFCompression, ) -> Option<Retained<NSString>>

pub unsafe fn canBeCompressedUsing( &self, compression: NSTIFFCompression, ) -> bool

pub unsafe fn colorizeByMappingGray_toColor_blackMapping_whiteMapping( &self, mid_point: CGFloat, mid_point_color: Option<&NSColor>, shadow_color: Option<&NSColor>, light_color: Option<&NSColor>, )

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

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

pub unsafe fn incrementalLoadFromData_complete( &self, data: &NSData, complete: bool, ) -> NSInteger

pub unsafe fn setColor_atX_y(&self, color: &NSColor, x: NSInteger, y: NSInteger)

Available on crate feature NSColor only.

pub unsafe fn colorAtX_y( &self, x: NSInteger, y: NSInteger, ) -> Option<Retained<NSColor>>

Available on crate feature NSColor only.

pub unsafe fn getPixel_atX_y( &self, p: NonNull<NSUInteger>, x: NSInteger, y: NSInteger, )

pub unsafe fn setPixel_atX_y( &self, p: NonNull<NSUInteger>, x: NSInteger, y: NSInteger, )

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

Available on crate feature objc2-core-graphics and Apple only.

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

Available on crate feature NSColorSpace only.

pub unsafe fn bitmapImageRepByConvertingToColorSpace_renderingIntent( &self, target_space: &NSColorSpace, rendering_intent: NSColorRenderingIntent, ) -> Option<Retained<NSBitmapImageRep>>

Available on crate features NSColorSpace and NSGraphics only.

pub unsafe fn bitmapImageRepByRetaggingWithColorSpace( &self, new_space: &NSColorSpace, ) -> Option<Retained<NSBitmapImageRep>>

Available on crate feature NSColorSpace only.

impl NSBitmapImageRep

Methods declared on superclass NSImageRep.

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

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

impl NSBitmapImageRep

Methods declared on superclass NSObject.

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

impl NSBitmapImageRep

NSBitmapImageFileTypeExtensions.

pub unsafe fn representationOfImageRepsInArray_usingType_properties( image_reps: &NSArray<NSImageRep>, storage_type: NSBitmapImageFileType, properties: &NSDictionary<NSBitmapImageRepPropertyKey, AnyObject>, ) -> Option<Retained<NSData>>

pub unsafe fn representationUsingType_properties( &self, storage_type: NSBitmapImageFileType, properties: &NSDictionary<NSBitmapImageRepPropertyKey, AnyObject>, ) -> Option<Retained<NSData>>

pub unsafe fn setProperty_withValue( &self, property: &NSBitmapImageRepPropertyKey, value: Option<&AnyObject>, )

pub unsafe fn valueForProperty( &self, property: &NSBitmapImageRepPropertyKey, ) -> Option<Retained<AnyObject>>

Methods from Deref<Target = NSImageRep>

pub unsafe fn draw(&self) -> bool

pub unsafe fn drawAtPoint(&self, point: NSPoint) -> bool

pub unsafe fn drawInRect(&self, rect: NSRect) -> bool

pub unsafe fn drawInRect_fromRect_operation_fraction_respectFlipped_hints( &self, dst_space_portion_rect: NSRect, src_space_portion_rect: NSRect, op: NSCompositingOperation, requested_alpha: CGFloat, respect_context_is_flipped: bool, hints: Option<&NSDictionary<NSImageHintKey, AnyObject>>, ) -> bool

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

pub unsafe fn size(&self) -> NSSize

pub unsafe fn setSize(&self, size: NSSize)

Setter for size.

pub unsafe fn hasAlpha(&self) -> bool

pub unsafe fn setAlpha(&self, alpha: bool)

Setter for hasAlpha.

pub unsafe fn isOpaque(&self) -> bool

pub unsafe fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub unsafe fn colorSpaceName(&self) -> Retained<NSColorSpaceName>

Available on crate feature NSGraphics only.

pub unsafe fn setColorSpaceName(&self, color_space_name: &NSColorSpaceName)

Available on crate feature NSGraphics only.

Setter for colorSpaceName.

pub unsafe fn bitsPerSample(&self) -> NSInteger

pub unsafe fn setBitsPerSample(&self, bits_per_sample: NSInteger)

Setter for bitsPerSample.

pub unsafe fn pixelsWide(&self) -> NSInteger

pub unsafe fn setPixelsWide(&self, pixels_wide: NSInteger)

Setter for pixelsWide.

pub unsafe fn pixelsHigh(&self) -> NSInteger

pub unsafe fn setPixelsHigh(&self, pixels_high: NSInteger)

Setter for pixelsHigh.

pub unsafe fn layoutDirection(&self) -> NSImageLayoutDirection

pub unsafe fn setLayoutDirection( &self, layout_direction: NSImageLayoutDirection, )

Setter for layoutDirection.

pub unsafe fn CGImageForProposedRect_context_hints( &self, proposed_dest_rect: *mut NSRect, context: Option<&NSGraphicsContext>, hints: Option<&NSDictionary<NSImageHintKey, AnyObject>>, ) -> Option<Retained<CGImage>>

Available on crate feature NSGraphicsContext and crate feature objc2-core-graphics and Apple 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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSBitmapImageRep

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSBitmapImageRep> for NSBitmapImageRep

fn as_ref(&self) -> &Self

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

impl AsRef<NSImageRep> for NSBitmapImageRep

fn as_ref(&self) -> &NSImageRep

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

impl AsRef<NSObject> for NSBitmapImageRep

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSBitmapImageRep

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSImageRep> for NSBitmapImageRep

fn borrow(&self) -> &NSImageRep

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSBitmapImageRep

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSBitmapImageRep

const NAME: &'static str = "NSBitmapImageRep"

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

type Super = NSImageRep

The superclass of this class.

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

type Result = NSBitmapImageRep

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

impl Debug for NSBitmapImageRep

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

Formats the value using the given formatter.

impl Deref for NSBitmapImageRep

type Target = NSImageRep

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSBitmapImageRep

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 NSBitmapImageRep

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSBitmapImageRep

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 NSCopying for NSBitmapImageRep

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 NSBitmapImageRep

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 NSBitmapImageRep

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSBitmapImageRep

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 NSBitmapImageRep

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

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

impl DowncastTarget for NSBitmapImageRep

impl Eq for NSBitmapImageRep