subPixel.h

/* Copyright (c) 2009-2011, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2009, Sarah Amsellem <sarah.amsellem@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQFABRIC_SUBPIXEL_H
#define EQFABRIC_SUBPIXEL_H

#include <eq/fabric/api.h>
#include <co/base/log.h>
#include <co/base/types.h>

namespace eq
{
namespace fabric
{
    class SubPixel;
    std::ostream& operator << ( std::ostream& os, const SubPixel& subPixel );

    class SubPixel
    {
    public:
        SubPixel() : index( 0 ), size( 1 )  {}

        SubPixel( const uint32_t index_, const uint32_t size_ )
                : index( index_ ), size( size_ ) {}

        void apply( const SubPixel& rhs )
        {
            if( !isValid() || !rhs.isValid( ))
                return;

            index = index * rhs.size + rhs.index;
            size  *= rhs.size;
        }

        bool operator == ( const SubPixel& rhs ) const
        {
            return index==rhs.index && size==rhs.size;
        }

        bool operator != ( const SubPixel& rhs ) const
        {
            return index != rhs.index || size != rhs.size;
        }

        void invalidate() { index = size = 0; }

        void validate()
        {
            if( isValid( )) return;
            EQWARN << "Invalid " << *this << std::endl;
            if( index >= size ) index = 0;
            if( size == 0 )     size = 1;
            EQWARN << "Corrected " << *this << std::endl;
        }

        bool isValid() const { return ( index < size ); }

        uint32_t index; 
        uint32_t size;  

        EQFABRIC_API static const SubPixel ALL;
    };

    inline std::ostream& operator << ( std::ostream& os,
                                       const SubPixel& subPixel )
    {
        if( subPixel.isValid( ))
            os << "subpixel  [ " << subPixel.index << ' ' << subPixel.size
               << " ]";
        return os;
    }
}
}

#endif // EQFABRIC_SUBPIXEL_H