statistics.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_STATISTICS_H
#define TOXIC_RENDERER_STATISTICS_H

#include "common/misc/types.h"
#include "globals.h"

namespace toxic {

    class Statistics {
    public:
        //! Pixels.
        sheep::int64 m_total_pixels;                    //!< Total number of pixels rendered.

        //! Photons.
        //!\todo These numbers are useless: photon maps already know how many photons they hold.
        sheep::int64 m_gpm_photons;                     //!< Total number of photons in the global photon map.
        sheep::int64 m_cpm_photons;                     //!< Total number of photons in the caustics photon map.

        //! Rays.
        sheep::int64 m_primary_rays;                    //!< Total number of primary rays (rays traced from the camera).
        sheep::int64 m_secondary_rays;                  //!< Total number of secondary rays (rays traced for specular reflections).
        sheep::int64 m_shadow_rays;                     //!< Total number of shadow rays.
        sheep::int64 m_photon_rays;                     //!< Total number of rays traced to transport photons (caustics and global).
        sheep::int64 m_primary_final_gathering_rays;    //!< Total number of rays traced for primary final gathering.
        sheep::int64 m_secondary_final_gathering_rays;  //!< Total number of rays traced for secondary final gathering.

        //! Intersections.
        sheep::int64 m_tested_intersections;            //!< Total number of intersection tests (with primitives only).
        sheep::int64 m_intersections_found;             //!< Number of successful intersection tests (with primitives only).

        Statistics();

        //! Resets all counters.
        void Reset();

        //! Computes and returns the total number of rays cast during rendering phase
        //! (thus excluding photon rays).
        sheep::int64 ComputeTotalRays() const;
    };

#include "statistics.inl"

}

#endif  // !TOXIC_RENDERER_STATISTICS_H

---