56

I am pretty new to iOS and Xcode.

I tried to load an image with

[UIImage imageNamed:@"imageName.png/jpg and so on"];

but it only returns nil. The image should be in my project bundle, considering the fact that I can choose it from drag and drop menus in the InterfaceBuilder and it was added to Xcode via the "Add files to "projectname"..." menu.

It makes no difference whether I use .png or .jpg images, the result stays the same: they work via IB but not if I try to run the imageNamed method myself.

ROMANIA_engineer
  • 54,432
  • 29
  • 203
  • 199
arne somborn
  • 689
  • 1
  • 7
  • 9

20 Answers20

97

There are only a few reasons why an image would come back nil with imageNamed:

  • The image is not in your bundle. Make sure the image is actually in your project. Make sure the target is checked by clicking on the file and selecting the target it belongs to.

  • You have the image name spelled incorrectly or a problem with the extension.

  • You are using a retina display but do not have an @2x image. Try changing your simulator to retina and see if it shows up.

  • If you are using an asset catalog make sure you have the correct devices selected in the attribute inspector.

Some tips:

If you are testing using simulator delete the app off of your simulator and clean your project, then re-run. If it still shows up it should show up on your phone (if it doesn't it's probably an issue with the case of the filename or the @2x version).

If you are testing on your phone and it doesn't show up, make sure you are using the same version of the simulator (if you have an iPhone 4/4s make sure to use the 4/4s simulator with retina).

One last thing according to this post: JPG image doesn't load with UIImage imageNamed There is some issue with certain JPG types working with imageNamed and no extension. IMO, you should be using PNGs anyway since iOS compresses them for you, unless you just have to use JPG.

Murray Sagal
  • 8,454
  • 4
  • 47
  • 48
Matt Hudson
  • 7,329
  • 5
  • 49
  • 66
  • Sry for my late answer - I was sick and just got back to work today. I tried rewriting and recompiling the code and suddenly it worked! I am still not exactly sure as about why it does/didn't before, but thanks a lot for all the help! – arne somborn Jun 15 '12 at 06:42
  • 4
    I had to delete the app, but that alone did not fix the problem. After doing product -> clean, I was able to see the correct images – aryaxt Nov 04 '12 at 17:02
  • You are 100% right! I had the same problem and it was because I didn't have the @2x file. – Hola Soy Edu Feliz Navidad Aug 02 '13 at 09:15
  • 1
    Haven't had any `.jpg` files in my bundle for like... ever? Copied one for testing purposes, lost prolly a half an hour wondering why my image wasn't loading. Up vote for bringing up the `.jpg` extension problem - even though I figured it out myself. – nemesis Aug 06 '13 at 18:32
  • Nemesis! You're back! haha.. we've crossed paths here before. – Matt Hudson Aug 06 '13 at 20:15
  • I had checked all of these and they didn't work for my particular case. What worked for me was to set COMBINE_HIDPI_IMAGES to NO in the static library where the image resided. (http://stackoverflow.com/questions/5664787/load-image-from-bundle-with-ios) – Matt Becker Oct 28 '13 at 14:57
  • 1
    It seems that iOS 7 has a problem with JPG images while iOS 8 doesn't so it happened to me and fixed it by converting the images into PNG – Boda Feb 18 '15 at 10:50
  • Even after 6 years, deleting the app from the simulator was still the solution for me. Note that this also works when you encounter this using `#imageLiteral` in Xcode 10. – Jordan May 18 '19 at 12:33
  • The different retina version point you made above fixed it for me. I was using a 1x resolution and that's why it wasn't showing. having a 3x one sorted it out. Thanks a lot :) – Septronic Jun 06 '21 at 12:34
20

Re Mike Weller's comment. The checkbox is ....

enter image description here

Damo
  • 12,840
  • 3
  • 51
  • 62
  • 1
    thanks a lot, found that myself after rereading the comment. It is checked though and sadly does not change the behaviour. – arne somborn Jun 12 '12 at 14:29
19

If you verified all of the above and are finding that your UIImage(named: "myImage") returns nil from code inside of a dynamic framework you are building, then you have to change the code to:

UIImage(named: "myImage", in: Bundle(identifier: "com.myframework.name"), compatibleWith: nil)

This should retrieve the asset from CXAssets correctly.

Travis M.
  • 10,930
  • 1
  • 56
  • 72
  • 2
    This saved my day when dealing with dynamic frameworks. I added a class method to ease out the bundle retrieval: `+(NSBundle*)currentBundle { static dispatch_once_t predicate = 0; static NSBundle *myBundle = nil; dispatch_once(&predicate, ^{ myBundle = [NSBundle bundleWithIdentifier:@"yourbundle.identifier"]; }); return myBundle; }` – Lookaji Mar 26 '17 at 21:40
  • Is it possible to load an image like this from Interface Builder? – Eduard Jan 16 '19 at 11:15
  • When using a framework compiled inside another project in Xcode, this was the only way to get the image to load when called from within the framework. – Locutus May 03 '20 at 16:32
16

In my case, the PNG was malformed.

For some reason Xcode preview shown it correctly, but when I tried loading it with UIImage, it returned nil.

Kof
  • 23,893
  • 9
  • 56
  • 81
  • 1
    You save my day! I ran into similar situation by changing image file extension from .psd to .png and expect it to work as proper png file.. Somehow Xcode lets me preview the image correctly.. That's evil – Philip007 Feb 20 '13 at 16:55
  • Just had the same issue. The original file was a JPEG which was re-saved as a PNG. On the simulator it worked fine but on an actual device the image would always return nil. – psobko Apr 22 '14 at 17:51
  • Thank you!! Something along these lines was the issue for me. I wouldn't say malformed for my case since the image is truly a PNG and is used everywhere else (native Android, cross-platform desktop, desktop and mobile web including iOS Safari) without issue, but UIImage kept returning nil. I opened it up in Photoshop and then exported it as a PNG overwriting the file in question and now it works. Just preposterous. – jack Dec 11 '19 at 13:58
