UIImage: Difference between revisions

Revision as of 09:13, 22 November 2009

UIImage is an Objective-C class that represents a bitmap image.

Undocumented methods

-_applicationIconImagePrecomposed: & -_smallApplicationIconImagePrecomposed:

From left to right: The original image; _applicationIconImagePrecomposed:NO; _applicationIconImagePrecomposed:YES; _smallApplicationIconImagePrecomposed:NO; _smallApplicationIconImagePrecomposed:YES

Available in	2.0 –
Signature	`-(UIImage*)_applicationIconImagePrecomposed:(BOOL)precomposed;`

Available in	2.0 –
Signature	`-(UIImage*)_smallApplicationIconImagePrecomposed:(BOOL)precomposed;`

These methods resize an image to icon size (59×59) or small icon size (29×29), clip out a rounded rectangle, draw shadows and apply a glossy overlay if required (when precomposed == NO), so that it resembles an icon.

If the input image is rectangular, the largest square portion in the top-left corner will be used.

_flatImageWithWhite:alpha:

Available in	2.0 –
Signature	`-(UIImage*)_flatImageWithWhite:(CGFloat)white alpha:(CGFloat)alpha;`

Create an image having the same size as the original image, but filled with the solid color as the parameters.

_bezeledImageWithRed:green:blue:alpha:

Available in	2.0 –
Signature	`-(UIImage*) _bezeledImageWithRed:(CGFloat)red green:(CGFloat)green blue:(CGFloat)blue alpha:(CGFloat)alpha;`

Create a solid white image having the same size as the original image, and then stroke the top 1px edge by the specified color.

_imageScaledToSize:interpolationQuality: & _imageScaledToProportion:interpolationQuality:

Available in	2.0 –
Signature	`-(UIImage*)_imageScaledToSize:(CGSize)newSize interpolationQuality:(CGInterpolationQuality)quality;`

Available in	2.0 –
Signature	`-(UIImage*)_imageScaledToProportion:(CGFloat)scale interpolationQuality:(CGInterpolationQuality)quality;`

Rescale the image to the new size.

+kitImageNamed:

Available in	2.0 –
Signature	`+(UIImage)kitImageNamed:(NSString)name;`

Equivalent to _UIImageWithName(name).

+defaultDesktopImage

Available in	2.0 –
Signature	`+(UIImage*)defaultDesktopImage;`

Return the user's lock screen image.

+setDesktopImageData:

Available in	2.0 –
Signature	`+(void)setDesktopImageData:(NSData*)jpegData;`

Replace the user's lock screen image by the given JPEG data.

Undocumented C functions

_UIImageWithName

Available in	2.0 –
Signature	`UIImage* _UIImageWithName(NSString* name);`

Obtain a built-in image. The name are stored in UIKit.framework/*.artwork. There are various ways to extract this information^[1]^[2]^[3], and you can grab a (slightly outdated) list from http://test.saurik.com/winterboard/UIImages.txt.

UIImageDataWriteToSavedPhotosAlbum

Available in	3.1 –
Signature	`void UIImageDataWriteToSavedPhotosAlbum(NSData* imageData, id target, SEL selector, void* context);`

Write the image data to photos album. This is similar to UIImageWriteToSavedPhotosAlbum function in the SDK, except that you can choose the image format (the extension will always be *.jpg, however).

References

↑ iPhoneShop http://code.google.com/p/iphoneshop/ – may not work on 3.x
↑ http://svn.saurik.com/repos/menes/trunk/winterboard/UIImages.mm
↑ http://code.google.com/p/networkpx/source/browse/etc/dump-artwork.m – Tested only on 3.x

Official documentation: http://developer.apple.com/iphone/library/documentation/uikit/reference/UIImage_Class/Reference/Reference.html
Extra header: http://github.com/kennytm/iphone-private-frameworks/blob/master/UIKit/UIImage2.h

[1] PhoneShop http://code.google.com/p/iphoneshop/ – may not work on 3.x

[2] ttp://svn.saurik.com/repos/menes/trunk/winterboard/UIImages.mm

[3] ttp://code.google.com/p/networkpx/source/browse/etc/dump-artwork.m – Tested only on 3.x

[1]

[2]

[3]

@@ Line 45: / Line 45: @@
 == Undocumented C functions ==
 === _UIImageWithName ===
-{{Function signature|signature=UIImage* _UIImageWithName(NSString* name);|firmware=2.0 – 3.1}}
+{{Function signature|signature=UIImage* _UIImageWithName(NSString* name);|firmware=2.0 –}}
 Obtain a built-in image. The name are stored in <tt>UIKit.framework/*.artwork</tt>. There are various ways to extract this information<ref>iPhoneShop http://code.google.com/p/iphoneshop/ – may not work on 3.x</ref><ref>http://svn.saurik.com/repos/menes/trunk/winterboard/UIImages.mm</ref><ref>http://code.google.com/p/networkpx/source/browse/etc/dump-artwork.m – Tested only on 3.x</ref>, and you can grab a (slightly outdated) list from http://test.saurik.com/winterboard/UIImages.txt.
 === UIImageDataWriteToSavedPhotosAlbum ===
-{{Function signature|signature=void UIImageDataWriteToSavedPhotosAlbum(NSData* imageData, id target, SEL selector, void* context);|firmware=3.1}}
+{{Function signature|signature=void UIImageDataWriteToSavedPhotosAlbum(NSData* imageData, id target, SEL selector, void* context);|firmware=3.1 –}}
 Write the image data to photos album. This is similar to [http://developer.apple.com/iPhone/library/documentation/UIKit/Reference/UIKitFunctionReference/Reference/reference.html#//apple_ref/doc/uid/TP40006894-CH3-SW29 UIImageWriteToSavedPhotosAlbum] function in the SDK, except that you can choose the image format (the extension will always be *.jpg, however).