gzGraphicsFormat.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzGraphicsFormat.h
// Module       : 
// Description  : Class definition of the gzGraphicsFormat class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990614  Created file    
//
//******************************************************************************
#ifndef __GZ_GRAPHICSFORMAT_H__
#define __GZ_GRAPHICSFORMAT_H__

#include "gzReference.h"
#include "gzGraphicsAbstractionLayer.h"
#include "gzContext.h"

class gzGraphicsFormat : public gzReference
{
public:

    GZ_SYSTEM_EXPORT gzGraphicsFormat( gzInt redbits=1 , gzInt greenbits=1 , gzInt bluebits=1 , gzInt alphabits=0 , gzInt stencilbits=0 ,
                                        gzInt depthbits=1 , gzInt accredbits=0 , gzInt accgreenbits=0 , gzInt accbluebits=0  , gzInt accalphabits=0 );

    GZ_SYSTEM_EXPORT virtual    ~gzGraphicsFormat();

    GZ_SYSTEM_EXPORT gzVoid     setRGBBits( gzInt redbits , gzInt greenbits , gzInt bluebits  );
    
    GZ_SYSTEM_EXPORT gzVoid     setRedBits(gzInt bits);
    GZ_SYSTEM_EXPORT gzVoid     setGreenBits(gzInt bits);
    GZ_SYSTEM_EXPORT gzVoid     setBlueBits(gzInt bits);
    
    GZ_SYSTEM_EXPORT gzInt      getRedBits();
    GZ_SYSTEM_EXPORT gzInt      getGreenBits();
    GZ_SYSTEM_EXPORT gzInt      getBlueBits();
    GZ_SYSTEM_EXPORT gzInt      getColorBits();
    

    GZ_SYSTEM_EXPORT gzBool     useDoubleBuffer() const;
    GZ_SYSTEM_EXPORT gzVoid     useDoubleBuffer( gzBool enable );

    GZ_SYSTEM_EXPORT gzBool     useDepth() const;
    GZ_SYSTEM_EXPORT gzVoid     useDepth( gzBool enable );
    GZ_SYSTEM_EXPORT gzVoid     setDepthBits( gzInt bits );
    GZ_SYSTEM_EXPORT gzInt      getDepthBits();

    GZ_SYSTEM_EXPORT gzBool     useAlpha() const;
    GZ_SYSTEM_EXPORT gzVoid     useAlpha( gzBool enable );
    GZ_SYSTEM_EXPORT gzVoid     setAlphaBits(gzInt bits );
    GZ_SYSTEM_EXPORT gzInt      getAlphaBits();

    GZ_SYSTEM_EXPORT gzBool     useAccum() const;
    GZ_SYSTEM_EXPORT gzVoid     useAccum( gzBool enable );

    GZ_SYSTEM_EXPORT gzVoid     setAccumBits( gzInt redbits , gzInt greenbits , gzInt bluebits  , gzInt alphabits=0 );
    
    GZ_SYSTEM_EXPORT gzVoid     setAccumRedBits(gzInt bits);
    GZ_SYSTEM_EXPORT gzVoid     setAccumGreenBits(gzInt bits);
    GZ_SYSTEM_EXPORT gzVoid     setAccumBlueBits(gzInt bits);
    GZ_SYSTEM_EXPORT gzVoid     setAccumAlphaBits(gzInt bits);
    
    GZ_SYSTEM_EXPORT gzInt      getAccumRedBits();
    GZ_SYSTEM_EXPORT gzInt      getAccumGreenBits();
    GZ_SYSTEM_EXPORT gzInt      getAccumBlueBits();
    GZ_SYSTEM_EXPORT gzInt      getAccumAlphaBits();
    GZ_SYSTEM_EXPORT gzInt      getAccumBits();


    GZ_SYSTEM_EXPORT gzBool     useStencil() const;
    GZ_SYSTEM_EXPORT gzVoid     useStencil( gzBool enable );
    GZ_SYSTEM_EXPORT gzVoid     setStencilBits(gzInt bits );
    GZ_SYSTEM_EXPORT gzInt      getStencilBits();


    GZ_SYSTEM_EXPORT gzVoid     useFullScreen(gzBool on);
    GZ_SYSTEM_EXPORT gzBool     useFullScreen() const;

    GZ_SYSTEM_EXPORT gzVoid     useStereo(gzBool on);
    GZ_SYSTEM_EXPORT gzBool     useStereo() const;

    GZ_SYSTEM_EXPORT gzVoid     useMultisample(gzBool on);
    GZ_SYSTEM_EXPORT gzBool     useMultisample() const;

    GZ_SYSTEM_EXPORT gzVoid     setMultisamples(gzInt samples);
    GZ_SYSTEM_EXPORT gzInt      getMultisamples();

    GZ_SYSTEM_EXPORT gzVoid     setFullScreenWidth(gzInt width=0);      // Best hit
    GZ_SYSTEM_EXPORT gzInt      getFullScreenWidth();

    GZ_SYSTEM_EXPORT gzVoid     setFullScreenHeight(gzInt height=0);    // Best hit
    GZ_SYSTEM_EXPORT gzInt      getFullScreenHeight();

    GZ_SYSTEM_EXPORT gzVoid     setFullScreenFrequency(gzInt hz=0);     // default rate = 0
    GZ_SYSTEM_EXPORT gzInt      getFullScreenFrequency() const ;

    GZ_SYSTEM_EXPORT gzVoid     notifyFormat();

    GZ_SYSTEM_EXPORT gzVisual   getVisual();
    GZ_SYSTEM_EXPORT gzVisual   getNewVisual(gzDeviceContext context , gzContext *renderContext, gzBool offscreen=FALSE );

    GZ_SYSTEM_EXPORT gzVoid     setDefault();
    GZ_SYSTEM_EXPORT static gzGraphicsFormat * getDefault();

private:

    enum CAPS_BITS
    {   
        GZ_USE_DOUBLE_BUFFER        =   (1<<0),
        GZ_USE_ALPHA                =   (1<<1),
        GZ_USE_ACCUM                =   (1<<2),
        GZ_USE_STENCIL              =   (1<<3),
        GZ_USE_DEPTH                =   (1<<4),
        GZ_USE_STEREO               =   (1<<5),
        GZ_USE_MULTISAMPLE          =   (1<<6),
        GZ_USE_FULLSCREEN           =   (1<<7),
    };

    
    gzUShort    m_enable;

    gzInt   m_red_bits;
    gzInt   m_green_bits;
    gzInt   m_blue_bits;
    gzInt   m_alpha_bits;
    gzInt   m_depth_bits;
    gzInt   m_stencil_bits;
    gzInt   m_accum_red_bits;   
    gzInt   m_accum_green_bits; 
    gzInt   m_accum_blue_bits;  
    gzInt   m_accum_alpha_bits; 

    gzInt   m_fullScreenWidth;
    gzInt   m_fullScreenHeight;
    gzInt   m_fullScreenFrequency;

    gzInt   m_multisamples;

    static gzRefPointer<gzGraphicsFormat> s_defaultFormat;

    gzVisual            m_visual;
};

#endif // __GZ_GRAPHICSFORMAT_H__

---