src/video/quartz/SDL_QuartzGL.m
author Ryan C. Gordon
Tue, 06 Dec 2005 14:36:39 +0000
changeset 1195 bb6791b0a268
parent 1189 c96b326b90ba
child 1400 5abff0870de2
permissions -rw-r--r--
Fixed OpenGL usage in Quartz target when SDL_SetVideoMode() is called without
explicitly calling SDL_GL_LoadLibrary() first.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2003  Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Library General Public
     7     License as published by the Free Software Foundation; either
     8     version 2 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Library General Public License for more details.
    14 
    15     You should have received a copy of the GNU Library General Public
    16     License along with this library; if not, write to the Free
    17     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 #include "SDL_QuartzVideo.h"
    24 
    25 /*
    26  * GL_ARB_Multisample is supposed to be available in 10.1, according to Apple:
    27  *
    28  *   http://developer.apple.com/opengl/extensions.html#GL_ARB_multisample
    29  *
    30  *  ...but it isn't in the system headers, according to Sam:
    31  *
    32  *   http://www.libsdl.org/pipermail/sdl/2003-December/058335.html
    33  *
    34  * These are normally enums and not #defines in the system headers.
    35  *
    36  *   --ryan.
    37  */
    38 #if (MAC_OS_X_VERSION_MAX_ALLOWED < 1020)
    39 #define NSOpenGLPFASampleBuffers ((NSOpenGLPixelFormatAttribute) 55)
    40 #define NSOpenGLPFASamples ((NSOpenGLPixelFormatAttribute) 56)
    41 #endif
    42 
    43 
    44 @implementation NSOpenGLContext (CGLContextAccess)
    45 - (CGLContextObj) cglContext;
    46 {
    47     return _contextAuxiliary;
    48 }
    49 @end
    50 
    51 /* OpenGL helper functions (used internally) */
    52 
    53 int QZ_SetupOpenGL (_THIS, int bpp, Uint32 flags) {
    54 
    55     NSOpenGLPixelFormatAttribute attr[32];
    56     NSOpenGLPixelFormat *fmt;
    57     int i = 0;
    58     int colorBits = bpp;
    59 
    60     /* if a GL library hasn't been loaded at this point, load the default. */
    61     if (!this->gl_config.driver_loaded) {
    62         if (QZ_GL_LoadLibrary(this, NULL) == -1)
    63             return 0;
    64     }
    65 
    66     if ( flags & SDL_FULLSCREEN ) {
    67 
    68         attr[i++] = NSOpenGLPFAFullScreen;
    69     }
    70     /* In windowed mode, the OpenGL pixel depth must match device pixel depth */
    71     else if ( colorBits != device_bpp ) {
    72 
    73         colorBits = device_bpp;
    74     }
    75 
    76     attr[i++] = NSOpenGLPFAColorSize;
    77     attr[i++] = colorBits;
    78 
    79     attr[i++] = NSOpenGLPFADepthSize;
    80     attr[i++] = this->gl_config.depth_size;
    81 
    82     if ( this->gl_config.double_buffer ) {
    83         attr[i++] = NSOpenGLPFADoubleBuffer;
    84     }
    85 
    86     if ( this->gl_config.stereo ) {
    87         attr[i++] = NSOpenGLPFAStereo;
    88     }
    89 
    90     if ( this->gl_config.stencil_size != 0 ) {
    91         attr[i++] = NSOpenGLPFAStencilSize;
    92         attr[i++] = this->gl_config.stencil_size;
    93     }
    94 
    95     if ( (this->gl_config.accum_red_size +
    96           this->gl_config.accum_green_size +
    97           this->gl_config.accum_blue_size +
    98           this->gl_config.accum_alpha_size) > 0 ) {
    99         attr[i++] = NSOpenGLPFAAccumSize;
   100         attr[i++] = this->gl_config.accum_red_size + this->gl_config.accum_green_size + this->gl_config.accum_blue_size + this->gl_config.accum_alpha_size;
   101     }
   102 
   103     if ( this->gl_config.multisamplebuffers != 0 ) {
   104         attr[i++] = NSOpenGLPFASampleBuffers;
   105         attr[i++] = this->gl_config.multisamplebuffers;
   106     }
   107 
   108     if ( this->gl_config.multisamplesamples != 0 ) {
   109         attr[i++] = NSOpenGLPFASamples;
   110         attr[i++] = this->gl_config.multisamplesamples;
   111         attr[i++] = NSOpenGLPFANoRecovery;
   112         attr[i++] = (NSOpenGLPixelFormatAttribute)nil;
   113     }
   114 
   115     attr[i++] = NSOpenGLPFAScreenMask;
   116     attr[i++] = CGDisplayIDToOpenGLDisplayMask (display_id);
   117     attr[i] = 0;
   118 
   119     fmt = [ [ NSOpenGLPixelFormat alloc ] initWithAttributes:attr ];
   120     if (fmt == nil) {
   121         SDL_SetError ("Failed creating OpenGL pixel format");
   122         return 0;
   123     }
   124 
   125     gl_context = [ [ NSOpenGLContext alloc ] initWithFormat:fmt
   126                                                shareContext:nil];
   127 
   128     [ fmt release ];
   129 
   130     if (gl_context == nil) {
   131         SDL_SetError ("Failed creating OpenGL context");
   132         return 0;
   133     }
   134 
   135     /*
   136      * Wisdom from Apple engineer in reference to UT2003's OpenGL performance:
   137      *  "You are blowing a couple of the internal OpenGL function caches. This
   138      *  appears to be happening in the VAO case.  You can tell OpenGL to up
   139      *  the cache size by issuing the following calls right after you create
   140      *  the OpenGL context.  The default cache size is 16."    --ryan.
   141      */
   142 
   143     #ifndef GLI_ARRAY_FUNC_CACHE_MAX
   144     #define GLI_ARRAY_FUNC_CACHE_MAX 284
   145     #endif
   146 
   147     #ifndef GLI_SUBMIT_FUNC_CACHE_MAX
   148     #define GLI_SUBMIT_FUNC_CACHE_MAX 280
   149     #endif
   150 
   151     {
   152         long cache_max = 64;
   153         CGLContextObj ctx = [ gl_context cglContext ];
   154         CGLSetParameter (ctx, GLI_SUBMIT_FUNC_CACHE_MAX, &cache_max);
   155         CGLSetParameter (ctx, GLI_ARRAY_FUNC_CACHE_MAX, &cache_max);
   156     }
   157 
   158     /* End Wisdom from Apple Engineer section. --ryan. */
   159 
   160     return 1;
   161 }
   162 
   163 void QZ_TearDownOpenGL (_THIS) {
   164 
   165     [ NSOpenGLContext clearCurrentContext ];
   166     [ gl_context clearDrawable ];
   167     [ gl_context release ];
   168 }
   169 
   170 
   171 /* SDL OpenGL functions */
   172 static const char *DEFAULT_OPENGL_LIB_NAME =
   173     "/System/Library/Frameworks/OpenGL.framework/Libraries/libGL.dylib";
   174 
   175 int    QZ_GL_LoadLibrary    (_THIS, const char *location) {
   176     if ( gl_context != NULL ) {
   177         SDL_SetError("OpenGL context already created");
   178         return -1;
   179     }
   180 
   181     if (opengl_library != NULL)
   182         SDL_UnloadObject(opengl_library);
   183 
   184     if (location == NULL)
   185         location = DEFAULT_OPENGL_LIB_NAME;
   186 
   187     opengl_library = SDL_LoadObject(location);
   188     if (opengl_library != NULL) {
   189         this->gl_config.driver_loaded = 1;
   190         return 0;
   191     }
   192 
   193     this->gl_config.driver_loaded = 0;
   194     return -1;
   195 }
   196 
   197 void*  QZ_GL_GetProcAddress (_THIS, const char *proc) {
   198     return SDL_LoadFunction(opengl_library, proc);
   199 }
   200 
   201 int    QZ_GL_GetAttribute   (_THIS, SDL_GLattr attrib, int* value) {
   202 
   203     GLenum attr = 0;
   204 
   205     QZ_GL_MakeCurrent (this);
   206 
   207     switch (attrib) {
   208         case SDL_GL_RED_SIZE: attr = GL_RED_BITS;   break;
   209         case SDL_GL_BLUE_SIZE: attr = GL_BLUE_BITS;  break;
   210         case SDL_GL_GREEN_SIZE: attr = GL_GREEN_BITS; break;
   211         case SDL_GL_ALPHA_SIZE: attr = GL_ALPHA_BITS; break;
   212         case SDL_GL_DOUBLEBUFFER: attr = GL_DOUBLEBUFFER; break;
   213         case SDL_GL_DEPTH_SIZE: attr = GL_DEPTH_BITS;  break;
   214         case SDL_GL_STENCIL_SIZE: attr = GL_STENCIL_BITS; break;
   215         case SDL_GL_ACCUM_RED_SIZE: attr = GL_ACCUM_RED_BITS; break;
   216         case SDL_GL_ACCUM_GREEN_SIZE: attr = GL_ACCUM_GREEN_BITS; break;
   217         case SDL_GL_ACCUM_BLUE_SIZE: attr = GL_ACCUM_BLUE_BITS; break;
   218         case SDL_GL_ACCUM_ALPHA_SIZE: attr = GL_ACCUM_ALPHA_BITS; break;
   219         case SDL_GL_STEREO: attr = GL_STEREO; break;
   220         case SDL_GL_MULTISAMPLEBUFFERS: attr = GL_SAMPLE_BUFFERS_ARB; break;
   221         case SDL_GL_MULTISAMPLESAMPLES: attr = GL_SAMPLES_ARB; break;
   222         case SDL_GL_BUFFER_SIZE:
   223         {
   224             GLint bits = 0;
   225             GLint component;
   226 
   227             /* there doesn't seem to be a single flag in OpenGL for this! */
   228             glGetIntegerv (GL_RED_BITS, &component);   bits += component;
   229             glGetIntegerv (GL_GREEN_BITS,&component);  bits += component;
   230             glGetIntegerv (GL_BLUE_BITS, &component);  bits += component;
   231             glGetIntegerv (GL_ALPHA_BITS, &component); bits += component;
   232 
   233             *value = bits;
   234         }
   235         return 0;
   236     }
   237 
   238     glGetIntegerv (attr, (GLint *)value);
   239     return 0;
   240 }
   241 
   242 int    QZ_GL_MakeCurrent    (_THIS) {
   243     [ gl_context makeCurrentContext ];
   244     return 0;
   245 }
   246 
   247 void   QZ_GL_SwapBuffers    (_THIS) {
   248     [ gl_context flushBuffer ];
   249 }