OSDLOpenGL.h

Go to the documentation of this file.

#ifndef OSDL_OPENGL_H_
#define OSDL_OPENGL_H_


#include "OSDLVideoTypes.h"  // for VideoException
#include "OSDLPixel.h"       // for ColorElement, ColorMask
#include "OSDLPoint2D.h"     // for Point2D::Origin

#include "Ceylan.h"          // for Uint8, Uint32, inheritance

#include "SDL_opengl.h"      // for GLfloat

#include <string>



namespace OSDL
{

    
    namespace Video
    {
    
    
        
        namespace OpenGL
        {

        
        
            class OSDL_DLL OpenGLException : public VideoException
            {
            
                public:
                
                
                    OpenGLException( const std::string & reason ) throw() ;
                    
                    
                    virtual ~OpenGLException() throw() ;
                                
            } ;
            
            
        
            extern OSDL_DLL Pixels::ColorMask RedMask ;
            
            
            extern OSDL_DLL Pixels::ColorMask GreenMask ;
            
            
            extern OSDL_DLL Pixels::ColorMask BlueMask ;
            
            
            extern OSDL_DLL Pixels::ColorMask AlphaMask ;
        
        
            typedef GLfloat GLLength ;
    
    
            typedef GLfloat GLCoordinate ;  
            
            

            enum Flavour { None, OpenGLFor2D, OpenGLFor3D, Reload } ;



            class OSDL_DLL OpenGLContext : public Ceylan::TextDisplayable
            {

            
                public:
                
                    
                    enum ProjectionMode { Orthographic, Perspective } ;
                    
                    
                    enum ShadingModel { Flat, Smooth } ;
                    
                    
                    enum CulledFacet { Front, Back, FrontAndBack } ;
                     
                    
                    enum FrontOrientation { Clockwise, CounterClockwise } ;
                    
                      
                    OpenGLContext( OpenGL::Flavour flavour = OpenGL::None ) 
                        throw( OpenGLException) ;
        
                        
                    virtual ~OpenGLContext() throw() ;
                
                
                
                    virtual void selectFlavour( OpenGL::Flavour flavour ) 
                        throw( OpenGLException ) ;
    
    
                    virtual void set2DFlavour() throw( OpenGLException ) ;
                
                
                    virtual void set3DFlavour() throw( OpenGLException ) ;
                
                    
                    virtual void blank() throw( OpenGLException ) ;
                     
                
                    virtual void reload() throw( OpenGLException ) ;
                    
                    
                     virtual OSDL::Video::BitsPerPixel getColorDepth( 
                            OSDL::Video::BitsPerPixel & redSize, 
                            OSDL::Video::BitsPerPixel & greenSize, 
                            OSDL::Video::BitsPerPixel & blueSize ) 
                        const throw( OpenGLException ) ;
                 
                 
                    virtual void setColorDepth( 
                            OSDL::Video::BitsPerPixel plannedBpp ) 
                        throw( OpenGLException ) ;
                
                 
                    virtual void setColorDepth( 
                            OSDL::Video::BitsPerPixel redSize, 
                            OSDL::Video::BitsPerPixel greenSize, 
                            OSDL::Video::BitsPerPixel blueSize  ) 
                        throw( OpenGLException ) ;
                
                
                    virtual bool getDoubleBufferStatus() 
                        throw( OpenGLException ) ;
                    
                    
                    virtual bool setDoubleBufferStatus( bool newStatus ) 
                        throw( OpenGLException ) ;
                
                
                     virtual void setShadingModel( 
                            ShadingModel newShadingModel = Smooth ) 
                        throw( OpenGLException ) ;
    
                     
                    virtual void setCullingStatus( bool newStatus ) throw() ;
    
                
                    virtual void setCulling( CulledFacet culledFacet = Back, 
                        FrontOrientation frontOrientation = CounterClockwise, 
                        bool autoEnable = true ) throw( OpenGLException ) ;
                        
                    
                    
                    virtual void setFullScreenAntialiasingStatus( 
                            bool newStatus,
                            Ceylan::Uint8 samplesPerPixelNumber = 1 ) 
                        throw( OpenGLException ) ;
                
                
                
                    virtual void setDepthBufferStatus( bool newStatus ) 
                        throw() ;
                    
                    
                    virtual void setDepthBufferSize( 
                            Ceylan::Uint8 bitsNumber = 16,
                            bool autoEnable = true ) 
                        throw( OpenGLException ) ;




                    // Viewport section.
                    
                    
                    virtual void setViewPort( Length width, Length height, 
                            const TwoDimensional::Point2D & lowerLeftCorner = 
                                TwoDimensional::Point2D::Origin ) 
                        throw( OpenGLException ) ;
                        
                        
                    virtual void setOrthographicProjection( GLLength width, 
                            GLCoordinate near = -DefaultNearClippingPlaneFor3D, 
                            GLCoordinate far  = -DefaultFarClippingPlaneFor3D ) 
                        throw ( OpenGLException ) ;
                        
            
                    // virtual void setClearColor() throw() ;
                    
                    virtual void clearViewport() throw( OpenGLException ) ;
                    
                    
                    virtual void clearDepthBuffer() throw( OpenGLException ) ;
                    
                        
                    virtual const std::string toString( 
                            Ceylan::VerbosityLevels level = Ceylan::high ) 
                        const throw() ;
                    
                    
                    
                    static std::string ToString( OpenGL::Flavour flavour )
                        throw() ;   



                    // OpenGL context behaviour.


                    static const bool ContextCanBeLost ;
            
            
                    static const bool ContextIsLostOnResize ;
            

            
                    static const bool ContextIsLostOnApplicationSwitch ;
            
            
                    static const bool ContextIsLostOnColorDepthChange ;
            


            
                    static const GLLength DefaultOrthographicWidth ;
                    
                    
                    static const GLCoordinate DefaultNearClippingPlaneFor2D ;
                    
                    
                    static const GLCoordinate DefaultFarClippingPlaneFor2D ;
                    
                    
                    static const GLCoordinate DefaultNearClippingPlaneFor3D ;
                    
                    
                    static const GLCoordinate DefaultFarClippingPlaneFor3D ;
                    
                    
                    
                    
                    
            protected:
            
                    
                    virtual void updateProjection() throw( OpenGLException ) ;
                    
                    
                    
                    // Internal OpenGL context state.
                    
                    
                    OpenGL::Flavour _flavour ;
                                            
                                                    
                    OSDL::Video::BitsPerPixel _redSize ; 
                    
                    OSDL::Video::BitsPerPixel _greenSize ;
                    
                    OSDL::Video::BitsPerPixel _blueSize ;

                    
                    Length _viewportWidth ;
                    
                    
                    Length _viewportHeight ;
                    
                    
                    ProjectionMode _projectionMode ;
                    
                    
                    GLLength _projectionWidth ;
                    
                    
                    GLCoordinate _nearClippingPlane ;
                    
                    
                    GLCoordinate _farClippingPlane ;
                    
                    
                    
            private:
                
                                    
                    OpenGLContext( const OpenGLContext & source ) throw() ;
            
            
                    OpenGLContext & operator = ( const OpenGLContext & source )
                        throw() ;
            
            
            } ;
        
        
        
            namespace GLU
            {
            
                typedef Ceylan::Uint32 Int ;
            
            }
            
                        
        }
        
    }
    
}



#endif // OSDL_OPENGL_H_

---