Splitting the X11-specific "freeglut_state.c" code into its own file
[freeglut] / src / x11 / freeglut_state_x11.c
index e69de29..9118630 100644 (file)
@@ -0,0 +1,406 @@
+/*\r
+ * freeglut_state_x11.c\r
+ *\r
+ * X11-specific freeglut state query methods.\r
+ *\r
+ * Copyright (c) 2012 Stephen J. Baker. All Rights Reserved.\r
+ * Written by John F. Fay, <fayjf@sourceforge.net>\r
+ * Creation date: Sat Feb 4 2012\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a\r
+ * copy of this software and associated documentation files (the "Software"),\r
+ * to deal in the Software without restriction, including without limitation\r
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,\r
+ * and/or sell copies of the Software, and to permit persons to whom the\r
+ * Software is furnished to do so, subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included\r
+ * in all copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS\r
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL\r
+ * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ */\r
+\r
+#include <GL/freeglut.h>\r
+#include "../Common/freeglut_internal.h"\r
+\r
+/*\r
+ * TODO BEFORE THE STABLE RELEASE:\r
+ *\r
+ *  fgPlatformChooseFBConfig()      -- OK, but what about glutInitDisplayString()?\r
+ */\r
+\r
+/* A helper function to check if a display mode is possible to use */\r
+#if TARGET_HOST_POSIX_X11\r
+GLXFBConfig* fgPlatformChooseFBConfig( int* numcfgs );\r
+#endif\r
+\r
+/*\r
+ * Queries the GL context about some attributes\r
+ */\r
+int fgPlatformGetConfig( int attribute )\r
+{\r
+  int returnValue = 0;\r
+  int result;  /*  Not checked  */\r
+\r
+  if( fgStructure.CurrentWindow )\r
+      result = glXGetFBConfigAttrib( fgDisplay.pDisplay.Display,\r
+                                     *(fgStructure.CurrentWindow->Window.pContext.FBConfig),\r
+                                     attribute,\r
+                                     &returnValue );\r
+\r
+  return returnValue;\r
+}\r
+\r
+int fgPlatformGlutGet ( GLenum eWhat )\r
+{\r
+    int nsamples = 0;\r
+\r
+    switch( eWhat )\r
+    {\r
+    /*\r
+     * The window/context specific queries are handled mostly by\r
+     * fgPlatformGetConfig().\r
+     */\r
+    case GLUT_WINDOW_NUM_SAMPLES:\r
+#ifdef GLX_VERSION_1_3\r
+        glGetIntegerv(GL_SAMPLES, &nsamples);\r
+#endif\r
+        return nsamples;\r
+\r
+    /*\r
+     * The rest of GLX queries under X are general enough to use a macro to\r
+     * check them\r
+     */\r
+#   define GLX_QUERY(a,b) case a: return fgPlatformGetConfig( b );\r
+\r
+    GLX_QUERY( GLUT_WINDOW_RGBA,                GLX_RGBA                );\r
+    GLX_QUERY( GLUT_WINDOW_DOUBLEBUFFER,        GLX_DOUBLEBUFFER        );\r
+    GLX_QUERY( GLUT_WINDOW_BUFFER_SIZE,         GLX_BUFFER_SIZE         );\r
+    GLX_QUERY( GLUT_WINDOW_STENCIL_SIZE,        GLX_STENCIL_SIZE        );\r
+    GLX_QUERY( GLUT_WINDOW_DEPTH_SIZE,          GLX_DEPTH_SIZE          );\r
+    GLX_QUERY( GLUT_WINDOW_RED_SIZE,            GLX_RED_SIZE            );\r
+    GLX_QUERY( GLUT_WINDOW_GREEN_SIZE,          GLX_GREEN_SIZE          );\r
+    GLX_QUERY( GLUT_WINDOW_BLUE_SIZE,           GLX_BLUE_SIZE           );\r
+    GLX_QUERY( GLUT_WINDOW_ALPHA_SIZE,          GLX_ALPHA_SIZE          );\r
+    GLX_QUERY( GLUT_WINDOW_ACCUM_RED_SIZE,      GLX_ACCUM_RED_SIZE      );\r
+    GLX_QUERY( GLUT_WINDOW_ACCUM_GREEN_SIZE,    GLX_ACCUM_GREEN_SIZE    );\r
+    GLX_QUERY( GLUT_WINDOW_ACCUM_BLUE_SIZE,     GLX_ACCUM_BLUE_SIZE     );\r
+    GLX_QUERY( GLUT_WINDOW_ACCUM_ALPHA_SIZE,    GLX_ACCUM_ALPHA_SIZE    );\r
+    GLX_QUERY( GLUT_WINDOW_STEREO,              GLX_STEREO              );\r
+\r
+#   undef GLX_QUERY\r
+\r
+    /* Colormap size is handled in a bit different way than all the rest */\r
+    case GLUT_WINDOW_COLORMAP_SIZE:\r
+        if( (fgPlatformGetConfig( GLX_RGBA )) || (fgStructure.CurrentWindow == NULL) )\r
+        {\r
+            /*\r
+             * We've got a RGBA visual, so there is no colormap at all.\r
+             * The other possibility is that we have no current window set.\r
+             */\r
+            return 0;\r
+        }\r
+        else\r
+        {\r
+          const GLXFBConfig * fbconfig =\r
+                fgStructure.CurrentWindow->Window.pContext.FBConfig;\r
+\r
+          XVisualInfo * visualInfo =\r
+                glXGetVisualFromFBConfig( fgDisplay.pDisplay.Display, *fbconfig );\r
+\r
+          const int result = visualInfo->visual->map_entries;\r
+\r
+          XFree(visualInfo);\r
+\r
+          return result;\r
+        }\r
+\r
+    /*\r
+     * Those calls are somewhat similiar, as they use XGetWindowAttributes()\r
+     * function\r
+     */\r
+    case GLUT_WINDOW_X:\r
+    case GLUT_WINDOW_Y:\r
+    case GLUT_WINDOW_BORDER_WIDTH:\r
+    case GLUT_WINDOW_HEADER_HEIGHT:\r
+    {\r
+        int x, y;\r
+        Window w;\r
+\r
+        if( fgStructure.CurrentWindow == NULL )\r
+            return 0;\r
+\r
+        XTranslateCoordinates(\r
+            fgDisplay.pDisplay.Display,\r
+            fgStructure.CurrentWindow->Window.Handle,\r
+            fgDisplay.pDisplay.RootWindow,\r
+            0, 0, &x, &y, &w);\r
+\r
+        switch ( eWhat )\r
+        {\r
+        case GLUT_WINDOW_X: return x;\r
+        case GLUT_WINDOW_Y: return y;\r
+        }\r
+\r
+        if ( w == 0 )\r
+            return 0;\r
+        XTranslateCoordinates(\r
+            fgDisplay.pDisplay.Display,\r
+            fgStructure.CurrentWindow->Window.Handle,\r
+            w, 0, 0, &x, &y, &w);\r
+\r
+        switch ( eWhat )\r
+        {\r
+        case GLUT_WINDOW_BORDER_WIDTH:  return x;\r
+        case GLUT_WINDOW_HEADER_HEIGHT: return y;\r
+        }\r
+    }\r
+\r
+    case GLUT_WINDOW_WIDTH:\r
+    case GLUT_WINDOW_HEIGHT:\r
+    {\r
+        XWindowAttributes winAttributes;\r
+\r
+        if( fgStructure.CurrentWindow == NULL )\r
+            return 0;\r
+        XGetWindowAttributes(\r
+            fgDisplay.pDisplay.Display,\r
+            fgStructure.CurrentWindow->Window.Handle,\r
+            &winAttributes\r
+        );\r
+        switch ( eWhat )\r
+        {\r
+        case GLUT_WINDOW_WIDTH:            return winAttributes.width ;\r
+        case GLUT_WINDOW_HEIGHT:           return winAttributes.height ;\r
+        }\r
+    }\r
+\r
+    /* I do not know yet if there will be a fgChooseVisual() function for Win32 */\r
+    case GLUT_DISPLAY_MODE_POSSIBLE:\r
+    {\r
+        /*  We should not have to call fgPlatformChooseFBConfig again here.  */\r
+        GLXFBConfig * fbconfig;\r
+        int isPossible;\r
+\r
+        fbconfig = fgPlatformChooseFBConfig(NULL);\r
+\r
+        if (fbconfig == NULL)\r
+        {\r
+            isPossible = 0;\r
+        }\r
+        else\r
+        {\r
+            isPossible = 1;\r
+            XFree(fbconfig);\r
+        }\r
+\r
+        return isPossible;\r
+    }\r
+\r
+    /* This is system-dependant */\r
+    case GLUT_WINDOW_FORMAT_ID:\r
+        if( fgStructure.CurrentWindow == NULL )\r
+            return 0;\r
+\r
+        return fgPlatformGetConfig( GLX_VISUAL_ID );\r
+\r
+    default:\r
+        fgWarning( "glutGet(): missing enum handle %d", eWhat );\r
+        break;\r
+    }\r
+}\r
+\r
+\r
+int fgPlatformGlutDeviceGet ( GLenum eWhat )\r
+{\r
+    switch( eWhat )\r
+    {\r
+    case GLUT_HAS_KEYBOARD:\r
+        /*\r
+         * X11 has a core keyboard by definition, although it can\r
+         * be present as a virtual/dummy keyboard. For now, there\r
+         * is no reliable way to tell if a real keyboard is present.\r
+         */\r
+        return 1;\r
+\r
+    /* X11 has a mouse by definition */\r
+    case GLUT_HAS_MOUSE:\r
+        return 1 ;\r
+\r
+    case GLUT_NUM_MOUSE_BUTTONS:\r
+        /* We should be able to pass NULL when the last argument is zero,\r
+         * but at least one X server has a bug where this causes a segfault.\r
+         *\r
+         * In XFree86/Xorg servers, a mouse wheel is seen as two buttons\r
+         * rather than an Axis; "freeglut_main.c" expects this when\r
+         * checking for a wheel event.\r
+         */\r
+        {\r
+            unsigned char map;\r
+            int nbuttons = XGetPointerMapping(fgDisplay.pDisplay.Display, &map,0);\r
+            return nbuttons;\r
+        }\r
+\r
+    default:\r
+        fgWarning( "glutDeviceGet(): missing enum handle %d", eWhat );\r
+        break;\r
+    }\r
+\r
+    /* And now -- the failure. */\r
+    return -1;\r
+}\r
+\r
+int fgPlatformGlutLayerGet( GLenum eWhat )\r
+{\r
+    /*\r
+     * This is easy as layers are not implemented ;-)\r
+     *\r
+     * XXX Can we merge the UNIX/X11 and WIN32 sections?  Or\r
+     * XXX is overlay support planned?\r
+     */\r
+    switch( eWhat )\r
+    {\r
+    case GLUT_OVERLAY_POSSIBLE:\r
+        return 0;\r
+\r
+    case GLUT_LAYER_IN_USE:\r
+        return GLUT_NORMAL;\r
+\r
+    case GLUT_HAS_OVERLAY:\r
+        return 0;\r
+\r
+    case GLUT_TRANSPARENT_INDEX:\r
+        /*\r
+         * Return just anything, which is always defined as zero\r
+         *\r
+         * XXX HUH?\r
+         */\r
+        return 0;\r
+\r
+    case GLUT_NORMAL_DAMAGED:\r
+        /* XXX Actually I do not know. Maybe. */\r
+        return 0;\r
+\r
+    case GLUT_OVERLAY_DAMAGED:\r
+        return -1;\r
+\r
+    default:\r
+        fgWarning( "glutLayerGet(): missing enum handle %d", eWhat );\r
+        break;\r
+    }\r
+\r
+    /* And fail. That's good. Programs do love failing. */\r
+    return -1;\r
+}\r
+\r
+\r
+int *fgPlatformGlutGetModeValues(GLenum eWhat, int *size)\r
+{\r
+  int *array;\r
+\r
+  int attributes[9];\r
+  GLXFBConfig * fbconfigArray;  /*  Array of FBConfigs  */\r
+  int fbconfigArraySize;        /*  Number of FBConfigs in the array  */\r
+  int attribute_name = 0;\r
+\r
+  array = NULL;\r
+  *size = 0;\r
+\r
+  switch (eWhat)\r
+    {\r
+    case GLUT_AUX:\r
+    case GLUT_MULTISAMPLE:\r
+\r
+      attributes[0] = GLX_BUFFER_SIZE;\r
+      attributes[1] = GLX_DONT_CARE;\r
+\r
+      switch (eWhat)\r
+        {\r
+        case GLUT_AUX:\r
+          /*\r
+            FBConfigs are now sorted by increasing number of auxiliary\r
+            buffers.  We want at least one buffer.\r
+          */\r
+          attributes[2] = GLX_AUX_BUFFERS;\r
+          attributes[3] = 1;\r
+          attributes[4] = None;\r
+\r
+          attribute_name = GLX_AUX_BUFFERS;\r
+\r
+          break;\r
+\r
+\r
+        case GLUT_MULTISAMPLE:\r
+          attributes[2] = GLX_AUX_BUFFERS;\r
+          attributes[3] = GLX_DONT_CARE;\r
+          attributes[4] = GLX_SAMPLE_BUFFERS;\r
+          attributes[5] = 1;\r
+          /*\r
+            FBConfigs are now sorted by increasing number of samples per\r
+            pixel.  We want at least one sample.\r
+          */\r
+          attributes[6] = GLX_SAMPLES;\r
+          attributes[7] = 1;\r
+          attributes[8] = None;\r
+\r
+          attribute_name = GLX_SAMPLES;\r
+\r
+          break;\r
+        }\r
+\r
+      fbconfigArray = glXChooseFBConfig(fgDisplay.pDisplay.Display,\r
+                                        fgDisplay.pDisplay.Screen,\r
+                                        attributes,\r
+                                        &fbconfigArraySize);\r
+\r
+      if (fbconfigArray != NULL)\r
+        {\r
+          int * temp_array;\r
+          int result;   /*  Returned by glXGetFBConfigAttrib. Not checked.  */\r
+          int previous_value;\r
+          int i;\r
+\r
+          temp_array = malloc(sizeof(int) * fbconfigArraySize);\r
+          previous_value = 0;\r
+\r
+          for (i = 0; i < fbconfigArraySize; i++)\r
+            {\r
+              int value;\r
+\r
+              result = glXGetFBConfigAttrib(fgDisplay.pDisplay.Display,\r
+                                            fbconfigArray[i],\r
+                                            attribute_name,\r
+                                            &value);\r
+              if (value > previous_value)\r
+                {\r
+                  temp_array[*size] = value;\r
+                  previous_value = value;\r
+                  (*size)++;\r
+                }\r
+            }\r
+\r
+          array = malloc(sizeof(int) * (*size));\r
+          for (i = 0; i < *size; i++)\r
+            {\r
+              array[i] = temp_array[i];\r
+            }\r
+\r
+          free(temp_array);\r
+          XFree(fbconfigArray);\r
+        }\r
+\r
+      break;\r
+\r
+    default:\r
+      break;\r
+    }\r
+\r
+  return array;\r
+}\r
+\r
+\r