src/video/cocoa/SDL_cocoaopengl.m
author Sam Lantinga <slouken@libsdl.org>
Mon, 08 Dec 2008 00:27:32 +0000
changeset 2859 99210400e8b9
parent 2738 79c1bd651f04
child 3057 089a77aebb7d
permissions -rw-r--r--
Updated copyright date
slouken@1936
     1
/*
slouken@1936
     2
    SDL - Simple DirectMedia Layer
slouken@2859
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@1936
     4
slouken@1936
     5
    This library is free software; you can redistribute it and/or
slouken@1936
     6
    modify it under the terms of the GNU Lesser General Public
slouken@1936
     7
    License as published by the Free Software Foundation; either
slouken@1936
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@1936
     9
slouken@1936
    10
    This library is distributed in the hope that it will be useful,
slouken@1936
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@1936
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1936
    13
    Lesser General Public License for more details.
slouken@1936
    14
slouken@1936
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1936
    16
    License along with this library; if not, write to the Free Software
slouken@1936
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@1936
    18
slouken@1936
    19
    Sam Lantinga
slouken@1936
    20
    slouken@libsdl.org
slouken@1936
    21
*/
slouken@1936
    22
#include "SDL_config.h"
slouken@1936
    23
slouken@1936
    24
#include "SDL_cocoavideo.h"
slouken@1936
    25
slouken@1936
    26
/* NSOpenGL implementation of SDL OpenGL support */
slouken@1936
    27
slouken@1952
    28
#if SDL_VIDEO_OPENGL_CGL
slouken@1936
    29
#include <OpenGL/CGLTypes.h>
slouken@2738
    30
#include <OpenGL/OpenGL.h>
slouken@1936
    31
slouken@1936
    32
#include "SDL_loadso.h"
slouken@1936
    33
#include "SDL_opengl.h"
slouken@1936
    34
slouken@1936
    35
slouken@1952
    36
#define DEFAULT_OPENGL  "/System/Library/Frameworks/OpenGL.framework/Libraries/libGL.dylib"
slouken@1936
    37
slouken@1936
    38
/* This is implemented in Mac OS X 10.3 and above */
slouken@1936
    39
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_3
slouken@1936
    40
@implementation NSOpenGLContext(CGLContextAccess)
slouken@1936
    41
- (CGLContextObj)CGLContextObj;
slouken@1936
    42
{
slouken@1936
    43
    return _contextAuxiliary;
slouken@1936
    44
}
slouken@1936
    45
@end
slouken@1936
    46
#endif /* < 10.3 */
slouken@1936
    47
slouken@1936
    48
int
slouken@1936
    49
Cocoa_GL_LoadLibrary(_THIS, const char *path)
slouken@1936
    50
{
slouken@1936
    51
    if (_this->gl_config.driver_loaded) {
slouken@1936
    52
        if (path) {
slouken@1936
    53
            SDL_SetError("OpenGL library already loaded");
slouken@1936
    54
            return -1;
slouken@1936
    55
        } else {
slouken@1936
    56
            ++_this->gl_config.driver_loaded;
slouken@1936
    57
            return 0;
slouken@1936
    58
        }
slouken@1936
    59
    }
slouken@1936
    60
    if (path == NULL) {
slouken@1952
    61
        path = SDL_getenv("SDL_OPENGL_LIBRARY");
slouken@1952
    62
    }
slouken@1952
    63
    if (path == NULL) {
slouken@1952
    64
        path = DEFAULT_OPENGL;
slouken@1936
    65
    }
slouken@1936
    66
    _this->gl_config.dll_handle = SDL_LoadObject(path);
slouken@1936
    67
    if (!_this->gl_config.dll_handle) {
slouken@1936
    68
        return -1;
slouken@1936
    69
    }
slouken@1936
    70
    SDL_strlcpy(_this->gl_config.driver_path, path,
slouken@1936
    71
                SDL_arraysize(_this->gl_config.driver_path));
slouken@1936
    72
    _this->gl_config.driver_loaded = 1;
slouken@1936
    73
    return 0;
slouken@1936
    74
}
slouken@1936
    75
