src/video/cocoa/SDL_cocoaopengl.m
author Edward Rudd <urkle@outoforder.cc>
Fri, 20 Sep 2013 13:43:00 -0400
changeset 7746 6a05d7352575
parent 7743 360acf8c1526
child 7894 bb624b1348da
permissions -rw-r--r--
add in High DPI support (aka Retina)

- based on Jørgen's patch with a few bug fixes
slouken@1936
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@1936
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@1936
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@1936
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@1936
    20
*/
slouken@1936
    21
#include "SDL_config.h"
slouken@1936
    22
slouken@1936
    23
/* NSOpenGL implementation of SDL OpenGL support */
slouken@1936
    24
slouken@1952
    25
#if SDL_VIDEO_OPENGL_CGL
slouken@6044
    26
#include "SDL_cocoavideo.h"
jorgen@7594
    27
#include "SDL_cocoaopengl.h"
slouken@6044
    28
slouken@1936
    29
#include <OpenGL/CGLTypes.h>
slouken@2738
    30
#include <OpenGL/OpenGL.h>
slouken@3570
    31
#include <OpenGL/CGLRenderers.h>
slouken@1936
    32
slouken@1936
    33
#include "SDL_loadso.h"
slouken@1936
    34
#include "SDL_opengl.h"
slouken@1936
    35
icculus@6567
    36
#define DEFAULT_OPENGL  "/System/Library/Frameworks/OpenGL.framework/Libraries/libGL.dylib"
slouken@1936
    37
urkle@7746
    38
#if MAC_OS_X_VERSION_MAX_ALLOWED < 1070
urkle@7746
    39
/* New methods for converting to and from backing store pixels, taken from
urkle@7746
    40
 * AppKite/NSView.h in 10.8 SDK. */
urkle@7746
    41
@interface NSView (Backing)
urkle@7746
    42
- (NSPoint)convertPointToBacking:(NSPoint)aPoint;
urkle@7746
    43
- (NSPoint)convertPointFromBacking:(NSPoint)aPoint;
urkle@7746
    44
- (NSSize)convertSizeToBacking:(NSSize)aSize;
urkle@7746
    45
- (NSSize)convertSizeFromBacking:(NSSize)aSize;
urkle@7746
    46
- (NSRect)convertRectToBacking:(NSRect)aRect;
urkle@7746
    47
- (NSRect)convertRectFromBacking:(NSRect)aRect;
urkle@7746
    48
@end
urkle@7746
    49
#endif
icculus@6567
    50
slouken@6952
    51
#ifndef kCGLPFAOpenGLProfile
icculus@6567
    52
#define kCGLPFAOpenGLProfile 99
slouken@6952
    53
#endif
slouken@6952
    54
#ifndef kCGLOGLPVersion_Legacy
icculus@6567
    55
#define kCGLOGLPVersion_Legacy 0x1000
slouken@6952
    56
#endif
slouken@6952
    57
#ifndef kCGLOGLPVersion_3_2_Core
icculus@6567
    58
#define kCGLOGLPVersion_3_2_Core 0x3200
icculus@6567
    59
#endif
icculus@6567
    60
jorgen@7594
    61
@implementation SDLOpenGLContext : NSOpenGLContext
jorgen@7594
    62
jorgen@7594
    63
- (id)initWithFormat:(NSOpenGLPixelFormat *)format
jorgen@7594
    64
        shareContext:(NSOpenGLContext *)share
jorgen@7594
    65
{
jorgen@7595
    66
    self = [super initWithFormat:format shareContext:share];
jorgen@7595
    67
    if (self) {
jorgen@7595
    68
        SDL_AtomicSet(&self->dirty, 0);
jorgen@7595
    69
        self->window = NULL;
jorgen@7595
    70
    }
jorgen@7595
    71
    return self;
jorgen@7594
    72
}
jorgen@7594
    73
jorgen@7594
    74
- (void)scheduleUpdate
jorgen@7594
    75
{
jorgen@7594
    76
    SDL_AtomicAdd(&self->dirty, 1);
jorgen@7594
    77
}
jorgen@7594
    78
jorgen@7594
    79
/* This should only be called on the thread on which a user is using the context. */
jorgen@7594
    80
- (void)updateIfNeeded
jorgen@7594
    81
{
jorgen@7594
    82
    int value = SDL_AtomicSet(&self->dirty, 0);
jorgen@7594
    83
    if (value > 0) {
jorgen@7594
    84
        /* We call the real underlying update here, since -[SDLOpenGLContext update] just calls us. */
jorgen@7594
    85
        [super update];
jorgen@7594
    86
    }
jorgen@7594
    87
}
jorgen@7594
    88
