Logo Search packages:      
Sourcecode: blender version File versions

IMG_PixmapRGBA32.h

/**
 * $Id: IMG_PixmapRGBA32.h,v 1.5 2002/12/27 13:10:19 mein Exp $
 *
 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. The Blender
 * Foundation also sells licenses for use in proprietary software under
 * the Blender License.  See http://www.blender.org/BL/ for information
 * about this.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
 * @author  Maarten Gribnau
 * @date    March 6, 2001
 */

#ifndef _H_IMG_PixmapRGBA32
#define _H_IMG_PixmapRGBA32

#include "IMG_Pixmap.h"
#include "IMG_MemPtr.h"

/**
 * Pixmap of kPixelTypeRGBA32 type.
 * A pixmap with 24 bits per pixel in ABGR format.
 * Provides methods to fill rectangular areas in this image with a color.
 * Provides methods to paste or blend other pixmaps into this pixmap.
 * @author  Maarten Gribnau
 * @date    March 6, 2001
 */

class IMG_PixmapRGBA32 : public IMG_Pixmap {
public:
      /**
       * The pixel type in this pixmap.
       */
00055       typedef TUns32 TPixelRGBA32;

      /** The pixel pointer type of this pixmap. */
00058       typedef TPixelRGBA32* TPixelPtr;

      /** Indices of color component byes within a pixel. */
00061       typedef enum {
            bi_r = 0,
            bi_g = 1,
            bi_b = 2,
            bi_a = 3
      } TPixelIndex;

      /** "Save" memory pointer. */
00069       IMG_MemPtr<TPixelRGBA32> m_mem;

      /**
       * Constructor.
       * Creates a new pixmap of the kPixelTypeRGBA32 type with the requested dimensions.
       * @throw <IMG_MemPtr::Size>  when an invalid width and/or height is passed.
       * @throw <IMG_MemPtr::Memory>      when a there is not enough memory to allocate the image.
       * @param   width the width in pixels of the image.
       * @param   height      the height in pixels of the image.
       */
      IMG_PixmapRGBA32(TUns32 width, TUns32 height);

      /**
       * Constructor.
       * Creates a new pixmap of the kPixelTypeRGBA32 from a pointer to image data.
       * The image data will not be freed upon destruction of this object.
       * The owner of this object is reponsible for that.
       * @throw <Size>  when an invalid width and/or height is passed.
       * @param   image pointer to the image data.
       * @param   width the width in pixels of the image.
       * @param   height      the height in pixels of the image.
       */
      IMG_PixmapRGBA32(void* image, TUns32 width, TUns32 height, TUns32 rowBytes);

#if 0
      /**
       * Destructor.
       */
      virtual     ~IMG_PixmapRGBA32();
#endif

      /**
       * Fills the rectangle given with the color given.
       * Retains the alpha values.
       * Performs a bounds check.
       * @param   r     requested bounds rectangle in the image
       * @param   c     color to use
       */
      virtual void fillRect(const IMG_Rect& r, const IMG_ColorRGB& c);

      /**
       * Fills the rectangle given with the color given.
       * Sets the alpha values from the color.
       * Performs a bounds check.
       * @param   r     requested bounds rectangle in the image
       * @param   c     color to use
       */
      virtual void fillRect(const IMG_Rect& r, const IMG_ColorRGBA& c);

      /**
       * Pastes a pixmap into this pixmap.
       * Pastes the given pixmap centered at the given coordinates into this pixmap.
       * Ignores the alpha information, this is pasted too.
       * @todo    implement wrapping modes when the pixmap does not fit within the bounds.
       * @param   x           x-coordinate of the center location of the image.
       * @param   y           y-coordinate of the center location of the image.
       * @param   pixmap      the pixmap to paste.
       */
      inline virtual void setPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap);

      /**
       * Pastes an area in a pixmap into this pixmap.
       * Pastes an area of the given pixmap centered at the given coordinates into this pixmap.
       * Ignores the alpha information, this is pasted too.
       * @todo    implement wrapping modes when the pixmap does not fit within the bounds.
       * @param   x           x-coordinate of the center location of the image.
       * @param   y           y-coordinate of the center location of the image.
       * @param   pixmap      the pixmap to paste.
       * @param   bnds  the bounds of the area of the pixmap to paste.
       */
      virtual     void setPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap, const IMG_Rect& bnds);

      /**
       * Blends a pixmap into this pixmap.
       * Blends the given pixmap centered at the given coordinates into this pixmap.
       * The alpha information in the given image is used to blend.
       * @todo    implement wrapping modes when the pixmap does not fit within the bounds.
       * @param   x           x-coordinate of the center location of the image.
       * @param   y           y-coordinate of the center location of the image.
       * @param   pixmap      the pixmap to blend.
       */
      virtual void blendPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap);

      /**
       * Blends an area of a pixmap into this pixmap.
       * Blends an area of the given pixmap centered at the given coordinates into this pixmap.
       * The alpha information in the given image is used to blend.
       * @todo    implement wrapping modes when the pixmap does not fit within the bounds.
       * @param   x           x-coordinate of the center location of the image.
       * @param   y           y-coordinate of the center location of the image.
       * @param   pixmap      the pixmap to blend.
       * @param   bnds  the bounds of the area of the pixmap to blend.
       */
      virtual void blendPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap, const IMG_Rect& bnds);

      /**
       * Blends a pixmap into this pixmap at (u,v) coordinates.
       * Pastes the given pixmap centered at the given coordinates into this pixmap.
       * The alpha information in the given image is used to blend.
       * @see           IMG_PixmapRGBA32::blendPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap)
       * @todo    implement wrapping modes when the pixmap does not fit within the bounds.
       * @param   u           u-coordinate of the center location of the image.
       * @param   v           v-coordinate of the center location of the image.
       * @param   pixmap      the pixmap to blend
       */
      virtual void blendPixmap(float u, float v, const IMG_PixmapRGBA32& pixmap);

