OSDLPalette.h

Go to the documentation of this file.

#ifndef OSDL_PALETTE_H_
#define OSDL_PALETTE_H_

        
#include "OSDLPixel.h"       // for ColorDefinition

#include "Ceylan.h"          // for TextDisplayable, Uint32, etc.

#include <string>



namespace OSDL
{
    
    namespace Video
    {
    

        typedef Ceylan::Uint32 ColorCount ;
        
        
        class OSDL_DLL PaletteException : public VideoException
        {
        
            public:
                explicit PaletteException( const std::string & message ) 
                    throw() ;
                virtual ~PaletteException() throw() ;
                            
        } ;
        
    
    
        class OSDL_DLL Palette : public Ceylan::TextDisplayable
        {
        
            public:
            
            
                static const Ceylan::Flags Logical ;
                                
                static const Ceylan::Flags Physical ;
            
            
                Palette( ColorCount numberOfColors, 
                        Pixels::ColorDefinition * colors,
                        Pixels::PixelFormat * format = 0 ) 
                    throw( PaletteException ) ;

                
                explicit Palette( SDL_Palette & palette ) 
                    throw( PaletteException ) ;
                
                
                virtual ~Palette() throw() ;
            
            
                virtual void load( ColorCount numberOfColors, 
                        Pixels::ColorDefinition * colors ) 
                    throw( PaletteException ) ;
            
            
                virtual ColorCount getNumberOfColors() const throw() ;
                
                
                virtual const Pixels::PixelColor & getPixelColorAt( 
                        ColorCount index ) 
                    const throw( PaletteException ) ;
                    
                    
                virtual Pixels::PixelColor * getPixelColors() const throw() ;
                
                
                virtual const Pixels::ColorDefinition & getColorDefinitionAt(
                        ColorCount index ) 
                    const throw( PaletteException ) ;
                    
                    
                virtual Pixels::ColorDefinition * getColorDefinitions() 
                    const throw() ;

                    
                virtual void updatePixelColorsFrom( 
                    Pixels::PixelFormat & format ) throw() ;


                virtual bool draw( Surface & targetSurface, 
                    Pixels::ColorDefinition backgroundColor = Pixels::White )
                        throw() ;
                
                    
                virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) 
                    const throw() ;


                
                // Static section.
                        
                        
                static Palette & CreateGreyScalePalette( 
                    ColorCount numberOfColors = 256 ) throw() ; 
            
            
                static Palette & CreateGradationPalette( 
                    Pixels::ColorDefinition colorStart,
                    Pixels::ColorDefinition colorEnd, 
                    ColorCount numberOfColors = 256 ) throw() ; 
            
            
                static Palette & CreateLandscapePalette( 
                    ColorCount numberOfColors = 256 ) throw() ; 
            
            
            
            protected:
                    
            
                ColorCount _numberOfColors ;
                
                
                Pixels::ColorDefinition * _colorDefs ;
            
            
                Pixels::PixelColor * _pixelColors ;


                bool _converted ;
                
                
                            
            private:
            
            
                explicit Palette( const Palette & source ) throw() ;
            
            
                Palette & operator = ( const Palette & source ) throw() ;
        
        
        } ;
    
    }

}


#endif // OSDL_PALETTE_H_

---