OSDLOverlay.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_OVERLAY_H_
#define OSDL_OVERLAY_H_


#include "OSDLVideoTypes.h"      // for VideoException

#include "Ceylan.h"              // for inheritance

#include <string>




#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

// No need to include SDL header here:
struct SDL_Overlay ;

#endif //  ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 



namespace OSDL
{


    namespace Video
    {
    
        
        
#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

        typedef ::SDL_Overlay LowLevelOverlay ;
        
#else // OSDL_USES_SDL  

        struct LowLevelOverlay {} ;

#endif // OSDL_USES_SDL



    
        class OSDL_DLL OverlayException: public VideoException
        {
        
            public:
            
                OverlayException( const std::string & message ) ;       
                virtual ~OverlayException() throw() ;
            
        } ;
    
    
    
    
        class OSDL_DLL Overlay: public Ceylan::Lockable
        {
        
        
            public:
            
            
            
                enum EncodingFormat { YV12, IYUV, YUY2,UYVY, YVYU } ;
            
            
            
                Overlay( Length width, Length height, EncodingFormat format ) ;
                
                
            
                virtual ~Overlay() throw() ;
            
            

                virtual void blit( Coordinate x, Coordinate y ) const ;         
            
            
            
                virtual void blit() const ;

                    
                    
                 virtual bool mustBeLocked() const ;
        
    
            
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;



            
            protected:
            
            
            
                virtual void preUnlock() ;
                
                
                
                virtual void postLock() ;
            
            
            
                LowLevelOverlay * _overlay ;
            
            
                Length _width ;

                
                Length _height ;
                
                
                
            
            private:
        
        
        
                Overlay( const Overlay & source ) ;
            
            
            
                Overlay & operator = ( const Overlay & source ) ;
                
        
        
        } ; 
    
    
    
    }


}



#endif // OSDL_OVERLAY_H_

---