protected:
      /**
       * Returns pointer to the pixel.
       * Returns a pointer of TPixelPtr type to the pixel at the requested coordinates.
       * Does not perform a bounds check!
       * @param   x     column address of the pixel.
       * @param   y     row address of the pixel.
       * @return  the pointer calculated.
       */
      inline TPixelPtr getPixelPtr(TUns32 x, TUns32 y) const;

      /**
       * Returns the pixel value of a color.
       * @param   c     the color to convert
       * @return  the pixel value calculated
       */
      inline TPixelRGBA32     getPixelValue(const IMG_ColorRGBA& c) const;

      /**
       * Returns the color of from a pixel value.
       * @param   p     the pixel value
       * @param   c     the color calculated
       */
      inline void getColor(TPixelRGBA32 p, IMG_ColorRGBA& c) const;
};

00202 inline void IMG_PixmapRGBA32::setPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap)
{
      IMG_Rect bnds;
      pixmap.getBounds(bnds);
      setPixmap(x, y, pixmap, bnds);
}

00209 inline void IMG_PixmapRGBA32::blendPixmap(TUns32 x, TUns32 y, const IMG_PixmapRGBA32& pixmap)
{
      IMG_Rect bnds;
      pixmap.getBounds(bnds);
      blendPixmap(x, y, pixmap, bnds);
}

00216 inline IMG_PixmapRGBA32::TPixelPtr IMG_PixmapRGBA32::getPixelPtr(TUns32 x, TUns32 y) const
{
      return (TPixelPtr) (((TUns8*)m_image) + (y*m_rowBytes) + (x*4));
}


inline IMG_PixmapRGBA32::TPixelRGBA32 IMG_PixmapRGBA32::getPixelValue(const IMG_ColorRGBA& c) const
{
#if 0
      // Obtain pixel value through shifting
      TPixelRGBA32 p = ((TPixelRGBA32) (((float) 0xFF) * c.m_a)) << 24;
      p |= ((TPixelRGBA32) (((float) 0xFF) * c.m_b)) << 16;
      p |= ((TPixelRGBA32) (((float) 0xFF) * c.m_g)) << 8;
      p |= ((TPixelRGBA32) (((float) 0xFF) * c.m_r));
      return p;
#else
      // Obtain pixel value through byte indexing
      TPixelRGBA32 pixel;
      TUns8* bytes = (TUns8*)&pixel;
      bytes[bi_r] = (TUns8)(((float) 0xFF) * c.m_r);
      bytes[bi_g] = (TUns8)(((float) 0xFF) * c.m_g);
      bytes[bi_b] = (TUns8)(((float) 0xFF) * c.m_b);
      bytes[bi_a] = (TUns8)(((float) 0xFF) * c.m_a);
      return pixel;
#endif
}

inline void IMG_PixmapRGBA32::getColor(TPixelRGBA32 p, IMG_ColorRGBA& c) const
{
#if 0
      // Obtain color value through shifting
      c.m_a = ((float) ((p >> 24) & 0x00FF)) / ((float) 0xFF);
      c.m_b = ((float) ((p >> 16) & 0x00FF)) / ((float) 0xFF);
      c.m_g = ((float) ((p >>  8) & 0x00FF)) / ((float) 0xFF);
      c.m_r = ((float) ( p        & 0x00FF)) / ((float) 0xFF);
#else
      // Obtain color value through byte indexing
      TUns8* bytes = (TUns8*)&p;
      c.m_r = ((float)bytes[bi_r]) / ((float) 0xFF);
      c.m_g = ((float)bytes[bi_g]) / ((float) 0xFF);
      c.m_b = ((float)bytes[bi_b]) / ((float) 0xFF);
      c.m_a = ((float)bytes[bi_a]) / ((float) 0xFF);
#endif
}

#endif // _H_IMG_PixmapRGBA32


Generated by  Doxygen 1.6.0   Back to index