src/video/cocoa/SDL_cocoaopengl.m
author Sam Lantinga <slouken@libsdl.org>
Mon, 09 Feb 2009 05:32:12 +0000
changeset 3057 089a77aebb7d
parent 2859 99210400e8b9
child 3570 7812d3e9564e
permissions -rw-r--r--
Added test program for SDL_CreateWindowFrom()
Make sure OpenGL library is loaded before working with OpenGL windows,
even those created with SDL_CreateWindowFrom()
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@3057
    51
    /* Load the OpenGL library */
slouken@1936
    52
    if (path == NULL) {
slouken@1952
    53
        path = SDL_getenv("SDL_OPENGL_LIBRARY");
slouken@1952
    54
    }
slouken@1952
    55
    if (path == NULL) {
slouken@1952
    56
        path = DEFAULT_OPENGL;
slouken@1936
    57
    }
slouken@1936
    58
    _this->gl_config.dll_handle = SDL_LoadObject(path);
slouken@1936
    59
    if (!_this->gl_config.dll_handle) {
slouken@1936
    60
        return -1;
slouken@1936
    61
    }
slouken@1936
    62
    SDL_strlcpy(_this->gl_config.driver_path, path,
slouken@1936
    63
                SDL_arraysize(_this->gl_config.driver_path));
slouken@1936
    64
    return 0;
slouken@1936
    65
}
slouken@1936
    66
slouken@1936
    67
void *
slouken@1936
    68
Cocoa_GL_GetProcAddress(_THIS, const char *proc)
slouken@1936
    69
{
slouken@1936
    70
    return SDL_LoadFunction(_this->gl_config.dll_handle, proc);
slouken@1936
    71
}
slouken@1936
    72
slouken@3057
    73
void
slouken@1936
    74
Cocoa_GL_UnloadLibrary(_THIS)
slouken@1936
    75
{
slouken@3057
    76
    SDL_UnloadObject(_this->gl_config.dll_handle);
slouken@3057
    77
    _this->gl_config.dll_handle = NULL;
slouken@1936
    78
}
slouken@1936
    79
slouken@1936
    80
SDL_GLContext
slouken@1936
    81
Cocoa_GL_CreateContext(_THIS, SDL_Window * window)
slouken@1936
    82
{
slouken@1936
    83
    NSAutoreleasePool *pool;
slouken@1936
    84
    SDL_VideoDisplay *display = SDL_GetDisplayFromWindow(window);
slouken@1936
    85
    SDL_DisplayData *displaydata = (SDL_DisplayData *)display->driverdata;
slouken@1936
    86
    NSOpenGLPixelFormatAttribute attr[32];
slouken@1936
    87
    NSOpenGLPixelFormat *fmt;
slouken@2178
    88
    NSOpenGLContext *context;
slouken@1936
    89
    int i = 0;
slouken@1936
    90
slouken@1936
    91
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
    92
slouken@1936
    93
    if (window->flags & SDL_WINDOW_FULLSCREEN) {
slouken@1936
    94
        attr[i++] = NSOpenGLPFAFullScreen;
slouken@1936
    95
    }
slouken@1936
    96
slouken@1936
    97
    attr[i++] = NSOpenGLPFAColorSize;
slouken@1936
    98
    attr[i++] = SDL_BYTESPERPIXEL(display->current_mode.format)*8;
slouken@1936
    99
slouken@1936
   100
    attr[i++] = NSOpenGLPFADepthSize;
slouken@1936
   101
    attr[i++] = _this->gl_config.depth_size;
slouken@1936
   102
slouken@1936
   103
    if (_this->gl_config.double_buffer) {
slouken@1936
   104
        attr[i++] = NSOpenGLPFADoubleBuffer;
slouken@1936
   105
    }
slouken@1936
   106
slouken@1936
   107
    if (_this->gl_config.stereo) {
slouken@1936
   108
        attr[i++] = NSOpenGLPFAStereo;
slouken@1936
   109
    }
slouken@1936
   110
slouken@1936
   111
    if (_this->gl_config.stencil_size) {
slouken@1936
   112
        attr[i++] = NSOpenGLPFAStencilSize;
slouken@1936
   113
        attr[i++] = _this->gl_config.stencil_size;
slouken@1936
   114
    }
slouken@1936
   115
slouken@1936
   116
    if ((_this->gl_config.accum_red_size +
slouken@1936
   117
         _this->gl_config.accum_green_size +
slouken@1936
   118
         _this->gl_config.accum_blue_size +
slouken@1936
   119
         _this->gl_config.accum_alpha_size) > 0) {
slouken@1936
   120
        attr[i++] = NSOpenGLPFAAccumSize;
slouken@1936
   121
        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
   122
    }
slouken@1936
   123
slouken@1936
   124
    if (_this->gl_config.multisamplebuffers) {
slouken@1936
   125
        attr[i++] = NSOpenGLPFASampleBuffers;
slouken@1936
   126
        attr[i++] = _this->gl_config.multisamplebuffers;
slouken@1936
   127
    }
slouken@1936
   128
slouken@1936
   129
    if (_this->gl_config.multisamplesamples) {
slouken@1936
   130
        attr[i++] = NSOpenGLPFASamples;
slouken@1936
   131
        attr[i++] = _this->gl_config.multisamplesamples;
slouken@1936
   132
        attr[i++] = NSOpenGLPFANoRecovery;
slouken@1936
   133
    }
slouken@1936
   134
slouken@1936
   135
    if (_this->gl_config.accelerated > 0) {
slouken@1936
   136
        attr[i++] = NSOpenGLPFAAccelerated;
slouken@1936
   137
    }
slouken@1936
   138
slouken@1936
   139
    attr[i++] = NSOpenGLPFAScreenMask;
slouken@1936
   140
    attr[i++] = CGDisplayIDToOpenGLDisplayMask(displaydata->display);
slouken@1936
   141
    attr[i] = 0;
slouken@1936
   142
slouken@1936
   143
    fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attr];
