source: OGRE/trunk/ogrenew/RenderSystems/GL/include/GLX/OgreGLXWindow.h @ 692

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
 
Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html
 
This program 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 of the License, or (at your option) any later
version.
 
This program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/

#ifndef __GLXWindow_H__
#define __GLXWindow_H__

#include "OgreRenderWindow.h"
#include "OgreGLXContext.h"

#include <X11/Xlib.h>
#include <X11/keysym.h>
#include <GL/glx.h>
#include <GL/glxext.h>

namespace Ogre 
{
        class GLXWindow : public RenderWindow
        {
        private:
                ::Display *mDisplay;            //Pointer to X connection
                ::Window mWindow;               //X Window
                ::Atom mAtomDeleteWindow;       //Used for handling X window closing (todo - dosn't work?)
                ::GLXContext mGlxContext;

                bool mClosed;
                bool mFullScreen;
                bool mTopLevel; // This is false if the Ogre window is embedded
                int mOldMode;   // Mode before switching to fullscreen

                GLXContext   *mContext;
        public:
                // Pass X display to create this window on
                GLXWindow(Display *display);
                ~GLXWindow();

                void create(const String& name, unsigned int width, unsigned int height,
                            bool fullScreen, const NameValuePairList *miscParams);
                
                /** @copydoc see RenderWindow::destroy */
                void destroy(void);
                
                /** @copydoc see RenderWindow::isActive */
                bool isActive(void) const;

                /** @copydoc see RenderWindow::isClosed */
                bool isClosed(void) const;

                /** @copydoc see RenderWindow::reposition */
                void reposition(int left, int top);

                /** @copydoc see RenderWindow::resize */
                void resize(unsigned int width, unsigned int height);

                /** @copydoc see RenderWindow::swapBuffers */
                void swapBuffers(bool waitForVSync);
        
                /** @copydoc see RenderWindow::writeContentsToFile */
                void writeContentsToFile(const String& filename);

                /**
                @remarks
                        * Get custom attribute; the following attributes are valid:
                        * GLXWINDOW     The X Window associated with this
                        * GLXDISPLAY    The X Display associated with this
                */
                void getCustomAttribute(const String& name, void* pData);

                /**
                @remarks
                        Call this for every X event, so that the window stays up to date with 
                        ConfigureNotify and Deletion events. If you are using neither Root::startRendering
                        nor dispatchEvents() than call this to inject X Events from your X Event polling routine.
                        Only X Events that match the Window ID of this window will be respconded to.
                */
                virtual void injectXEvent(const XEvent &event);

                bool requiresTextureFlipping() const { return false; }

                /**
                @remarks
                        Window covered/uncovered. Use this to inject an exposed event - this is only if you are
                        not sending Events (via PlatformManager::messagePump). This happens normally unless
                        you are creating your own windows.. In which case you control events
                */
                void exposed(bool active) { mActive = active; }

                /**
                @remarks
                        Window rsize. Use this to inject a resize event - this is only if you are
                        not sending Events (via PlatformManager::messagePump). This happens normally unless
                        you are creating your own windows.. In which case you control events
                */
                void resized(size_t width, size_t height);

                /**
                @remarks
                        Convience method for getting the XDisplay... You can also use the getCustomAttribute method,
                        this is just here for avoiding string creation just to get this (GLXPlatform)
                */
                ::Display* getXDisplay() { return mDisplay; }
        };
}

#endif