10

I just had this issue for jpg files named on disk "file.jpg"

I was trying to load without the extension, just @"file". While this works fine for pngs, it does not for jpg. Once I used @"file.jpg", it worked!

clocksmith
  • 6,226
  • 3
  • 32
  • 45
5

Swift 5

If you get UIImage nil in dynamic framework, you should set image with bundle identifier.

You can create an extension to Bundle like this;

  • Create an extension;

    extension Bundle {
        public static let myFramework = Bundle(identifier: "com.myFramework.bundle")
    }
    
  • Then you can use like this;

    UIImage(named: "myImageName", in: Bundle.myFramework, compatibleWith: nil)
    

Or

You can use like this;

UIImage(named: "myImageName", in: Bundle(for: type(of: self)), compatibleWith: nil)

I think the first one is more useful because it's more readable than second one.

emrcftci
  • 3,355
  • 3
  • 21
  • 35
2

Try re-exporting your image.

I had a similar problem, UIImage imageNamed was returning nil and none of these answers fixed my problem.

I found out that it was actually something wrong with the png file. I opened the file in GIMP image editor, saved it as a new file, exported it again as png and magically it started working.

I didn't change anything in code at all so there was definitely something wrong with the actual image file.

Kage
  • 765
  • 1
  • 8
  • 27
  • I keep having the opposite problem, where if I export with GIMP it doesn't work. But if I export it with something else I can get it working. – Chase Roberts Oct 01 '19 at 10:53
1

try

[UIImage imageNamed:@"imageName.png"];

instead (with an extension)

iMx
  • 846
  • 1
  • 9
  • 23
  • @Mike Weller : Prior to iOS 4, you must specify the filename extension. – iMx Jun 12 '12 at 14:22
  • 3
    in defence of iMx: I didn't mention trying that when I first posted the question, thought that would be to obvious ;) – arne somborn Jun 12 '12 at 14:24
  • @arnesomborn there are some posible reasons: [link](http://stackoverflow.com/questions/9698583/iphone-uiimage-imagenamed-doesnt-show-the-image/9698764#9698764) – iMx Jun 12 '12 at 14:49
1

I had the same problem: @"photo.jpg" resulted in 'nil' UIImage. Changing to the "actual" filespec, @"photo.JPG" works fine! I hadn't realized there was case-sensitivity there! VERY non-intuitive.

Jim
  • 33
  • 8
1

i had a similar issue, finally the cleanup fixed it: the image showed up in the simulator, but id did not show up when running the app on the iPhone.
What I did: 1) deleted the app from the iPhone 2) performed Product/Clean after that the bug was fixed and the image showed up!

iHux
  • 11
  • 1
1

Try to use UIImage(contentsOfFile:) instead of imageNamed. It worked for me with downloaded images.

superarts.org
  • 7,009
  • 1
  • 58
  • 44
1

Check that file has no space at the end. The name like name @2x.png will fail loading, but name@2x.png is fine

akaDuality
  • 384
  • 5
  • 6
0

Does the image work on the simulator but not on the device?

If so, in this scenario it is always to do with the case of the name. The device requires exact case and the simulator is not so fussy if I remember correctly.

e.g. for an image named image.png

[UIImage imageNamed:@"Image"];

would work on the simulator but not on the device...

Damo
  • 12,840
  • 3
  • 51
  • 62
  • 1
    That's not because the simulator is less fuzzy but because by default HFS+ (the OS X file system) is case-insensitive. That means it considers `aa`, `AA`, `aA`, and `Aa` to be the same file. You can format a new HD with HFS+ and decide to make it case-sensitive (Disk Utility gives you that choice) but Macs ship with a pre-formatted HD that is never case-sensitive. Many Mac programmers pay no attention and then their app will break on Macs whose owner re-formatted their HD to be case sensitive; which is possible if you re-install your system from scratch. – Mecki Apr 24 '14 at 16:41
0

Make sure you have the image for the DEVICE you are using in your .xcassets file. An image flagged for iPad won't show up on the phone (or the simulated phone).

Venture
  • 41
  • 3
0

In addition to @Inturbidus's answer: For those who came here working on Application Extensions:

The image you are working with should belongs to both targets - hosted app and extension.

In other case you'll always getting nil trying to access it from within the extension's code.

slxl
  • 635
  • 1
  • 10
  • 23
0

For Xcode 6.4, click on Images.xcassets and check whether there are entries for each image that you called. You may right-click on the image and select "Show in Finder" to check if the images are the correct ones added.

Arunabh Das
  • 13,212
  • 21
  • 86
  • 109
0

Make sure the Attributes Inspector name field of the image matches exactly the name you're using. In my case the image was part of a folder and so the image name was "folder/name". Using this long name solved the problem. XCode 7.3.1

andrewz
  • 4,729
  • 5
  • 49
  • 67
0

In my case, using a name with accented characters proved to be a poor idea. I changed Astéroïdes to Asteroids and it worked fine.

Huibert
  • 63
  • 4
0

In my case problem was with image name in asset catalog. For example if you have image with name "TEst" and change name to "Test", changes won't be indexed. If your teammate will pull commit with this changes, image in his asset catalog will have previous name "TEst". Very small chance to catch this situation but it's possible.

Hot'n'Young
  • 491
  • 4
  • 12
0

I had multiple .xcassets in my projects and 2 had duplicate name of images. So it was not loading the image in my case.

user1039695
  • 981
  • 11
  • 20