slouken@1936
   144
    if (fmt == nil) {
slouken@1936
   145
        SDL_SetError ("Failed creating OpenGL pixel format");
slouken@1936
   146
        [pool release];
slouken@1936
   147
        return NULL;
slouken@1936
   148
    }
slouken@1936
   149
slouken@2178
   150
    context = [[NSOpenGLContext alloc] initWithFormat:fmt shareContext:nil];
slouken@1936
   151
slouken@1936
   152
    [fmt release];
slouken@1936
   153
slouken@2178
   154
    if (context == nil) {
slouken@1936
   155
        SDL_SetError ("Failed creating OpenGL context");
slouken@1936
   156
        [pool release];
slouken@1936
   157
        return NULL;
slouken@1936
   158
    }
slouken@1936
   159
slouken@1936
   160
    /*
slouken@1936
   161
     * Wisdom from Apple engineer in reference to UT2003's OpenGL performance:
slouken@1936
   162
     *  "You are blowing a couple of the internal OpenGL function caches. This
slouken@1936
   163
     *  appears to be happening in the VAO case.  You can tell OpenGL to up
slouken@1936
   164
     *  the cache size by issuing the following calls right after you create
slouken@1936
   165
     *  the OpenGL context.  The default cache size is 16."    --ryan.
slouken@1936
   166
     */
slouken@1936
   167
slouken@1936
   168
    #ifndef GLI_ARRAY_FUNC_CACHE_MAX
slouken@1936
   169
    #define GLI_ARRAY_FUNC_CACHE_MAX 284
slouken@1936
   170
    #endif
slouken@1936
   171
slouken@1936
   172
    #ifndef GLI_SUBMIT_FUNC_CACHE_MAX
slouken@1936
   173
    #define GLI_SUBMIT_FUNC_CACHE_MAX 280
slouken@1936
   174
    #endif
slouken@1936
   175
slouken@1936
   176
    {
slouken@1936
   177
        long cache_max = 64;
slouken@2178
   178
        CGLContextObj ctx = [context CGLContextObj];
slouken@1936
   179
        CGLSetParameter (ctx, GLI_SUBMIT_FUNC_CACHE_MAX, &cache_max);
slouken@1936
   180
        CGLSetParameter (ctx, GLI_ARRAY_FUNC_CACHE_MAX, &cache_max);
slouken@1936
   181
    }
slouken@1936
   182
slouken@1936
   183
    /* End Wisdom from Apple Engineer section. --ryan. */
slouken@1936
   184
slouken@1936
   185
    [pool release];
slouken@2178
   186
slouken@2178
   187
    if ( Cocoa_GL_MakeCurrent(_this, window, context) < 0 ) {
slouken@2178
   188
        Cocoa_GL_DeleteContext(_this, context);
slouken@2178
   189
        return NULL;
slouken@2178
   190
    }
slouken@2178
   191
slouken@2178
   192
    return context;
slouken@1936
   193
}
slouken@1936
   194
slouken@1936
   195
int
slouken@1936
   196
