Home > Articles > Mobile Application Development & Programming

This chapter is from the book

Using Bitmaps and Canvas

The Bitmap(android.graphics.Bitmap) class represents a bitmap image. Bitmaps are created via the BitmapFactory(android.graphics.BitmapFactory) class.

Three typical ways use BitmapFactory to create Bitmaps are to create a bitmap from a resource, file, or InputStream. To create a Bitmap from a resource, use the BitmapFactory method decodeResource():

Bitmap = BitmapFactory.decodeResource(getResources(), R.drawable.someImage);

The other two methods are similar to decodeResource(): decodeFile() and decodeStream().

Handling Large Images

There are techniques for avoiding the dreaded out-of-memory (OOM) exception. Large images can have a significant impact on memory use in your app. To demonstrate this, you’ll create an unrealistically large image to display in an ImageView. If the unmodified image is loaded into an ImageView, the app fails with an OOM error. A java.lang.OutOfMemory exception occurs. You’ll fix the memory error for this case by checking the image size and display side.

The idea is to display the image at an appropriate size for the device. There is no point in showing a 10-foot mural in a 6-inch frame. Similarly, there is no point in showing a 20-inch image on a 3-inch device screen. You will scale down the image size and save memory.

The details of your app will influence your memory usage and the techniques that will work best in your case. This example shows how to handle a single large image.

To demonstrate this, you’ll start with an image and increase it to an unrealistic size. You will use a photo that is 72 inches x 54 inches and that has a 28MB file size.

The image is in the drawable resource folder and has the id R.drawable.largeimage.

You can cause the app to fail with an OOM error by trying to set an ImageView to this resource. You have an ImageView named imageView. This line of code that causes the app to fail is this:

imageView.setImageResource(R.drawable.largeimage);

Some work is required, but it is possible to handle an image this large. In all cases, it would be better to work with appropriately sized images, but that does not always happen.

The approach is to get the dimensions of the underlying Bitmap without actually rendering it. Getting those dimensions is not a memory-intensive activity. Once you have the Bitmap, you can determine an appropriate size for the Bitmap that will fit in our display. If you have a 20-inch image and a 4-inch display, you’ll request that the Bitmap that is created in memory fill the 4-inch display.

Using BitmapFactory.Options

The BitmapFactory.Options class is used with the BitmapFactory class. It is essential for handling large bitmaps.

You’ll use the following options from the BitmapFactoryOptions class:

  • inJustDecodeBounds: If set to true, this option indicates that the Bitmap dimensions should be determined by the BitmapFactory but that the Bitmap itself should not be created. This is the key to getting the Bitmap dimensions without the memory overhead of creating the Bitmap.
  • outWidth: The width of the image set when inJustDecodeBounds is used.
  • outHeight: The height of the image set when inJustDecodeBounds is used.
  • inSampleSize: This integer indicates how much the dimensions of the Bitmap should be reduced. Given an image of 1000x400, an inSampleSize of 4 will result in a Bitmap of 250x100. The dimensions are reduced by a factor of 4.

Listing 11.3 shows the code to address this.

LISTING 11.3 Displaying a Large Image

 1: package com.talkingandroid.hour11application;
 2: import android.app.Activity;
 3: import android.graphics.Bitmap;
 4: import android.graphics.BitmapFactory;
 5: import android.os.Bundle;
 6: import android.view.Display;
 7: import android.widget.ImageView;
 8:
 9: public class LargeImageActivity extends Activity {
10:
11:     @Override
12:     protected void onCreate(Bundle savedInstanceState) {
13:         super.onCreate(savedInstanceState);
14:         setContentView(R.layout.activity_large_image);
15:         ImageView imageView = (ImageView) findViewById(R.id.imageView);
16:         Display display = getWindowManager().getDefaultDisplay();
17:         int displayWidth = display.getWidth();
18:         BitmapFactory.Options options = new BitmapFactory.Options();
19:         options.inJustDecodeBounds = true;
20:         BitmapFactory.decodeResource(getResources(), R.drawable.largeimage,
21:              options);
22:         int width = options.outWidth;
23:         if (width > displayWidth) {
24:             int widthRatio = Math.round((float) width / (float) displayWidth);
25:             options.inSampleSize = widthRatio;
26:         }
27:        options.inJustDecodeBounds = false;
28:        Bitmap scaledBitmap =  BitmapFactory.decodeResource(getResources(),
29:                               R.drawable.largeimage, options);
30:        imageView.setImageBitmap(scaledBitmap);
31:    }
32: }

On lines 16 and 17, you get the size of the device display. You’ll use this as the target size for reducing the image size.

