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