VRS - The Virtual Rendering System

version 3.3

glcanvas.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2008 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This 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 for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: glcanvas.h 6247 2008-02-12 13:24:38Z Konstantin_Baumann $

#ifndef VRS_GLCANVAS_H
#define VRS_GLCANVAS_H

#include <vrs/sg/canvas.h>
#include <vrs/opengl/openglconfig.h>

namespace VRS {

class AttributeComposite;
class FrameBufferObjectGL;
class Image;

class VRS_CORE_API GLCanvas : public Canvas {
public:

        enum CanvasProperties {
                RGB_BUFFER          = 1<<0,
        ALPHA_BUFFER        = 1<<1,
        DEPTH_BUFFER            = 1<<2,
        DOUBLE_BUFFER           = 1<<3,
        STENCIL_BUFFER          = 1<<4,
        ACCUM_BUFFER            = 1<<5,
                STEREO_VIEWING      = 1<<6,
        MULTISAMPLING           = 1<<7,
        UBYTE_BUFFER        = 0x0000,
        FLOAT_BUFFER        = 0x0300,
        FLOAT16_BUFFER      = 0x0100,
        FLOAT32_BUFFER      = 0x0200,

        RGBA_BUFFER         = RGB_BUFFER | ALPHA_BUFFER,

        // frequently used settings
                RGBD                            = RGB_BUFFER | DEPTH_BUFFER,
                RGBDS                           = RGB_BUFFER | DEPTH_BUFFER | STENCIL_BUFFER,
                RGBDD                           = RGB_BUFFER | DEPTH_BUFFER | DOUBLE_BUFFER,
                RGBDDS                          = RGB_BUFFER | DEPTH_BUFFER | DOUBLE_BUFFER | STENCIL_BUFFER,
        RGBA                = RGB_BUFFER | ALPHA_BUFFER,
        RGBAD               = RGB_BUFFER | ALPHA_BUFFER | DEPTH_BUFFER,
        RGBADS              = RGB_BUFFER | ALPHA_BUFFER | DEPTH_BUFFER | STENCIL_BUFFER,
        RGBADD              = RGB_BUFFER | ALPHA_BUFFER | DEPTH_BUFFER | DOUBLE_BUFFER,
        RGBADDS             = RGB_BUFFER | ALPHA_BUFFER | DEPTH_BUFFER | DOUBLE_BUFFER | STENCIL_BUFFER
        };
    VRS_SERIALIZABLE_CLASS_ENUM(CanvasProperties);
        /* The canvas properties specify the OpenGL framebuffer. The properties are specified
           as constructor arguments of specialized canvas classes. */

    enum BufferSelection {
        CURRENT_BUFFER = 0, FRONT_BUFFER, BACK_BUFFER, LEFT_BUFFER, RIGHT_BUFFER, FRONT_LEFT_BUFFER, FRONT_RIGHT_BUFFER, BACK_LEFT_BUFFER, BACK_RIGHT_BUFFER,
        AUX_BUFFER_0 = 20, AUX_BUFFER_1, AUX_BUFFER_2, AUX_BUFFER_3, AUX_BUFFER_4, AUX_BUFFER_5, AUX_BUFFER_6, AUX_BUFFER_7,
        COLOR_ATTACHMENT_BUFFER_0 = 80, COLOR_ATTACHMENT_BUFFER_1, COLOR_ATTACHMENT_BUFFER_2, COLOR_ATTACHMENT_BUFFER_3, COLOR_ATTACHMENT_BUFFER_4, COLOR_ATTACHMENT_BUFFER_5, COLOR_ATTACHMENT_BUFFER_6, COLOR_ATTACHMENT_BUFFER_7
    };
    VRS_SERIALIZABLE_CLASS_ENUM(BufferSelection);
    
    virtual SO<Image> snapshot(
        CanvasProperties buffer = GLCanvas::RGB_BUFFER,
        BufferSelection readBuffer = GLCanvas::CURRENT_BUFFER,
        const Area& subRegion = Area()
    ); // the whole region
        virtual void snapshot(
        SO<Image> destination,
        CanvasProperties buffer = GLCanvas::RGB_BUFFER,
        BufferSelection readBuffer = GLCanvas::CURRENT_BUFFER,
        const Area& subRegion = Area()
    ); // the whole region
    virtual bool largeScaleSnapshot(
        SO<Image> destination,
        CanvasProperties buffer = GLCanvas::RGB_BUFFER,
        SO<FrameBufferObjectGL> fbo = NULL
    );
    virtual void create();
    virtual void destroy();
    virtual int getProperties() const = 0;
    virtual bool hasProperty(CanvasProperties prop) const;
    virtual Engine* engine() const;
    virtual TechniqueProcessor* processor() const;
    virtual void createEngine();
    virtual void createProcessor();
    virtual AttributeComposite* standardGLSettings() const;
        enum InfoAspects { 
        GLVERSION      = 1<<0,
                GLUVERSION     = 1<<1,
        BUFFERS        = 1<<2,
                BUFFERBITS     = 1<<3,
        STACKDEPTHS    = 1<<4,
                POINTLINEINFO  = 1<<5,
        MISCINFO       = 1<<6,
                ALL            = GLVERSION | GLUVERSION | BUFFERS | BUFFERBITS | STACKDEPTHS | POINTLINEINFO | MISCINFO
    };
    VRS_SERIALIZABLE_CLASS_ENUM(InfoAspects);

    std::string glInfo(int infoAspects = GLCanvas::ALL);
    bool hasExtension(const ID& extensionID) const;

    bool isVersion(int major, int minor) const;

    void allowSoftwareEmulation(bool onOff);

    void setSharedContextWith(GLCanvas* canvas);
    GLCanvas* getSharedContextWith() const;
    
    virtual bool prepareRedisplay();

    virtual void finishRedisplay();

    VRS_TYPEINFO(GLCanvas, Canvas);

protected:
    GLCanvas();

    virtual void shareContext();

    SO<Engine> engine_;
        SO<TechniqueProcessor> processor_;

private:
    bool allowSWEmu_;
    SO<GLCanvas> shareContextWith_;
};

inline Engine* GLCanvas::engine() const {
    return engine_; 
}

inline TechniqueProcessor* GLCanvas::processor() const {
    return processor_;
}

} // namespace VRS

#endif // VRS_GLCANVAS_H

---

Generated on Wed May 23 06:00:12 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact