include/nori/bitmap.h

Go to the documentation of this file.

/*
    This file is part of Nori, a simple educational ray tracer

    Copyright (c) 2012 by Wenzel Jakob and Steve Marschner.

    Nori is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License Version 3
    as published by the Free Software Foundation.

    Nori 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, see <http://www.gnu.org/licenses/>.
*/

#if !defined(__BITMAP_H)
#define __BITMAP_H

#include <nori/color.h>
#include <nori/vector.h>

NORI_NAMESPACE_BEGIN

/**
 * \brief Stores a RGB high dynamic-range bitmap
 *
 * The bitmap class provides I/O support using the OpenEXR file format
 */
class Bitmap : public Eigen::Array<Color3f, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> {
public:
        typedef Eigen::Array<Color3f, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> Base;

        /**
         * \brief Allocate a new bitmap of the specified size
         *
         * The contents will initially be undefined, so make sure
         * to call \ref clear() if necessary
         */
        Bitmap(const Vector2i &size) : Base(size.y(), size.x()) { }

        /// Load an OpenEXR file with the specified filename
        Bitmap(const QString &filename);

        /// Save the bitmap as an EXR file with the specified filename
        void save(const QString &filename);
};

NORI_NAMESPACE_END

#endif /* __BITMAP_H */