slouken@1936
    76
void *
slouken@1936
    77
Cocoa_GL_GetProcAddress(_THIS, const char *proc)
slouken@1936
    78
{
slouken@1936
    79
    return SDL_LoadFunction(_this->gl_config.dll_handle, proc);
slouken@1936
    80
}
slouken@1936
    81
slouken@1936
    82
static void
slouken@1936
    83
Cocoa_GL_UnloadLibrary(_THIS)
slouken@1936
    84
{
slouken@1936
    85
    if (_this->gl_config.driver_loaded > 0) {
slouken@1936
    86
        if (--_this->gl_config.driver_loaded > 0) {
slouken@1936
    87
            return;
slouken@1936
    88
        }
slouken@1936
    89
        SDL_UnloadObject(_this->gl_config.dll_handle);
slouken@1936
    90
        _this->gl_config.dll_handle = NULL;
slouken@1936
    91
    }
slouken@1936
    92
}
slouken@1936
    93
slouken@1936
    94
static int
slouken@1936
    95
Cocoa_GL_Initialize(_THIS)
slouken@1936
    96
{
slouken@1936
    97
    if (_this->gl_data) {
slouken@1936
    98
        ++_this->gl_data->initialized;
slouken@1936
    99
        return 0;
slouken@1936
   100
    }
slouken@1936
   101
slouken@1936
   102
    _this->gl_data =
slouken@1936
   103
        (struct SDL_GLDriverData *) SDL_calloc(1,
slouken@1936
   104
                                               sizeof(struct
slouken@1936
   105
                                                      SDL_GLDriverData));
slouken@1936
   106
    if (!_this->gl_data) {
slouken@1936
   107
        SDL_OutOfMemory();
slouken@1936
   108
        return -1;
slouken@1936
   109
    }
slouken@1936
   110
    _this->gl_data->initialized = 1;
slouken@1936
   111
slouken@1936
   112
    if (Cocoa_GL_LoadLibrary(_this, NULL) < 0) {
slouken@1936
   113
        return -1;
slouken@1936
   114
    }
slouken@1936
   115
    return 0;
slouken@1936
   116
}
slouken@1936
   117
slouken@1952
   118
static void
slouken@1952
   119
Cocoa_GL_Shutdown(_THIS)
slouken@1952
   120
{
slouken@1952
   121
    if (!_this->gl_data || (--_this->gl_data->initialized > 0)) {
slouken@1952
   122
        return;
slouken@1952
   123
    }
slouken@1952
   124
slouken@1952
   125
    Cocoa_GL_UnloadLibrary(_this);
slouken@1952
   126
slouken@1952
   127
    SDL_free(_this->gl_data);
slouken@1952
   128
    _this->gl_data = NULL;
slouken@1952
   129
}
slouken@1952
   130
slouken@1936
   131
int
slouken@1936
   132
Cocoa_GL_SetupWindow(_THIS, SDL_Window * window)
slouken@1936
   133
{
slouken@1936
   134
    if (Cocoa_GL_Initialize(_this) < 0) {
slouken@1936
   135
        return -1;
slouken@1936
   136
    }
slouken@1936
   137
    return 0;
slouken@1936
   138
}
slouken@1936
   139
slouken@1936
   140
void
slouken@1936
   141
Cocoa_GL_CleanupWindow(_THIS, SDL_Window * window)
slouken@1936
   142
{
slouken@1936
   143
    Cocoa_GL_Shutdown(_this);
slouken@1936
   144
}
slouken@1936
   145
slouken@1936
   146
SDL_GLContext
slouken@1936
   147
