Image.h

00001 /* NeatGUI Library
00002  * Copyright (c) 2013 Neil Thiessen
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef IMAGE_H
00018 #define IMAGE_H
00019 
00020 #include "mbed.h"
00021 
00022 /** Image abstract class.
00023  *  Used as a base class for image objects.
00024  */
00025 class Image
00026 {
00027 public:
00028     /** Create an Image object with the specified width and height
00029      *
00030      * @param w The image width.
00031      * @param h The image height.
00032      */
00033     Image(int w, int h);
00034 
00035     /** Get the pixel at the specified coordinates
00036     *
00037     * @param x The X coordinate.
00038     * @param y The Y coordinate.
00039     *
00040     * @returns The color of the pixel as a 32-bit ARGB value.
00041     */
00042     virtual unsigned int pixel(int x, int y) = 0;
00043 
00044     /** Get the image width
00045      *
00046      * @returns The image width.
00047      */
00048     int width();
00049 
00050     /** Get the image height
00051      *
00052      * @returns The image height.
00053      */
00054     int height();
00055 
00056 protected:
00057     //The image width/height
00058     int m_Width, m_Height;
00059 };
00060 
00061 #endif