jorgen@7594
    89
/* This should only be called on the thread on which a user is using the context. */
jorgen@7594
    90
- (void)update
jorgen@7594
    91
{
jorgen@7594
    92
    /* This ensures that regular 'update' calls clear the atomic dirty flag. */
jorgen@7594
    93
    [self scheduleUpdate];
jorgen@7594
    94
    [self updateIfNeeded];
jorgen@7594
    95
}
jorgen@7594
    96
jorgen@7595
    97
/* Updates the drawable for the contexts and manages related state. */
jorgen@7595
    98
- (void)setWindow:(SDL_Window *)newWindow
jorgen@7595
    99
{
jorgen@7595
   100
    if (self->window) {
jorgen@7595
   101
        SDL_WindowData *oldwindowdata = (SDL_WindowData *)self->window->driverdata;
jorgen@7595
   102
jorgen@7595
   103
        /* Make sure to remove us from the old window's context list, or we'll get scheduled updates from it too. */
jorgen@7595
   104
        NSMutableArray *contexts = oldwindowdata->nscontexts;
jorgen@7595
   105
        @synchronized (contexts) {
jorgen@7595
   106
            [contexts removeObject:self];
jorgen@7595
   107
        }
jorgen@7595
   108
    }
jorgen@7595
   109
jorgen@7595
   110
    self->window = newWindow;
jorgen@7595
   111
jorgen@7595
   112
    if (newWindow) {
jorgen@7595
   113
        SDL_WindowData *windowdata = (SDL_WindowData *)newWindow->driverdata;
jorgen@7595
   114
jorgen@7595
   115
        /* Now sign up for scheduled updates for the new window. */
jorgen@7595
   116
        NSMutableArray *contexts = windowdata->nscontexts;
jorgen@7595
   117
        @synchronized (contexts) {
jorgen@7595
   118
            [contexts addObject:self];
jorgen@7595
   119
        }
jorgen@7595
   120
jorgen@7595
   121
        if ([self view] != [windowdata->nswindow contentView]) {
jorgen@7595
   122
            [self setView:[windowdata->nswindow contentView]];
jorgen@7595
   123
            [self scheduleUpdate];
jorgen@7595
   124
        }
jorgen@7595
   125
    } else {
jorgen@7595
   126
        [self clearDrawable];
jorgen@7595
   127
        [self scheduleUpdate];
jorgen@7595
   128
    }
jorgen@7595
   129
}
jorgen@7595
   130
jorgen@7594
   131
@end
jorgen@7594
   132
slouken@1936
   133
slouken@1936
   134
int
slouken@1936
   135
Cocoa_GL_LoadLibrary(_THIS, const char *path)
slouken@1936
   136
{
slouken@3057
   137
    /* Load the OpenGL library */
slouken@1936
   138
    if (path == NULL) {
slouken@1952
   139
        path = SDL_getenv("SDL_OPENGL_LIBRARY");
slouken@1952
   140
    }
slouken@1952
   141
    if (path == NULL) {
slouken@1952
   142
        path = DEFAULT_OPENGL;
slouken@1936
   143
    }
slouken@1936
   144
    _this->gl_config.dll_handle = SDL_LoadObject(path);
slouken@1936
   145
    if (!_this->gl_config.dll_handle) {
slouken@1936
   146
        return -1;
slouken@1936
   147
    }
slouken@1936
   148
    SDL_strlcpy(_this->gl_config.driver_path, path,
slouken@1936
   149
                SDL_arraysize(_this->gl_config.driver_path));
slouken@1936
   150
    return 0;
slouken@1936
   151
}
slouken@1936
   152
slouken@1936
   153
void *
slouken@1936
   154
Cocoa_GL_GetProcAddress(_THIS, const char *proc)
slouken@1936
   155
{
slouken@1936
   156
    return SDL_LoadFunction(_this->gl_config.dll_handle, proc);
slouken@1936
   157
}
slouken@1936
   158
slouken@3057
   159
void
slouken@1936
   160
Cocoa_GL_UnloadLibrary(_THIS)
slouken@1936
   161
{
slouken@3057
   162
    SDL_UnloadObject(_this->gl_config.dll_handle);
slouken@3057
   163
    _this->gl_config.dll_handle = NULL;
slouken@1936
   164
}
slouken@1936
   165
slouken@1936
   166
SDL_GLContext
slouken@1936
   167