Cocoa_GL_CreateContext(_THIS, SDL_Window * window)
slouken@1936
   148
{
slouken@1936
   149
    NSAutoreleasePool *pool;
slouken@1936
   150
    SDL_VideoDisplay *display = SDL_GetDisplayFromWindow(window);
slouken@1936
   151
    SDL_DisplayData *displaydata = (SDL_DisplayData *)display->driverdata;
slouken@1936
   152
    NSOpenGLPixelFormatAttribute attr[32];
slouken@1936
   153
    NSOpenGLPixelFormat *fmt;
slouken@2178
   154
    NSOpenGLContext *context;
slouken@1936
   155
    int i = 0;
slouken@1936
   156
slouken@1936
   157
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   158
slouken@1936
   159
    if (window->flags & SDL_WINDOW_FULLSCREEN) {
slouken@1936
   160
        attr[i++] = NSOpenGLPFAFullScreen;
slouken@1936
   161
    }
slouken@1936
   162
slouken@1936
   163
    attr[i++] = NSOpenGLPFAColorSize;
slouken@1936
   164
    attr[i++] = SDL_BYTESPERPIXEL(display->current_mode.format)*8;
slouken@1936
   165
slouken@1936
   166
    attr[i++] = NSOpenGLPFADepthSize;
slouken@1936
   167
    attr[i++] = _this->gl_config.depth_size;
slouken@1936
   168
slouken@1936
   169
    if (_this->gl_config.double_buffer) {
slouken@1936
   170
        attr[i++] = NSOpenGLPFADoubleBuffer;
slouken@1936
   171
    }
slouken@1936
   172
slouken@1936
   173
    if (_this->gl_config.stereo) {
slouken@1936
   174
        attr[i++] = NSOpenGLPFAStereo;
slouken@1936
   175
    }
slouken@1936
   176
slouken@1936
   177
    if (_this->gl_config.stencil_size) {
slouken@1936
   178
        attr[i++] = NSOpenGLPFAStencilSize;
slouken@1936
   179
        attr[i++] = _this->gl_config.stencil_size;
slouken@1936
   180
    }
slouken@1936
   181
slouken@1936
   182
    if ((_this->gl_config.accum_red_size +
slouken@1936
   183
         _this->gl_config.accum_green_size +
slouken@1936
   184
         _this->gl_config.accum_blue_size +
slouken@1936
   185
         _this->gl_config.accum_alpha_size) > 0) {
slouken@1936
   186
        attr[i++] = NSOpenGLPFAAccumSize;
slouken@1936
   187
        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;
slouken@1936
   188
    }
slouken@1936
   189
slouken@1936
   190
    if (_this->gl_config.multisamplebuffers) {
slouken@1936
   191
        attr[i++] = NSOpenGLPFASampleBuffers;
slouken@1936
   192
        attr[i++] = _this->gl_config.multisamplebuffers;
slouken@1936
   193
    }
slouken@1936
   194
slouken@1936
   195
    if (_this->gl_config.multisamplesamples) {
slouken@1936
   196
        attr[i++] = NSOpenGLPFASamples;
slouken@1936
   197
        attr[i++] = _this->gl_config.multisamplesamples;
slouken@1936
   198
        attr[i++] = NSOpenGLPFANoRecovery;
slouken@1936
   199
    }
slouken@1936
   200
slouken@1936
   201
    if (_this->gl_config.accelerated > 0) {
slouken@1936
   202
        attr[i++] = NSOpenGLPFAAccelerated;
slouken@1936
   203
    }
slouken@1936
   204
slouken@1936
   205
    attr[i++] = NSOpenGLPFAScreenMask;
slouken@1936
   206
    attr[i++] = CGDisplayIDToOpenGLDisplayMask(displaydata->display);
slouken@1936
   207
    attr[i] = 0;
slouken@1936
   208
slouken@1936
   209
    fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attr];
slouken@1936
   210
    if (fmt == nil) {
slouken@1936
   211
        SDL_SetError ("Failed creating OpenGL pixel format");
slouken@1936
   212
        [pool release];
slouken@1936
   213
        return NULL;
slouken@1936
   214
    }