On lines 18–22, you determine the size of the current Bitmap. You do that by creating a BitmapFactory.Options class and setting the inJustDecodeBounds value to true. On line 20, the Bitmap is decoded to get the dimensions. Using this method, you get the dimensions without the memory overhead of creating the Bitmap. The result is available in options.outWidth. On line 22, you assign options.outWidth to the int variable width.

In this example, you use a simple test for the size of the image. On line 23, you check whether the width of the Bitmap is greater than the size of the display. If that is the case, you must determine the inSampleSize to use. That is done on lines 24 and 25. If the width of the Bitmap is 1000 pixels and the size of the display is 250 pixels, you get an inSampleSize of 4 by dividing the width of the Bitmap by the width of the display. For simplicity, you are not checking the height.

With the imSampleSize set to an appropriate value, you can render the image.

On line 27, the inJustDecodeBounds value is set to false. That means the image will be decoded and a Bitmap object will be created.

Lines 28 and 29 use the BitmapFactory.decodeResource() method to actually decode the image and create the Bitmap. The bitmap is assigned to the variable scaledBitmap. It is important to note that in this call, the BitmapFactory.Options variable options is passed as a parameter. That is how you indicate to the BitmapFactory what inSampleSize to use. The value for options.inSampleSize was set on line 25.

It is certainly not recommended to display a 72-inch image on a device, but Figure 11.5 shows that it can be done!

Figure 11.5

FIGURE 11.5 Very large photo displayed on device.

Drawing Directly on a Canvas

There is one more thing that you can do with an ImageView and Bitmap. You’ll create a Bitmap and draw directly on the Canvas that is associated with the Bitmap. A Canvas is an object that you can draw on by calling drawing commands.

You will use an ImageView to display the Bitmap. You will also use an ImageView to determine the dimensions when creating the Bitmap and for drawing. In Listing 11.4, you draw the word “Hello” in the center of the screen.

LISTING 11.4 Drawing on a Canvas

 1: package com.talkingandroid.hour11application;
 2: import android.app.Activity;
 3: import android.graphics.Bitmap;
 4: import android.graphics.Canvas;
 5: import android.graphics.Color;
 6: import android.graphics.Paint;
 7: import android.os.Bundle;
 8: import android.view.View;
 9: import android.widget.Button;
10: import android.widget.ImageView;
11:
12: public class DrawActivity extends Activity {
13:     ImageView imageView;
14:     Button drawButton;
15:
16:     @Override
17:     protected void onCreate(Bundle savedInstanceState) {
18:         super.onCreate(savedInstanceState);
19:         setContentView(R.layout.activity_draw);
20:         imageView = (ImageView) findViewById(R.id.imageView);
21:         drawButton = (Button)findViewById(R.id.button);
22:         drawButton.setOnClickListener(new View.OnClickListener() {
23:             @Override
24:             public void onClick(View v) {
25:                 Bitmap imageBitmap = Bitmap.createBitmap(imageView.getWidth(),
26:                        imageView.getHeight(), Bitmap.Config.ARGB_8888);
27:                 Canvas canvas = new Canvas(imageBitmap);
28:                 float scale = getResources().getDisplayMetrics().density;
29:                 Paint p = new Paint();
30:                 p.setColor(Color.BLUE);
31:                 p.setTextSize(48*scale);
32:                 canvas.drawText("Hello", imageView. getWidth()/2,
33:                                  imageView.getHeight()/2, p);
34:                 imageView.setImageBitmap(imageBitmap);
35:             }
36:         });
37:     }
38: }

A new Bitmap is created on lines 25 and 26 by using the method Bitmap.createBitmap(). Note that the width and height of the bitmap are set using the width and height of the ImageView. The Bitmap.Config (android.graphics.Bitmap.Config) is set to Bitmap.Config.ARGB_8888.

When looking at the documentation for the Bitmap class, there are a number of createBitmap() methods that take different parameters. These methods may return a mutable or an immutable Bitmap. That is important; only a mutable Bitmap can be used for drawing.

On line 27, a Canvas is instantiated based on the Bitmap that you created.

Simple drawing commands are applied to the canvas in lines 28–33. You create a Paint object and set the Color to blue and set the text size. Line 28 gets the density of the display. That is used to set the text size properly. Recall that you previously learned about converting density independent pixels to pixels. On line 32, you draw the word “Hello” in the center of the Canvas.

On line 34, you update the ImageView to show your generated Bitmap.

Figure 11.6 shows the result.

Figure 11.6

FIGURE 11.6 Drawing on a Canvas.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020