Cocoa_GL_CreateContext(_THIS, SDL_Window * window)
slouken@1936
   168
{
icculus@6567
   169
    const int wantver = (_this->gl_config.major_version << 8) |
icculus@6567
   170
                        (_this->gl_config.minor_version);
icculus@6567
   171
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@6848
   172
    NSAutoreleasePool *pool;
slouken@5246
   173
    SDL_VideoDisplay *display = SDL_GetDisplayForWindow(window);
slouken@1936
   174
    SDL_DisplayData *displaydata = (SDL_DisplayData *)display->driverdata;
slouken@1936
   175
    NSOpenGLPixelFormatAttribute attr[32];
slouken@1936
   176
    NSOpenGLPixelFormat *fmt;
jorgen@7594
   177
    SDLOpenGLContext *context;
flibitijibibo@7152
   178
    NSOpenGLContext *share_context = nil;
slouken@1936
   179
    int i = 0;
slouken@1936
   180
icculus@6567
   181
    if (_this->gl_config.profile_mask == SDL_GL_CONTEXT_PROFILE_ES) {
icculus@6567
   182
        SDL_SetError ("OpenGL ES not supported on this platform");
icculus@6567
   183
        return NULL;
icculus@6567
   184
    }
icculus@6567
   185
icculus@6567
   186
    /* Sadly, we'll have to update this as life progresses, since we need to
icculus@6567
   187
       set an enum for context profiles, not a context version number */
icculus@6567
   188
    if (wantver > 0x0302) {
icculus@6567
   189
        SDL_SetError ("OpenGL > 3.2 is not supported on this platform");
icculus@6567
   190
        return NULL;
icculus@6567
   191
    }
icculus@6567
   192
slouken@6848
   193
    pool = [[NSAutoreleasePool alloc] init];
slouken@6848
   194
slouken@6848
   195
    /* specify a profile if we're on Lion (10.7) or later. */
slouken@6848
   196
    if (data->osversion >= 0x1070) {
slouken@6848
   197
        NSOpenGLPixelFormatAttribute profile = kCGLOGLPVersion_Legacy;
slouken@6848
   198
        if (_this->gl_config.profile_mask == SDL_GL_CONTEXT_PROFILE_CORE) {
slouken@6848
   199
            if (wantver == 0x0302) {
slouken@6848
   200
                profile = kCGLOGLPVersion_3_2_Core;
alexey@6832
   201
            }
alexey@6832
   202
        }
slouken@6848
   203
        attr[i++] = kCGLPFAOpenGLProfile;
slouken@6848
   204
        attr[i++] = profile;
slouken@6848
   205
    }
slouken@1936
   206
slouken@6848
   207
    attr[i++] = NSOpenGLPFAColorSize;
slouken@6848
   208
    attr[i++] = SDL_BYTESPERPIXEL(display->current_mode.format)*8;
slouken@6848
   209
slouken@6848
   210
    attr[i++] = NSOpenGLPFADepthSize;
slouken@6848
   211
    attr[i++] = _this->gl_config.depth_size;
slouken@6848
   212
slouken@6848
   213
    if (_this->gl_config.double_buffer) {
slouken@6848
   214
        attr[i++] = NSOpenGLPFADoubleBuffer;
slouken@6848
   215
    }
slouken@6848
   216
slouken@6848
   217
    if (_this->gl_config.stereo) {
slouken@6848
   218
        attr[i++] = NSOpenGLPFAStereo;
slouken@6848
   219
    }
slouken@6848
   220
slouken@6848
   221
    if (_this->gl_config.stencil_size) {
slouken@6848
   222
        attr[i++] = NSOpenGLPFAStencilSize;
slouken@6848
   223
        attr[i++] = _this->gl_config.stencil_size;
slouken@6848
   224
    }
slouken@6848
   225
slouken@6848
   226
    if ((_this->gl_config.accum_red_size +
slouken@6848
   227
         _this->gl_config.accum_green_size +
slouken@6848
   228
         _this->gl_config.accum_blue_size +
slouken@6848
   229
         _this->gl_config.accum_alpha_size) > 0) {
slouken@6848
   230
        attr[i++] = NSOpenGLPFAAccumSize;
slouken@6848
   231
        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@6848
   232
    }
slouken@6848
   233
slouken@6848
   234
    if (_this->gl_config.multisamplebuffers) {
slouken@6848
   235
        attr[i++] = NSOpenGLPFASampleBuffers;
slouken@6848
   236
        attr[i++] = _this->gl_config.multisamplebuffers;
slouken@6848
   237
    }
slouken@6848
   238
slouken@6848
   239
    if (_this->gl_config.multisamplesamples) {
slouken@6848
   240
        attr[i++] = NSOpenGLPFASamples;
slouken@6848
   241
        attr[i++] = _this->gl_config.multisamplesamples;
slouken@6848
   242
        attr[i++] = NSOpenGLPFANoRecovery;
slouken@6848
   243
    }
slouken@6848
   244
slouken@6848
   245
    if (_this->gl_config.accelerated >= 0) {
slouken@6848
   246
        if (_this->gl_config.accelerated) {
slouken@6848
   247
            attr[i++] = NSOpenGLPFAAccelerated;
slouken@6848
   248
        } else {
slouken@6848
   249
            attr[i++] = NSOpenGLPFARendererID;
slouken@6848
   250
            attr[i++] = kCGLRendererGenericFloatID;
alexey@6832
   251
        }
slouken@6848
   252
    }
slouken@6848
   253
slouken@6848
   254
    attr[i++] = NSOpenGLPFAScreenMask;
slouken@6848
   255
    attr[i++] = CGDisplayIDToOpenGLDisplayMask(displaydata->display);
slouken@6848
   256
    attr[i] = 0;
slouken@6848
   257
slouken@6848
   258
    fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attr];
