OSDLLine.h

Go to the documentation of this file.

#ifndef OSDL_LINE_H_
#define OSDL_LINE_H_


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



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 )
                        throw() ;
    
    
                OSDL_DLL bool drawHorizontal( Surface & targetSurface, 
                    Coordinate xStart, Coordinate xStop, Coordinate y, 
                    Pixels::PixelColor actualColor ) throw() ;
    
    
                OSDL_DLL bool drawHorizontal( Surface & targetSurface, 
                    Coordinate xStart, Coordinate xStop, Coordinate y, 
                    Pixels::ColorDefinition = Pixels::White ) throw() ;
    
    
                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 )
                        throw() ;
    
    
                OSDL_DLL bool drawVertical( Surface & targetSurface, 
                    Coordinate x, Coordinate yStart, Coordinate yStop, 
                    Pixels::ColorDefinition = Pixels::White )
                    throw() ;


                /*
                 * 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 )
                        throw() ;
    
    
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Coordinate xStart, Coordinate yStart, 
                    Coordinate xStop, Coordinate yStop, 
                    Pixels::ColorDefinition colorDef = Pixels::White )
                        throw() ;
                    
                    
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Point2D & firstPoint, Point2D & secondPoint,
                    Pixels::ColorElement red, Pixels::ColorElement green, 
                    Pixels::ColorElement blue, 
                    Pixels::ColorElement alpha = Pixels::AlphaOpaque )
                        throw() ;
                    
                    
                OSDL_DLL bool draw( Surface & targetSurface, 
                    Point2D & firstPoint, Point2D & secondPoint,
                    Pixels::ColorDefinition colorDef = Pixels::White ) throw() ;
                
                
                OSDL_DLL bool drawCross( Surface & targetSurface, 
                    const Point2D & center,
                    Pixels::ColorDefinition colorDef = Pixels::White, 
                    Length squareEdge = 5 ) throw() ;
                    
                    
                OSDL_DLL bool drawCross( Surface & targetSurface, 
                    Coordinate xCenter, Coordinate yCenter,
                    Pixels::ColorDefinition colorDef = Pixels::White, 
                    Length squareEdge = 5 ) throw() ;
                    
                
                
            }   
                
        }
        
    }
    
}


#endif // OSDL_LINE_H_

---