OSDLLine.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL 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 and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */



#ifndef OSDL_LINE_H_
#define OSDL_LINE_H_


#include "OSDLTypes.h"   // for Coordinate, etc.
#include "OSDLPixel.h"   // for Pixels::put, Pixels::Pixel


#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

#include "SDL.h"             // for ColorDefinition

#endif // OSDL_USES_SDL



namespace OSDL
{

    
    
    namespace Video
    {



        // Lines are drawn into Surfaces.
        class Surface ;
                
        
        
        namespace TwoDimensional
        {
        
        
        
            class Point2D ;
            
        
        
            namespace Line
            {
    
    
                /*
                 * Methods could be inlined in a dedicated file for faster
                 * processing.
                 *
                 */
    
    
                OSDL_DLL bool drawHorizontal( Surface & targetSurface, 
                    Coordinate xStart, Coordinate xStop, Coordinate y, 
                    Pixels::ColorElement red, Pixels::ColorElement green, 
                    Pixels::ColorElement blue, 
                    Pixels::ColorElement alpha = Pixels::AlphaOpaque ) ;
    
    
    
                OSDL_DLL bool drawHorizontal( Surface & targetSurface, 
                    Coordinate xStart, Coordinate xStop, Coordinate y, 
                    Pixels::PixelColor actualColor ) ;
    
    
    
                OSDL_DLL bool drawHorizontal( Surface & targetSurface, 
                    Coordinate xStart, Coordinate xStop, Coordinate y, 
                    Pixels::ColorDefinition = Pixels::White ) ;
    
    
    
                OSDL_DLL bool drawVertical( Surface & targetSurface, 
                    Coordinate x, Coordinate yStart, Coordinate yStop, 
                    Pixels::ColorElement red, Pixels::ColorElement green, 
                    Pixels::ColorElement blue, 
                    Pixels::ColorElement alpha = Pixels::AlphaOpaque ) ;
    
    
    
                OSDL_DLL bool drawVertical( Surface & targetSurface, 
                    Coordinate x, Coordinate yStart, Coordinate yStop, 
                    Pixels::ColorDefinition = Pixels::White ) ;



                /*
                 * There is no drawVertical with PixelColor, as the SDL_gfx 
                 * back-end does not provide it.
                 *
                 */
                
                
                
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Coordinate xStart, Coordinate yStart, 
                    Coordinate xStop, Coordinate yStop, 
                    Pixels::ColorElement red, Pixels::ColorElement green, 
                    Pixels::ColorElement blue, 
                    Pixels::ColorElement alpha = Pixels::AlphaOpaque ) ;
    
    
    
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Coordinate xStart, Coordinate yStart, 
                    Coordinate xStop, Coordinate yStop, 
                    Pixels::ColorDefinition colorDef = Pixels::White ) ;
                    
                    
                    
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Point2D & firstPoint, Point2D & secondPoint,
                    Pixels::ColorElement red, Pixels::ColorElement green, 
                    Pixels::ColorElement blue, 
                    Pixels::ColorElement alpha = Pixels::AlphaOpaque ) ;
                    
                    
                    
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Point2D & firstPoint, Point2D & secondPoint,
                    Pixels::ColorDefinition colorDef = Pixels::White ) ;
                
                
                
                OSDL_DLL bool drawCross( Surface & targetSurface, 
                    const Point2D & center,
                    Pixels::ColorDefinition colorDef = Pixels::White, 
                    Length squareEdge = 5 ) ;
                    
                    
                    
                OSDL_DLL bool drawCross( Surface & targetSurface, 
                    Coordinate xCenter, Coordinate yCenter,
                    Pixels::ColorDefinition colorDef = Pixels::White, 
                    Length squareEdge = 5 ) ;
                    
                
                
            }   
                
        }
        
    }
    
}



#endif // OSDL_LINE_H_

---