slouken@6848
   259
    if (fmt == nil) {
slouken@6848
   260
        SDL_SetError ("Failed creating OpenGL pixel format");
slouken@6848
   261
        [pool release];
slouken@6848
   262
        return NULL;
slouken@6848
   263
    }
slouken@6848
   264
flibitijibibo@7152
   265
    if (_this->gl_config.share_with_current_context) {
slouken@7412
   266
        share_context = (NSOpenGLContext*)SDL_GL_GetCurrentContext();
flibitijibibo@7152
   267
    }
flibitijibibo@7152
   268
jorgen@7594
   269
    context = [[SDLOpenGLContext alloc] initWithFormat:fmt shareContext:share_context];
slouken@6848
   270
slouken@6848
   271
    [fmt release];
slouken@6848
   272
slouken@6848
   273
    if (context == nil) {
slouken@6848
   274
        SDL_SetError ("Failed creating OpenGL context");
slouken@6848
   275
        [pool release];
slouken@6848
   276
        return NULL;
slouken@6848
   277
    }
slouken@6848
   278
slouken@6848
   279
    [pool release];
slouken@1936
   280
slouken@2178
   281
    if ( Cocoa_GL_MakeCurrent(_this, window, context) < 0 ) {
slouken@2178
   282
        Cocoa_GL_DeleteContext(_this, context);
slouken@2178
   283
        return NULL;
slouken@2178
   284
    }
slouken@2178
   285
slouken@2178
   286
    return context;
slouken@1936
   287
}
slouken@1936
   288
slouken@1936
   289
int
slouken@1936
   290
Cocoa_GL_MakeCurrent(_THIS, SDL_Window * window, SDL_GLContext context)
slouken@1936
   291
{
slouken@6848
   292
    NSAutoreleasePool *pool;
slouken@1936
   293
slouken@6848
   294
    pool = [[NSAutoreleasePool alloc] init];
slouken@6848
   295
slouken@6848
   296
    if (context) {
jorgen@7594
   297
        SDLOpenGLContext *nscontext = (SDLOpenGLContext *)context;
jorgen@7595
   298
        [nscontext setWindow:window];
jorgen@7594
   299
        [nscontext updateIfNeeded];
slouken@6848
   300
        [nscontext makeCurrentContext];
slouken@6848
   301
    } else {
slouken@6848
   302
        [NSOpenGLContext clearCurrentContext];
slouken@1936
   303
    }
slouken@1936
   304
slouken@6848
   305
    [pool release];
slouken@1936
   306
    return 0;
slouken@1936
   307
}
slouken@1936
   308
urkle@7746
   309
void
urkle@7746
   310
Cocoa_GL_GetDrawableSize(_THIS, SDL_Window * window, int * w, int * h)
urkle@7746
   311
{
urkle@7746
   312
    SDL_WindowData *windata = (SDL_WindowData *) window->driverdata;
urkle@7746
   313
    NSView *contentView = [windata->nswindow contentView];
urkle@7746
   314
    NSRect viewport = [contentView bounds];
urkle@7746
   315
urkle@7746
   316
    /* This gives us the correct viewport for a Retina-enabled view, only
urkle@7746
   317
     * supported on 10.7+. */
urkle@7746
   318
    if ([contentView respondsToSelector:@selector(convertRectToBacking:)]) {
urkle@7746
   319
        viewport = [contentView convertRectToBacking:viewport];
urkle@7746
   320
    }
urkle@7746
   321
urkle@7746
   322
    if (w) {
urkle@7746
   323
        *w = viewport.size.width;
urkle@7746
   324
    }
urkle@7746
   325
urkle@7746
   326
    if (h) {
urkle@7746
   327
        *h = viewport.size.height;
urkle@7746
   328
    }
urkle@7746
   329
}
urkle@7746
   330