slouken@1936
   215
slouken@2178
   216
    context = [[NSOpenGLContext alloc] initWithFormat:fmt shareContext:nil];
slouken@1936
   217
slouken@1936
   218
    [fmt release];
slouken@1936
   219
slouken@2178
   220
    if (context == nil) {
slouken@1936
   221
        SDL_SetError ("Failed creating OpenGL context");
slouken@1936
   222
        [pool release];
slouken@1936
   223
        return NULL;
slouken@1936
   224
    }
slouken@1936
   225
slouken@1936
   226
    /*
slouken@1936
   227
     * Wisdom from Apple engineer in reference to UT2003's OpenGL performance:
slouken@1936
   228
     *  "You are blowing a couple of the internal OpenGL function caches. This
slouken@1936
   229
     *  appears to be happening in the VAO case.  You can tell OpenGL to up
slouken@1936
   230
     *  the cache size by issuing the following calls right after you create
slouken@1936
   231
     *  the OpenGL context.  The default cache size is 16."    --ryan.
slouken@1936
   232
     */
slouken@1936
   233
slouken@1936
   234
    #ifndef GLI_ARRAY_FUNC_CACHE_MAX
slouken@1936
   235
    #define GLI_ARRAY_FUNC_CACHE_MAX 284
slouken@1936
   236
    #endif
slouken@1936
   237
slouken@1936
   238
    #ifndef GLI_SUBMIT_FUNC_CACHE_MAX
slouken@1936
   239
    #define GLI_SUBMIT_FUNC_CACHE_MAX 280
slouken@1936
   240
    #endif
slouken@1936
   241
slouken@1936
   242
    {
slouken@1936
   243
        long cache_max = 64;
slouken@2178
   244
        CGLContextObj ctx = [context CGLContextObj];
slouken@1936
   245
        CGLSetParameter (ctx, GLI_SUBMIT_FUNC_CACHE_MAX, &cache_max);
slouken@1936
   246
        CGLSetParameter (ctx, GLI_ARRAY_FUNC_CACHE_MAX, &cache_max);
slouken@1936
   247
    }
slouken@1936
   248
slouken@1936
   249
    /* End Wisdom from Apple Engineer section. --ryan. */
slouken@1936
   250
slouken@1936
   251
    [pool release];
slouken@2178
   252
slouken@2178
   253
    if ( Cocoa_GL_MakeCurrent(_this, window, context) < 0 ) {
slouken@2178
   254
        Cocoa_GL_DeleteContext(_this, context);
slouken@2178
   255
        return NULL;
slouken@2178
   256
    }
slouken@2178
   257
slouken@2178
   258
    return context;
slouken@1936
   259
}
slouken@1936
   260
slouken@1936
   261
int
slouken@1936
   262
Cocoa_GL_MakeCurrent(_THIS, SDL_Window * window, SDL_GLContext context)
slouken@1936
   263
{
slouken@1936
   264
    NSAutoreleasePool *pool;
slouken@1936
   265
slouken@1936
   266
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   267
slouken@1936
   268
    if (context) {
slouken@1936
   269
        SDL_WindowData *windowdata = (SDL_WindowData *)window->driverdata;
slouken@1936
   270
        NSOpenGLContext *nscontext = (NSOpenGLContext *)context;
slouken@1936
   271
slouken@1973
   272
        if (window->flags & SDL_WINDOW_FULLSCREEN) {
slouken@1973
   273
            [nscontext setFullScreen];
slouken@1973
   274
        } else {
slouken@1973
   275
            [nscontext setView:[windowdata->window contentView]];
slouken@1973
   276
            [nscontext update];
slouken@1973
   277
        }
slouken@1936
   278
        [nscontext makeCurrentContext];
slouken@1936
   279
    } else {
slouken@1936
   280
        [NSOpenGLContext clearCurrentContext];
slouken@1936
   281
    }
slouken@1936
   282
slouken@1936
   283
    [pool release];
slouken@1936
   284
    return 0;
slouken@1936
   285
}
slouken@1936
   286
