git.cworth.org Git - apitrace/blob - specs/cglapi.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 """CGL API description.
  27
  28 http://developer.apple.com/library/mac/#documentation/GraphicsImaging/Reference/CGL_OpenGL/Reference/reference.html
  29 """
  30
  31
  32 from stdapi import *
  33 from glapi import *
  34 from glapi import glapi
  35
  36 IOSurfaceRef = Opaque("IOSurfaceRef")
  37 CGLContextObj = Opaque("CGLContextObj")
  38 CGLPixelFormatObj = Opaque("CGLPixelFormatObj")
  39 CGLRendererInfoObj = Opaque("CGLRendererInfoObj")
  40 CGLPBufferObj = Opaque("CGLPBufferObj")
  41 CGLShareGroup = Opaque("CGLShareGroup")
  42 CGLShareGroupObj = Opaque("CGLShareGroupObj")
  43 CGSConnectionID = Opaque("CGSConnectionID")
  44 CGSWindowID = Alias("CGSWindowID", Int)
  45 CGSSurfaceID = Alias("CGSSurfaceID", Int)
  46
  47 CGLPixelFormatAttribute = Enum("CGLPixelFormatAttribute", [
  48     "kCGLPFAAllRenderers",
  49     "kCGLPFADoubleBuffer",
  50     "kCGLPFAStereo",
  51     "kCGLPFAAuxBuffers",
  52     "kCGLPFAColorSize",
  53     "kCGLPFAAlphaSize",
  54     "kCGLPFADepthSize",
  55     "kCGLPFAStencilSize",
  56     "kCGLPFAAccumSize",
  57     "kCGLPFAMinimumPolicy",
  58     "kCGLPFAMaximumPolicy",
  59     "kCGLPFAOffScreen",
  60     "kCGLPFAFullScreen",
  61     "kCGLPFASampleBuffers",
  62     "kCGLPFASamples",
  63     "kCGLPFAAuxDepthStencil",
  64     "kCGLPFAColorFloat",
  65     "kCGLPFAMultisample",
  66     "kCGLPFASupersample",
  67     "kCGLPFASampleAlpha",
  68     "kCGLPFARendererID",
  69     "kCGLPFASingleRenderer",
  70     "kCGLPFANoRecovery",
  71     "kCGLPFAAccelerated",
  72     "kCGLPFAClosestPolicy",
  73     "kCGLPFABackingStore",
  74     "kCGLPFAWindow",
  75     "kCGLPFACompliant",
  76     "kCGLPFADisplayMask",
  77     "kCGLPFAPBuffer",
  78     "kCGLPFARemotePBuffer",
  79     "kCGLPFAAllowOfflineRenderers",
  80     "kCGLPFAAcceleratedCompute",
  81     "kCGLPFAOpenGLProfile",
  82     "kCGLPFAVirtualScreenCount",
  83     "kCGLPFARobust",
  84     "kCGLPFAMPSafe",
  85     "kCGLPFAMultiScreen",
  86
  87     "kCGLOGLPVersion_Legacy",
  88     "kCGLOGLPVersion_3_2_Core",
  89 ])
  90
  91 CGLRendererProperty = Enum("CGLRendererProperty", [
  92     "kCGLRPOffScreen",
  93     "kCGLRPFullScreen",
  94     "kCGLRPRendererID",
  95     "kCGLRPAccelerated",
  96     "kCGLRPRobust",
  97     "kCGLRPBackingStore",
  98     "kCGLRPMPSafe",
  99     "kCGLRPWindow",
 100     "kCGLRPMultiScreen",
 101     "kCGLRPCompliant",
 102     "kCGLRPDisplayMask",
 103     "kCGLRPBufferModes",
 104     "kCGLRPColorModes",
 105     "kCGLRPAccumModes",
 106     "kCGLRPDepthModes",
 107     "kCGLRPStencilModes",
 108     "kCGLRPMaxAuxBuffers",
 109     "kCGLRPMaxSampleBuffers",
 110     "kCGLRPMaxSamples",
 111     "kCGLRPSampleModes",
 112     "kCGLRPSampleAlpha",
 113     "kCGLRPVideoMemory",
 114     "kCGLRPTextureMemory",
 115     "kCGLRPGPUVertProcCapable",
 116     "kCGLRPGPUFragProcCapable",
 117     "kCGLRPRendererCount",
 118     "kCGLRPOnline",
 119     "kCGLRPAcceleratedCompute",
 120 ])
 121
 122 CGLContextEnable = Enum("CGLContextEnable", [
 123     "kCGLCESwapRectangle",
 124     "kCGLCESwapLimit",
 125     "kCGLCERasterization",
 126     "kCGLCEStateValidation",
 127     "kCGLCESurfaceBackingSize",
 128     "kCGLCEDisplayListOptimization",
 129     "kCGLCEMPEngine",
 130 ])
 131
 132 CGLContextParameter = Enum("CGLContextParameter", [
 133     "kCGLCPSwapRectangle",
 134     "kCGLCPSwapInterval",
 135     "kCGLCPDispatchTableSize",
 136     "kCGLCPClientStorage",
 137     "kCGLCPSurfaceTexture",
 138     "kCGLCPSurfaceOrder",
 139     "kCGLCPSurfaceOpacity",
 140     "kCGLCPSurfaceBackingSize",
 141     "kCGLCPSurfaceSurfaceVolatile",
 142     "kCGLCPReclaimResources",
 143     "kCGLCPCurrentRendererID",
 144     "kCGLCPGPUVertexProcessing",
 145     "kCGLCPGPUFragmentProcessing",
 146     "kCGLCPHasDrawable",
 147     "kCGLCPMPSwapsInFlight",
 148 ])
 149
 150 CGLGlobalOption = Enum("CGLGlobalOption", [
 151     "kCGLGOFormatCacheSize",
 152     "kCGLGOClearFormatCache",
 153     "kCGLGORetainRenderers",
 154     "kCGLGOResetLibrary",
 155     "kCGLGOUseErrorHandler",
 156     "kCGLGOUseBuildCache",
 157 ])
 158
 159 CGLError = Enum("CGLError", [
 160     "kCGLNoError",
 161     "kCGLBadAttribute",
 162     "kCGLBadProperty",
 163     "kCGLBadPixelFormat",
 164     "kCGLBadRendererInfo",
 165     "kCGLBadContext",
 166     "kCGLBadDrawable",
 167     "kCGLBadDisplay",
 168     "kCGLBadState",
 169     "kCGLBadValue",
 170     "kCGLBadMatch",
 171     "kCGLBadEnumeration",
 172     "kCGLBadOffScreen",
 173     "kCGLBadFullScreen",
 174     "kCGLBadWindow",
 175     "kCGLBadAddress",
 176     "kCGLBadCodeModule",
 177     "kCGLBadAlloc",
 178     "kCGLBadConnection",
 179 ])
 180
 181 CGLContextObj = Opaque("CGLContextObj")
 182
 183 cglapi = Module("CGL")
 184
 185 cglapi.addFunctions([
 186     # CGLCurrent.h, libGL.dylib
 187     Function(CGLError, "CGLSetCurrentContext", [(CGLContextObj, "ctx")]),
 188     Function(CGLContextObj, "CGLGetCurrentContext", []),
 189
 190     # OpenGL.h, OpenGL framework
 191     Function(CGLError, "CGLChoosePixelFormat", [(Array(Const(CGLPixelFormatAttribute), "_AttribList_size(attribs)"), "attribs"), Out(Pointer(CGLPixelFormatObj), "pix"), Out(Pointer(GLint), "npix")]),
 192     Function(CGLError, "CGLDestroyPixelFormat", [(CGLPixelFormatObj, "pix")]),
 193     Function(CGLError, "CGLDescribePixelFormat", [(CGLPixelFormatObj, "pix"), (GLint, "pix_num"), (CGLPixelFormatAttribute, "attrib"), Out(Pointer(GLint), "value")]),
 194     Function(Void, "CGLReleasePixelFormat", [(CGLPixelFormatObj, "pix")]),
 195     Function(CGLPixelFormatObj, "CGLRetainPixelFormat", [(CGLPixelFormatObj, "pix")]),
 196     Function(GLuint, "CGLGetPixelFormatRetainCount", [(CGLPixelFormatObj, "pix")]),
 197     Function(CGLError, "CGLQueryRendererInfo", [(GLuint, "display_mask"), Out(Pointer(CGLRendererInfoObj), "rend"), Out(Pointer(GLint), "nrend")]),
 198     Function(CGLError, "CGLDestroyRendererInfo", [(CGLRendererInfoObj, "rend")]),
 199     Function(CGLError, "CGLDescribeRenderer", [(CGLRendererInfoObj, "rend"), (GLint, "rend_num"), (CGLRendererProperty, "prop"), (OpaquePointer(GLint), "value")]),
 200     Function(CGLError, "CGLCreateContext", [(CGLPixelFormatObj, "pix"), (CGLContextObj, "share"), Out(Pointer(CGLContextObj), "ctx")]),
 201     Function(CGLError, "CGLDestroyContext", [(CGLContextObj, "ctx")]),
 202     Function(CGLError, "CGLCopyContext", [(CGLContextObj, "src"), (CGLContextObj, "dst"), (GLbitfield, "mask")]),
 203     Function(CGLContextObj, "CGLRetainContext", [(CGLContextObj, "ctx")]),
 204     Function(Void, "CGLReleaseContext", [(CGLContextObj, "ctx")]),
 205     Function(GLuint, "CGLGetContextRetainCount", [(CGLContextObj, "ctx")]),
 206     Function(CGLPixelFormatObj, "CGLGetPixelFormat", [(CGLContextObj, "ctx")]),
 207     Function(CGLError, "CGLCreatePBuffer", [(GLsizei, "width"), (GLsizei, "height"), (GLenum, "target"), (GLenum, "internalFormat"), (GLint, "max_level"), Out(Pointer(CGLPBufferObj), "pbuffer")]),
 208     Function(CGLError, "CGLDestroyPBuffer", [(CGLPBufferObj, "pbuffer")]),
 209     Function(CGLError, "CGLDescribePBuffer", [(CGLPBufferObj, "obj"), Out(Pointer(GLsizei), "width"), Out(Pointer(GLsizei), "height"), Out(Pointer(GLenum), "target"), Out(Pointer(GLenum), "internalFormat"), Out(Pointer(GLint), "mipmap")]),
 210     Function(CGLError, "CGLTexImagePBuffer", [(CGLContextObj, "ctx"), (CGLPBufferObj, "pbuffer"), (GLenum, "source")]),
 211     Function(CGLPBufferObj, "CGLRetainPBuffer", [(CGLPBufferObj, "pbuffer")]),
 212     Function(Void, "CGLReleasePBuffer", [(CGLPBufferObj, "pbuffer")]),
 213     Function(GLuint, "CGLGetPBufferRetainCount", [(CGLPBufferObj, "pbuffer")]),
 214     Function(CGLError, "CGLSetOffScreen", [(CGLContextObj, "ctx"), (GLsizei, "width"), (GLsizei, "height"), (GLint, "rowbytes"), (OpaquePointer(Void), "baseaddr")]),
 215     Function(CGLError, "CGLGetOffScreen", [(CGLContextObj, "ctx"), Out(Pointer(GLsizei), "width"), Out(Pointer(GLsizei), "height"), Out(Pointer(GLint), "rowbytes"), Out(Pointer(OpaquePointer(Void)), "baseaddr")]),
 216     Function(CGLError, "CGLSetFullScreen", [(CGLContextObj, "ctx")]),
 217     Function(CGLError, "CGLSetFullScreenOnDisplay", [(CGLContextObj, "ctx"), (GLuint, "display_mask")]),
 218     Function(CGLError, "CGLSetPBuffer", [(CGLContextObj, "ctx"), (CGLPBufferObj, "pbuffer"), (GLenum, "face"), (GLint, "level"), (GLint, "screen")]),
 219     Function(CGLError, "CGLGetPBuffer", [(CGLContextObj, "ctx"), Out(Pointer(CGLPBufferObj), "pbuffer"), Out(Pointer(GLenum), "face"), Out(Pointer(GLint), "level"), Out(Pointer(GLint), "screen")]),
 220     Function(CGLError, "CGLClearDrawable", [(CGLContextObj, "ctx")]),
 221     Function(CGLError, "CGLFlushDrawable", [(CGLContextObj, "ctx")]),
 222     Function(CGLError, "CGLEnable", [(CGLContextObj, "ctx"), (CGLContextEnable, "pname")]),
 223     Function(CGLError, "CGLDisable", [(CGLContextObj, "ctx"), (CGLContextEnable, "pname")]),
 224     Function(CGLError, "CGLIsEnabled", [(CGLContextObj, "ctx"), (CGLContextEnable, "pname"), Out(Pointer(GLint), "enable")], sideeffects=False),
 225     Function(CGLError, "CGLSetParameter", [(CGLContextObj, "ctx"), (CGLContextParameter, "pname"), (Array(Const(GLint), 1), "params")]),
 226     Function(CGLError, "CGLGetParameter", [(CGLContextObj, "ctx"), (CGLContextParameter, "pname"), Out(Array(GLint, 1), "params")], sideeffects=False),
 227     Function(CGLError, "CGLSetVirtualScreen", [(CGLContextObj, "ctx"), (GLint, "screen")]),
 228     Function(CGLError, "CGLGetVirtualScreen", [(CGLContextObj, "ctx"), Out(Pointer(GLint), "screen")], sideeffects=False),
 229     Function(CGLError, "CGLSetGlobalOption", [(CGLGlobalOption, "pname"), (OpaquePointer(Const(GLint)), "params")]),
 230     Function(CGLError, "CGLGetGlobalOption", [(CGLGlobalOption, "pname"), Out(OpaquePointer(GLint), "params")]),
 231     Function(CGLError, "CGLSetOption", [(CGLGlobalOption, "pname"), (GLint, "param")]),
 232     Function(CGLError, "CGLGetOption", [(CGLGlobalOption, "pname"), Out(Pointer(GLint), "param")], sideeffects=False),
 233     Function(CGLError, "CGLLockContext", [(CGLContextObj, "ctx")]),
 234     Function(CGLError, "CGLUnlockContext", [(CGLContextObj, "ctx")]),
 235     Function(Void, "CGLGetVersion", [Out(Pointer(GLint), "majorvers"), Out(Pointer(GLint), "minorvers")], sideeffects=False),
 236     Function(ConstCString, "CGLErrorString", [(CGLError, "error")], sideeffects=False),
 237
 238     # CGLIOSurface.h, OpenGL framework
 239     Function(CGLError, "CGLTexImageIOSurface2D", [(CGLContextObj, "ctx"), (GLenum, "target"), (GLenum, "internal_format"), (GLsizei, "width"), (GLsizei, "height"), (GLenum, "format"), (GLenum, "type"), (IOSurfaceRef, "ioSurface"), (GLuint, "plane")]),
 240
 241     # CGLDevice.h, OpenGL framework
 242     Function(CGLShareGroupObj, "CGLGetShareGroup", [(CGLContextObj, "ctx")]),
 243
 244     # Undocumented, OpenGL framework
 245     Function(CGLError, "CGLSetSurface", [(CGLContextObj, "ctx"), (CGSConnectionID, "cid"), (CGSWindowID, "wid"), (CGSSurfaceID, "sid")]),
 246     Function(CGLError, "CGLGetSurface", [(CGLContextObj, "ctx"), (Pointer(CGSConnectionID), "cid"), (Pointer(CGSWindowID), "wid"), (Pointer(CGSSurfaceID), "sid")]),
 247     Function(CGLError, "CGLUpdateContext", [(CGLContextObj, "ctx")]),
 248     # XXX: Confirm CGLOpenCLMuxLockDown
 249     Function(CGLError, "CGLOpenCLMuxLockDown", []),
 250     # FIXME: CGLAreContextsShared
 251     # FIXME: CGLBackDispatch
 252     # FIXME: CGLFrontDispatch
 253     # FIXME: CGLGetNextContext
 254     # FIXME: CGLRestoreDispatch
 255     # FIXME: CGLRestoreDispatchFunction
 256     # FIXME: CGLSelectDispatch
 257     # FIXME: CGLSelectDispatchBounded
 258     # FIXME: CGLSelectDispatchFunction
 259     # FIXME: CGLSetPBufferVolatileState
 260 ])
 261