slouken@1936
   331
int
slouken@1936
   332
Cocoa_GL_SetSwapInterval(_THIS, int interval)
slouken@1936
   333
{
slouken@6848
   334
    NSAutoreleasePool *pool;
slouken@1936
   335
    NSOpenGLContext *nscontext;
slouken@2703
   336
    GLint value;
slouken@1936
   337
    int status;
slouken@1936
   338
icculus@7743
   339
    if (interval < 0) {  /* no extension for this on Mac OS X at the moment. */
icculus@7743
   340
        return SDL_SetError("Late swap tearing currently unsupported");
icculus@7743
   341
    }
icculus@7743
   342
slouken@6848
   343
    pool = [[NSAutoreleasePool alloc] init];
slouken@6848
   344
jorgen@7594
   345
    nscontext = (NSOpenGLContext*)SDL_GL_GetCurrentContext();
slouken@6848
   346
    if (nscontext != nil) {
slouken@6848
   347
        value = interval;
slouken@6848
   348
        [nscontext setValues:&value forParameter:NSOpenGLCPSwapInterval];
slouken@6848
   349
        status = 0;
slouken@6848
   350
    } else {
icculus@7037
   351
        status = SDL_SetError("No current OpenGL context");
slouken@1936
   352
    }
slouken@1936
   353
slouken@6848
   354
    [pool release];
slouken@1936
   355
    return status;
slouken@1936
   356
}
slouken@1936
   357
slouken@1936
   358
int
slouken@1936
   359
Cocoa_GL_GetSwapInterval(_THIS)
slouken@1936
   360
{
slouken@6848
   361
    NSAutoreleasePool *pool;
slouken@1936
   362
    NSOpenGLContext *nscontext;
slouken@2703
   363
    GLint value;
icculus@6382
   364
    int status = 0;
slouken@1936
   365
slouken@6848
   366
    pool = [[NSAutoreleasePool alloc] init];
slouken@6848
   367
jorgen@7594
   368
    nscontext = (NSOpenGLContext*)SDL_GL_GetCurrentContext();
slouken@6848
   369
    if (nscontext != nil) {
slouken@6848
   370
        [nscontext getValues:&value forParameter:NSOpenGLCPSwapInterval];
slouken@6848
   371
        status = (int)value;
slouken@1936
   372
    }
slouken@1936
   373
slouken@6848
   374
    [pool release];
slouken@1936
   375
    return status;
slouken@1936
   376
}
slouken@1936
   377
slouken@1936
   378
void
slouken@1936
   379
Cocoa_GL_SwapWindow(_THIS, SDL_Window * window)
slouken@1936
   380
{
slouken@6848
   381
    NSAutoreleasePool *pool;
slouken@1936
   382
slouken@6848
   383
    pool = [[NSAutoreleasePool alloc] init];
slouken@6848
   384
slouken@7738
   385
    SDLOpenGLContext* nscontext = (SDLOpenGLContext*)SDL_GL_GetCurrentContext();
slouken@7408
   386
    [nscontext flushBuffer];
jorgen@7594
   387
    [nscontext updateIfNeeded];
slouken@6848
   388
slouken@6848
   389
    [pool release];
slouken@1936
   390
}
slouken@1936
   391
slouken@1936
   392
void
slouken@1936
   393
Cocoa_GL_DeleteContext(_THIS, SDL_GLContext context)
slouken@1936
   394
{
slouken@6848
   395
    NSAutoreleasePool *pool;
jorgen@7595
   396
    SDLOpenGLContext *nscontext = (SDLOpenGLContext *)context;
slouken@1936
   397
slouken@6848
   398
    pool = [[NSAutoreleasePool alloc] init];
slouken@6848
   399
jorgen@7595
   400
    [nscontext setWindow:NULL];
slouken@6848
   401
    [nscontext release];
slouken@6848
   402
slouken@6848
   403
    [pool release];
slouken@1936
   404
}
slouken@1936
   405
slouken@1952
   406
#endif /* SDL_VIDEO_OPENGL_CGL */
slouken@1936
   407
slouken@1936
   408
/* vi: set ts=4 sw=4 expandtab: */