slouken@1936
   287
int
slouken@1936
   288
Cocoa_GL_SetSwapInterval(_THIS, int interval)
slouken@1936
   289
{
slouken@1936
   290
    NSAutoreleasePool *pool;
slouken@1936
   291
    NSOpenGLContext *nscontext;
slouken@2703
   292
    GLint value;
slouken@1936
   293
    int status;
slouken@1936
   294
slouken@1936
   295
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   296
slouken@1936
   297
    nscontext = [NSOpenGLContext currentContext];
slouken@1936
   298
    if (nscontext != nil) {
slouken@1936
   299
        value = interval;
slouken@1936
   300
        [nscontext setValues:&value forParameter:NSOpenGLCPSwapInterval];
slouken@1936
   301
        status = 0;
slouken@1936
   302
    } else {
slouken@1936
   303
        SDL_SetError("No current OpenGL context");
slouken@1936
   304
        status = -1;
slouken@1936
   305
    }
slouken@1936
   306
slouken@1936
   307
    [pool release];
slouken@1936
   308
    return status;
slouken@1936
   309
}
slouken@1936
   310
slouken@1936
   311
int
slouken@1936
   312
Cocoa_GL_GetSwapInterval(_THIS)
slouken@1936
   313
{
slouken@1936
   314
    NSAutoreleasePool *pool;
slouken@1936
   315
    NSOpenGLContext *nscontext;
slouken@2703
   316
    GLint value;
slouken@1936
   317
    int status;
slouken@1936
   318
slouken@1936
   319
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   320
slouken@1936
   321
    nscontext = [NSOpenGLContext currentContext];
slouken@1936
   322
    if (nscontext != nil) {
slouken@1936
   323
        [nscontext getValues:&value forParameter:NSOpenGLCPSwapInterval];
slouken@1936
   324
        status = (int)value;
slouken@1936
   325
    } else {
slouken@1936
   326
        SDL_SetError("No current OpenGL context");
slouken@1936
   327
        status = -1;
slouken@1936
   328
    }
slouken@1936
   329
slouken@1936
   330
    [pool release];
slouken@1936
   331
    return status;
slouken@1936
   332
}
slouken@1936
   333
slouken@1936
   334
void
slouken@1936
   335
Cocoa_GL_SwapWindow(_THIS, SDL_Window * window)
slouken@1936
   336
{
slouken@1936
   337
    NSAutoreleasePool *pool;
slouken@1936
   338
    NSOpenGLContext *nscontext;
slouken@1936
   339
slouken@1936
   340
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   341
slouken@1936
   342
    /* FIXME: Do we need to get the context for the window? */
slouken@1936
   343
    nscontext = [NSOpenGLContext currentContext];
slouken@1936
   344
    if (nscontext != nil) {
slouken@1936
   345
        [nscontext flushBuffer];
slouken@1936
   346
    }
slouken@1936
   347
slouken@1936
   348
    [pool release];
slouken@1936
   349
}
slouken@1936
   350
slouken@1936
   351
void
slouken@1936
   352
Cocoa_GL_DeleteContext(_THIS, SDL_GLContext context)
slouken@1936
   353
{
slouken@1936
   354
    NSAutoreleasePool *pool;
slouken@1936
   355
    NSOpenGLContext *nscontext = (NSOpenGLContext *)context;
slouken@1936
   356
slouken@1936
   357
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   358
slouken@1936
   359
    [nscontext clearDrawable];
slouken@1936
   360
    [nscontext release];
slouken@1936
   361
slouken@1936
   362
    [pool release];
slouken@1936
   363
}
slouken@1936
   364
slouken@1952
   365
#endif /* SDL_VIDEO_OPENGL_CGL */
slouken@1936
   366
slouken@1936
   367
/* vi: set ts=4 sw=4 expandtab: */