Cocoa_GL_MakeCurrent(_THIS, SDL_Window * window, SDL_GLContext context)
slouken@1936
   197
{
slouken@1936
   198
    NSAutoreleasePool *pool;
slouken@1936
   199
slouken@1936
   200
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   201
slouken@1936
   202
    if (context) {
slouken@1936
   203
        SDL_WindowData *windowdata = (SDL_WindowData *)window->driverdata;
slouken@1936
   204
        NSOpenGLContext *nscontext = (NSOpenGLContext *)context;
slouken@1936
   205
slouken@1973
   206
        if (window->flags & SDL_WINDOW_FULLSCREEN) {
slouken@1973
   207
            [nscontext setFullScreen];
slouken@1973
   208
        } else {
slouken@1973
   209
            [nscontext setView:[windowdata->window contentView]];
slouken@1973
   210
            [nscontext update];
slouken@1973
   211
        }
slouken@1936
   212
        [nscontext makeCurrentContext];
slouken@1936
   213
    } else {
slouken@1936
   214
        [NSOpenGLContext clearCurrentContext];
slouken@1936
   215
    }
slouken@1936
   216
slouken@1936
   217
    [pool release];
slouken@1936
   218
    return 0;
slouken@1936
   219
}
slouken@1936
   220
slouken@1936
   221
int
slouken@1936
   222
Cocoa_GL_SetSwapInterval(_THIS, int interval)
slouken@1936
   223
{
slouken@1936
   224
    NSAutoreleasePool *pool;
slouken@1936
   225
    NSOpenGLContext *nscontext;
slouken@2703
   226
    GLint value;
slouken@1936
   227
    int status;
slouken@1936
   228
slouken@1936
   229
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   230
slouken@1936
   231
    nscontext = [NSOpenGLContext currentContext];
slouken@1936
   232
    if (nscontext != nil) {
slouken@1936
   233
        value = interval;
slouken@1936
   234
        [nscontext setValues:&value forParameter:NSOpenGLCPSwapInterval];
slouken@1936
   235
        status = 0;
slouken@1936
   236
    } else {
slouken@1936
   237
        SDL_SetError("No current OpenGL context");
slouken@1936
   238
        status = -1;
slouken@1936
   239
    }
slouken@1936
   240
slouken@1936
   241
    [pool release];
slouken@1936
   242
    return status;
slouken@1936
   243
}
slouken@1936
   244
slouken@1936
   245
int
slouken@1936
   246
Cocoa_GL_GetSwapInterval(_THIS)
slouken@1936
   247
{
slouken@1936
   248
    NSAutoreleasePool *pool;
slouken@1936
   249
    NSOpenGLContext *nscontext;
slouken@2703
   250
    GLint value;
slouken@1936
   251
    int status;
slouken@1936
   252
slouken@1936
   253
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   254
slouken@1936
   255
    nscontext = [NSOpenGLContext currentContext];
slouken@1936
   256
    if (nscontext != nil) {
slouken@1936
   257
        [nscontext getValues:&value forParameter:NSOpenGLCPSwapInterval];
slouken@1936
   258
        status = (int)value;
slouken@1936
   259
    } else {
slouken@1936
   260
        SDL_SetError("No current OpenGL context");
slouken@1936
   261
        status = -1;
slouken@1936
   262
    }
slouken@1936
   263
slouken@1936
   264
    [pool release];
slouken@1936
   265
    return status;
slouken@1936
   266
}
slouken@1936
   267
slouken@1936
   268
void
slouken@1936
   269
Cocoa_GL_SwapWindow(_THIS, SDL_Window * window)
slouken@1936
   270
{
slouken@1936
   271
    NSAutoreleasePool *pool;
slouken@1936
   272
    NSOpenGLContext *nscontext;
slouken@1936
   273
slouken@1936
   274
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   275
slouken@1936
   276
    /* FIXME: Do we need to get the context for the window? */
slouken@1936
   277
    nscontext = [NSOpenGLContext currentContext];
slouken@1936
   278
    if (nscontext != nil) {
slouken@1936
   279
        [nscontext flushBuffer];
slouken@1936
   280
    }
slouken@1936
   281
slouken@1936
   282
    [pool release];
slouken@1936
   283
}
slouken@1936
   284
slouken@1936
   285
void
slouken@1936
   286
Cocoa_GL_DeleteContext(_THIS, SDL_GLContext context)
slouken@1936
   287
{
slouken@1936
   288
    NSAutoreleasePool *pool;
slouken@1936
   289
    NSOpenGLContext *nscontext = (NSOpenGLContext *)context;
slouken@1936
   290
slouken@1936
   291
    pool = [[NSAutoreleasePool alloc] init];
slouken@1936
   292
slouken@1936
   293
    [nscontext clearDrawable];
slouken@1936
   294
    [nscontext release];
slouken@1936
   295
slouken@1936
   296
    [pool release];
slouken@1936
   297
}
slouken@1936
   298
slouken@1952
   299
#endif /* SDL_VIDEO_OPENGL_CGL */
slouken@1936
   300
slouken@1936
   301
/* vi: set ts=4 sw=4 expandtab: */