git.cworth.org Git - apitrace/blob - glxapi.py

   1 ##########################################################################
   2 #
   3 # Copyright 2008-2009 VMware, Inc.
   4 # All Rights Reserved.
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a copy
   7 # of this software and associated documentation files (the "Software"), to deal
   8 # in the Software without restriction, including without limitation the rights
   9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 # copies of the Software, and to permit persons to whom the Software is
  11 # furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 # THE SOFTWARE.
  23 #
  24 ##########################################################################/
  25
  26 """GLX API description."""
  27
  28
  29 from stdapi import *
  30 from glapi import glapi
  31
  32 VisualID = Alias("VisualID", UInt32)
  33 Display = Opaque("Display *")
  34 Visual = Opaque("Visual *")
  35 Font = Alias("Font", UInt32)
  36 Pixmap = Alias("Pixmap", UInt32)
  37 Window = Alias("Window", UInt32)
  38
  39 GLXContext = Opaque("GLXContext")
  40 GLXPixmap = Alias("GLXPixmap", UInt32)
  41 GLXDrawable = Alias("GLXDrawable", UInt32)
  42 GLXFBConfig = Opaque("GLXFBConfig")
  43 GLXFBConfigID = Alias("GLXFBConfigID", UInt32)
  44 GLXContextID = Alias("GLXContextID", UInt32)
  45 GLXWindow = Alias("GLXWindow", UInt32)
  46 GLXPbuffer = Alias("GLXPbuffer", UInt32)
  47
  48 XVisualInfo = Struct("XVisualInfo", [
  49   (Visual, "visual"),
  50   (VisualID, "visualid"),
  51   (Int, "screen"),
  52   (Int, "depth"),
  53   (Int, "c_class"),
  54   (ULong, "red_mask"),
  55   (ULong, "green_mask"),
  56   (ULong, "blue_mask"),
  57   (Int, "colormap_size"),
  58   (Int, "bits_per_rgb"),
  59 ])
  60
  61 Bool_ = FakeEnum(Int, [
  62     "False",
  63     "True",
  64 ])
  65
  66 GLXAttrib = FakeEnum(Int, [
  67     "GLX_USE_GL",
  68     "GLX_BUFFER_SIZE",
  69     "GLX_LEVEL",
  70     "GLX_RGBA",
  71     "GLX_DOUBLEBUFFER",
  72     "GLX_STEREO",
  73     "GLX_AUX_BUFFERS",
  74     "GLX_RED_SIZE",
  75     "GLX_GREEN_SIZE",
  76     "GLX_BLUE_SIZE",
  77     "GLX_ALPHA_SIZE",
  78     "GLX_DEPTH_SIZE",
  79     "GLX_STENCIL_SIZE",
  80     "GLX_ACCUM_RED_SIZE",
  81     "GLX_ACCUM_GREEN_SIZE",
  82     "GLX_ACCUM_BLUE_SIZE",
  83     "GLX_ACCUM_ALPHA_SIZE",
  84
  85     "GLX_CONFIG_CAVEAT",                # 0x20
  86     "GLX_X_VISUAL_TYPE",                # 0x22
  87     "GLX_TRANSPARENT_TYPE",             # 0x23
  88     "GLX_TRANSPARENT_INDEX_VALUE",      # 0x24
  89     "GLX_TRANSPARENT_RED_VALUE",        # 0x25
  90     "GLX_TRANSPARENT_GREEN_VALUE",      # 0x26
  91     "GLX_TRANSPARENT_BLUE_VALUE",       # 0x27
  92     "GLX_TRANSPARENT_ALPHA_VALUE",      # 0x28
  93
  94     "GLX_NONE",                 # 0x8000
  95     "GLX_SLOW_CONFIG",                  # 0x8001
  96     "GLX_TRUE_COLOR",                   # 0x8002
  97     "GLX_DIRECT_COLOR",         # 0x8003
  98     "GLX_PSEUDO_COLOR",         # 0x8004
  99     "GLX_STATIC_COLOR",         # 0x8005
 100     "GLX_GRAY_SCALE",                   # 0x8006
 101     "GLX_STATIC_GRAY",                  # 0x8007
 102     "GLX_TRANSPARENT_RGB",              # 0x8008
 103     "GLX_TRANSPARENT_INDEX",            # 0x8009
 104     "GLX_VISUAL_ID",                    # 0x800B
 105     "GLX_SCREEN",                       # 0x800C
 106     "GLX_NON_CONFORMANT_CONFIG",        # 0x800D
 107     "GLX_DRAWABLE_TYPE",                # 0x8010
 108     "GLX_RENDER_TYPE",                  # 0x8011
 109     "GLX_X_RENDERABLE",         # 0x8012
 110     "GLX_FBCONFIG_ID",                  # 0x8013
 111     "GLX_RGBA_TYPE",                    # 0x8014
 112     "GLX_COLOR_INDEX_TYPE",             # 0x8015
 113     "GLX_MAX_PBUFFER_WIDTH",            # 0x8016
 114     "GLX_MAX_PBUFFER_HEIGHT",           # 0x8017
 115     "GLX_MAX_PBUFFER_PIXELS",           # 0x8018
 116     "GLX_PRESERVED_CONTENTS",           # 0x801B
 117     "GLX_LARGEST_PBUFFER",              # 0x801C
 118     "GLX_WIDTH",                        # 0x801D
 119     "GLX_HEIGHT",                       # 0x801E
 120     "GLX_EVENT_MASK",                   # 0x801F
 121     "GLX_DAMAGED",                      # 0x8020
 122     "GLX_SAVED",                        # 0x8021
 123     "GLX_WINDOW",                       # 0x8022
 124     "GLX_PBUFFER",                      # 0x8023
 125     "GLX_PBUFFER_HEIGHT",              # 0x8040
 126     "GLX_PBUFFER_WIDTH",               # 0x8041
 127
 128     "GLX_SAMPLE_BUFFERS",              # 100000
 129     "GLX_SAMPLES",                     # 100001
 130
 131     "GLX_DONT_CARE", # 0xFFFFFFFF
 132 ])
 133
 134 GLXError = FakeEnum(Int, [
 135     "GLX_BAD_SCREEN",
 136     "GLX_BAD_ATTRIBUTE",
 137     "GLX_NO_EXTENSION",
 138     "GLX_BAD_VISUAL",
 139     "GLX_BAD_CONTEXT",
 140     "GLX_BAD_VALUE",
 141     "GLX_BAD_ENUM",
 142 ])
 143
 144
 145 GLXbuffer = Flags(Int, [
 146     "GLX_WINDOW_BIT",
 147     "GLX_PIXMAP_BIT",
 148     "GLX_PBUFFER_BIT",
 149     "GLX_AUX_BUFFERS_BIT",
 150     "GLX_FRONT_LEFT_BUFFER_BIT",
 151     "GLX_FRONT_RIGHT_BUFFER_BIT",
 152     "GLX_BACK_LEFT_BUFFER_BIT",
 153     "GLX_BACK_RIGHT_BUFFER_BIT",
 154     "GLX_DEPTH_BUFFER_BIT",
 155     "GLX_STENCIL_BUFFER_BIT",
 156     "GLX_ACCUM_BUFFER_BIT",
 157 ])
 158
 159 GLXEnum = FakeEnum(Int, [
 160     "GLX_NONE",
 161     "GLX_SLOW_CONFIG",
 162     "GLX_TRUE_COLOR",
 163     "GLX_DIRECT_COLOR",
 164     "GLX_PSEUDO_COLOR",
 165     "GLX_STATIC_COLOR",
 166     "GLX_GRAY_SCALE",
 167     "GLX_STATIC_GRAY",
 168     "GLX_TRANSPARENT_RGB",
 169     "GLX_TRANSPARENT_INDEX",
 170     "GLX_VISUAL_ID",
 171     "GLX_SCREEN",
 172     "GLX_NON_CONFORMANT_CONFIG",
 173     "GLX_DRAWABLE_TYPE",
 174     "GLX_RENDER_TYPE",
 175     "GLX_X_RENDERABLE",
 176     "GLX_FBCONFIG_ID",
 177     "GLX_RGBA_TYPE",
 178     "GLX_COLOR_INDEX_TYPE",
 179     "GLX_MAX_PBUFFER_WIDTH",
 180     "GLX_MAX_PBUFFER_HEIGHT",
 181     "GLX_MAX_PBUFFER_PIXELS",
 182     "GLX_PRESERVED_CONTENTS",
 183     "GLX_LARGEST_PBUFFER",
 184     "GLX_WIDTH",
 185     "GLX_HEIGHT",
 186     "GLX_EVENT_MASK",
 187     "GLX_DAMAGED",
 188     "GLX_SAVED",
 189     "GLX_WINDOW",
 190     "GLX_PBUFFER",
 191     "GLX_PBUFFER_HEIGHT",
 192     "GLX_PBUFFER_WIDTH",
 193 ])
 194
 195 GLXbuffer = Flags(Int, [
 196     "GLX_RGBA_BIT",
 197     "GLX_COLOR_INDEX_BIT",
 198     "GLX_PBUFFER_CLOBBER_MASK",
 199 ])
 200
 201 glxapi = API("GLX")
 202
 203 PROC = Opaque("__GLXextFuncPtr")
 204
 205 glxapi.add_functions([
 206     # GLX
 207     Function(Pointer(XVisualInfo), "glXChooseVisual", [(Display, "dpy"), (Int, "screen"), (Array(GLXAttrib, "__AttribList_size(attribList)"), "attribList")]),
 208     Function(GLXContext, "glXCreateContext", [(Display, "dpy"), (Pointer(XVisualInfo), "vis"), (GLXContext, "shareList"), (Bool_, "direct")]),
 209     Function(Void, "glXDestroyContext",  [(Display, "dpy"), (GLXContext, "ctx")]),
 210     Function(Bool_, "glXMakeCurrent", [(Display, "dpy"), (GLXDrawable, "drawable"), (GLXContext, "ctx")]),
 211     Function(Void, "glXCopyContext", [(Display, "dpy"), (GLXContext, "src"), (GLXContext, "dst"),
 212                                       (ULong, "mask")]),
 213     Function(Void, "glXSwapBuffers", [(Display, "dpy"), (GLXDrawable, "drawable")]),
 214     Function(GLXPixmap, "glXCreateGLXPixmap", [(Display, "dpy"), (Pointer(XVisualInfo), "visual"),
 215                                                (Pixmap, "pixmap")]),
 216     Function(Void, "glXDestroyGLXPixmap", [(Display, "dpy"), (GLXPixmap, "pixmap")]),
 217     Function(Bool_, "glXQueryExtension", [(Display, "dpy"), Out(Pointer(Int), "errorb"), Out(Pointer(Int), "event")]),
 218     Function(Bool_, "glXQueryVersion", [(Display, "dpy"), Out(Pointer(Int), "maj"), Out(Pointer(Int), "min")]),
 219     Function(Bool_, "glXIsDirect", [(Display, "dpy"), (GLXContext, "ctx")]),
 220     Function(GLXError, "glXGetConfig", [(Display, "dpy"), (Pointer(XVisualInfo), "visual"),
 221                                     (GLXAttrib, "attrib"), Out(Pointer(Int), "value")]),
 222     Function(GLXContext, "glXGetCurrentContext", [], sideeffects=False),
 223     Function(GLXDrawable, "glXGetCurrentDrawable", [], sideeffects=False),
 224     Function(Void, "glXWaitGL", []),
 225     Function(Void, "glXWaitX", []),
 226     Function(Void, "glXUseXFont", [(Font, "font"), (Int, "first"), (Int, "count"), (Int, "list")]),
 227
 228     # GLX 1.1 and later
 229     Function((Const(String("char *"))), "glXQueryExtensionsString", [(Display, "dpy"), (Int, "screen")]),
 230     Function((Const(String("char *"))), "glXQueryServerString",  [(Display, "dpy"), (Int, "screen"), (Int, "name")]),
 231     Function((Const(String("char *"))), "glXGetClientString", [(Display, "dpy"), (Int, "name")]),
 232
 233     # GLX 1.2 and later
 234     Function(Display, "glXGetCurrentDisplay", [], sideeffects=False),
 235
 236     # GLX 1.3 and later
 237     Function(Array(GLXFBConfig, "*nitems"), "glXChooseFBConfig", [(Display, "dpy"), (Int, "screen"), (Const(Array(GLXAttrib, "__AttribList_size(attribList)")), "attribList"), Out(Pointer(Int), "nitems")]),
 238     Function(Int, "glXGetFBConfigAttrib", [(Display, "dpy"), (GLXFBConfig, "config"), (GLXAttrib, "attribute"), Out(Pointer(Int), "value")]),
 239     Function(Array(GLXFBConfig, "*nelements"), "glXGetFBConfigs", [(Display, "dpy"), (Int, "screen"),
 240                                                                    Out(Pointer(Int), "nelements")]),
 241     Function(Pointer(XVisualInfo), "glXGetVisualFromFBConfig", [(Display, "dpy"),
 242                                                                 (GLXFBConfig, "config")]),
 243     Function(GLXWindow, "glXCreateWindow", [(Display, "dpy"), (GLXFBConfig, "config"),
 244                                             (Window, "win"), (Const(Array(Int, "__AttribList_size(attribList)")), "attribList")]),
 245     Function(Void, "glXDestroyWindow", [(Display, "dpy"), (GLXWindow, "window")]),
 246     Function(GLXPixmap, "glXCreatePixmap", [(Display, "dpy"), (GLXFBConfig, "config"),
 247                                             (Pixmap, "pixmap"), (Const(Array(Int, "__AttribList_size(attribList)")), "attribList")]),
 248     Function(Void, "glXDestroyPixmap", [(Display, "dpy"), (GLXPixmap, "pixmap")]),
 249     Function(GLXPbuffer, "glXCreatePbuffer", [(Display, "dpy"), (GLXFBConfig, "config"),
 250                                               (Const(Array(GLXEnum, "__AttribList_size(attribList)")), "attribList")]),
 251     Function(Void, "glXDestroyPbuffer", [(Display, "dpy"), (GLXPbuffer, "pbuf")]),
 252     Function(Void, "glXQueryDrawable", [(Display, "dpy"), (GLXDrawable, "draw"), (GLXEnum, "attribute"),
 253                                         Out(Pointer(UInt), "value")]),
 254     Function(GLXContext, "glXCreateNewContext", [(Display, "dpy"), (GLXFBConfig, "config"),
 255                                                  (GLXEnum, "renderType"), (GLXContext, "shareList"),
 256                                                  (Bool_, "direct")]),
 257     Function(Bool_, "glXMakeContextCurrent", [(Display, "dpy"), (GLXDrawable, "draw"),
 258                                              (GLXDrawable, "read"), (GLXContext, "ctx")]),
 259     Function(GLXDrawable, "glXGetCurrentReadDrawable", []),
 260     Function(Int, "glXQueryContext", [(Display, "dpy"), (GLXContext, "ctx"), (GLXEnum, "attribute"),
 261                                       Out(Pointer(Int), "value")]),
 262     Function(Void, "glXSelectEvent", [(Display, "dpy"), (GLXDrawable, "drawable"),
 263                                       (ULong, "mask")]),
 264     Function(Void, "glXGetSelectedEvent", [(Display, "dpy"), (GLXDrawable, "drawable"),
 265                                            Out(Pointer(ULong), "mask")]),
 266     # TODO: extensions
 267
 268     # Must be last
 269     Function(PROC, "glXGetProcAddressARB", [(Alias("const GLubyte *", CString), "procName")]),
 270     Function(PROC, "glXGetProcAddress", [(Alias("const GLubyte *", CString), "procName")]),
 271 ])
 272
 273