bmapdata.h

Go to the documentation of this file.

//
// Copyright (c) 2000-2004 California Institute of Technology
// Copyright (c) 2004-2007 University of Southern California
// Rob Peters <rjpeters at usc dot edu>
//
// created: Wed Jan 19 17:25:51 2000
// commit: $Id: bmapdata.h 10065 2007-04-12 05:54:56Z rjpeters $
// $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/media/bmapdata.h $
//
// --------------------------------------------------------------------
//
// This file is part of GroovX.
//   [http://ilab.usc.edu/rjpeters/groovx/]
//
// GroovX 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.
//
// GroovX 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 GroovX; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
//

#ifndef GROOVX_MEDIA_BMAPDATA_H_UTC20050626084018_DEFINED
#define GROOVX_MEDIA_BMAPDATA_H_UTC20050626084018_DEFINED

namespace rutz
{
  template <class T> class shared_ptr;
}

namespace geom
{
  template <class V> class vec2;
}

namespace media
{



  class bmap_data
  {
  public:
    class update_func
    {
    public:
      virtual ~update_func();

      virtual void update(bmap_data& update_me) = 0;
    };

    enum row_order
      {
        TOP_FIRST,
        BOTTOM_FIRST
      };

    //---------------------------------------------------------
    //
    // Creators
    //
    //---------------------------------------------------------

    bmap_data();

    bmap_data(const geom::vec2<int>& dims,
              int bits_per_pixel,
              int byte_alignment);

    bmap_data(const bmap_data& other);

    bmap_data& operator=(const bmap_data& other)
    {
      bmap_data copy(other);
      this->swap(copy);
      return *this;
    }

    ~bmap_data();

    //---------------------------------------------------------
    //
    // Accessors
    //
    //---------------------------------------------------------

    unsigned char* bytes_ptr() const;


    unsigned char* row_ptr(unsigned int row) const;

    long int bytes_sum() const;

    int width() const;

    int height() const;

    geom::vec2<int> size() const;

    int bits_per_pixel() const;


    int bits_per_component() const;


    int byte_alignment() const;


    unsigned int byte_count() const;

    unsigned int bytes_per_row() const;

    row_order get_row_order() const;

    //---------------------------------------------------------
    //
    // Manipulators
    //
    //---------------------------------------------------------

    void flip_contrast();

    void flip_vertical();

    void clear();

    void swap(bmap_data& other);


    void queue_update(rutz::shared_ptr<update_func> updater) const;

    void update_if_needed() const;

    void clear_queued_update() const;


    void set_row_order(row_order order) const;

    void specify_row_order(row_order order) const;

    rutz::shared_ptr<bmap_data>
    make_scrambled(int numsubcols, int numsubrows,
                   int seed,
                   bool allow_move_subparts = true,
                   bool allow_flip_left_right = true,
                   bool allow_flip_top_bottom = true) const;

  private:
    class impl;
    impl* rep;
  };

} // end namespace media

static const char __attribute__((used)) vcid_groovx_media_bmapdata_h_utc20050626084018[] = "$Id: bmapdata.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
#endif // !GROOVX_MEDIA_BMAPDATA_H_UTC20050626084018_DEFINED

---

The software described here is Copyright (c) 1998-2005, Rob Peters.
This page was generated Wed Dec 3 06:49:39 2008 by Doxygen version 1.5.5.