framebuffer.h

Go to the documentation of this file.

/*
    toxic - A Global Illumination Renderer
    Copyright (C) 2003-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of toxic.

    toxic 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.

    toxic 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 toxic; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef TOXIC_RENDERER_FRAMEBUFFER_H
#define TOXIC_RENDERER_FRAMEBUFFER_H

#include "common/math/point2.h"
#include "common/math/real.h"
#include "common/misc/types.h"
#include "color3.h"
#include "globals.h"

#include <algorithm>    // std::min<>(), std::max<>()
#include <cassert>
#include <string>

namespace toxic {

    class Framebuffer {
    public:
        enum Format {
            RGB_FLOAT_32    //!< RGB format, each channel is coded as 32-bit float.
        };

        Framebuffer(int width, int height, Format format);
        ~Framebuffer();

        int GetWidth() const;
        int GetHeight() const;
        int GetPixels() const;

        //! Returns the size (in bytes) of the framebuffer in memory.
        int GetSizeInMemory() const;

        //! Returns the dimensions of a pixel.
        sheep::Real GetPixelWidth() const;
        sheep::Real GetPixelHeight() const;

        //! Converts from pixel coordinates to NDC (see file renderer/camera.h).
        //! Returns NDC of the center of the pixel located at (x, y).
        sheep::Point2 ConvertToNDC(int x, int y) const;

        //! Converts from NDC to pixel coordinates.
        void ConvertFromNDC(const sheep::Point2 &p, int *x, int *y) const;

        //! Clears the framebuffer with a given color.
        void Clear(Color3 color = Color3(0.0));

        Color3 GetPixel(int x, int y) const;
        void SetPixel(int x, int y, const Color3 &color);

        void PlotLine(int x1, int y1, int x2, int y2, const Color3 &color);

        //! Maps pixel values to the [0..1] interval.
        void Normalize();

        //!\todo Implement a complete tone mapping architecture.
        void CorrectGamma(sheep::Real target_gamma);

        //! Returns true if success, false otherwise.
        bool WriteToDisk(const std::string &filename) const;

    private:
        int m_width, m_height;          //!< Dimensions of the framebuffer, in pixels.
        int m_pixels;                   //!< Total number of pixels, which is equal to m_width * m_height.
        Format m_format;                //!< Format of the framebuffer.

        struct pixel_rgb_float_32 {     //!< Structure of a pixel for the RGB_FLOAT_32 format.
            sheep::float32 m_r, m_g, m_b;
        };

        union {
            pixel_rgb_float_32 *m_rgb_float_32;
        } m_bits;

        sheep::Real m_inv_width;        //!< m_inv_width = 1.0 / m_width.
        sheep::Real m_inv_height;       //!< m_inv_height = 1.0 / m_height.
        sheep::Real m_half_inv_width;   //!< m_half_inv_width = 1.0 / (2.0 * m_width).
        sheep::Real m_half_inv_height;  //!< m_half_inv_height = 1.0 / (2.0 * m_height).
    };

#include "framebuffer.inl"

}

#endif  // !TOXIC_RENDERER_FRAMEBUFFER_H

---