SDL  2.0
SDL_cocoavideo.m
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../../SDL_internal.h"
22 
23 #if SDL_VIDEO_DRIVER_COCOA
24 
25 #include "SDL.h"
26 #include "SDL_endian.h"
27 #include "SDL_cocoavideo.h"
28 #include "SDL_cocoashape.h"
29 #include "SDL_assert.h"
30 
31 /* Initialization/Query functions */
32 static int Cocoa_VideoInit(_THIS);
33 static void Cocoa_VideoQuit(_THIS);
34 
35 /* Cocoa driver bootstrap functions */
36 
37 static int
38 Cocoa_Available(void)
39 {
40  return (1);
41 }
42 
43 static void
44 Cocoa_DeleteDevice(SDL_VideoDevice * device)
45 {
46  SDL_free(device->driverdata);
47  SDL_free(device);
48 }
49 
50 static SDL_VideoDevice *
51 Cocoa_CreateDevice(int devindex)
52 {
53  SDL_VideoDevice *device;
55 
57 
58  /* Initialize all variables that we clean on shutdown */
59  device = (SDL_VideoDevice *) SDL_calloc(1, sizeof(SDL_VideoDevice));
60  if (device) {
61  data = (struct SDL_VideoData *) SDL_calloc(1, sizeof(SDL_VideoData));
62  } else {
63  data = NULL;
64  }
65  if (!data) {
67  SDL_free(device);
68  return NULL;
69  }
70  device->driverdata = data;
71 
72  /* Set the function pointers */
73  device->VideoInit = Cocoa_VideoInit;
74  device->VideoQuit = Cocoa_VideoQuit;
80  device->PumpEvents = Cocoa_PumpEvents;
82 
92  device->ShowWindow = Cocoa_ShowWindow;
93  device->HideWindow = Cocoa_HideWindow;
107 
111 
112 #if SDL_VIDEO_OPENGL_CGL
113  device->GL_LoadLibrary = Cocoa_GL_LoadLibrary;
114  device->GL_GetProcAddress = Cocoa_GL_GetProcAddress;
115  device->GL_UnloadLibrary = Cocoa_GL_UnloadLibrary;
116  device->GL_CreateContext = Cocoa_GL_CreateContext;
117  device->GL_MakeCurrent = Cocoa_GL_MakeCurrent;
118  device->GL_GetDrawableSize = Cocoa_GL_GetDrawableSize;
119  device->GL_SetSwapInterval = Cocoa_GL_SetSwapInterval;
120  device->GL_GetSwapInterval = Cocoa_GL_GetSwapInterval;
121  device->GL_SwapWindow = Cocoa_GL_SwapWindow;
122  device->GL_DeleteContext = Cocoa_GL_DeleteContext;
123 #endif
124 
128 
132 
133  device->free = Cocoa_DeleteDevice;
134 
135  return device;
136 }
137 
138 VideoBootStrap COCOA_bootstrap = {
139  "cocoa", "SDL Cocoa video driver",
140  Cocoa_Available, Cocoa_CreateDevice
141 };
142 
143 
144 int
145 Cocoa_VideoInit(_THIS)
146 {
148 
152 
153  data->allow_spaces = ((floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6) && SDL_GetHintBoolean(SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES, SDL_TRUE));
154 
155  /* The IOPM assertion API can disable the screensaver as of 10.7. */
156  data->screensaver_use_iopm = floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6;
157 
158  return 0;
159 }
160 
161 void
162 Cocoa_VideoQuit(_THIS)
163 {
167 }
168 
169 /* This function assumes that it's called from within an autorelease pool */
170 NSImage *
172 {
173  SDL_Surface *converted;
174  NSBitmapImageRep *imgrep;
175  Uint8 *pixels;
176  int i;
177  NSImage *img;
178 
179  converted = SDL_ConvertSurfaceFormat(surface, SDL_PIXELFORMAT_RGBA32, 0);
180  if (!converted) {
181  return nil;
182  }
183 
184  imgrep = [[[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
185  pixelsWide: converted->w
186  pixelsHigh: converted->h
187  bitsPerSample: 8
188  samplesPerPixel: 4
189  hasAlpha: YES
190  isPlanar: NO
191  colorSpaceName: NSDeviceRGBColorSpace
192  bytesPerRow: converted->pitch
193  bitsPerPixel: converted->format->BitsPerPixel] autorelease];
194  if (imgrep == nil) {
195  SDL_FreeSurface(converted);
196  return nil;
197  }
198 
199  /* Copy the pixels */
200  pixels = [imgrep bitmapData];
201  SDL_memcpy(pixels, converted->pixels, converted->h * converted->pitch);
202  SDL_FreeSurface(converted);
203 
204  /* Premultiply the alpha channel */
205  for (i = (surface->h * surface->w); i--; ) {
206  Uint8 alpha = pixels[3];
207  pixels[0] = (Uint8)(((Uint16)pixels[0] * alpha) / 255);
208  pixels[1] = (Uint8)(((Uint16)pixels[1] * alpha) / 255);
209  pixels[2] = (Uint8)(((Uint16)pixels[2] * alpha) / 255);
210  pixels += 4;
211  }
212 
213  img = [[[NSImage alloc] initWithSize: NSMakeSize(surface->w, surface->h)] autorelease];
214  if (img != nil) {
215  [img addRepresentation: imgrep];
216  }
217  return img;
218 }
219 
220 /*
221  * Mac OS X log support.
222  *
223  * This doesn't really have aything to do with the interfaces of the SDL video
224  * subsystem, but we need to stuff this into an Objective-C source code file.
225  */
226 
227 void SDL_NSLog(const char *text)
228 {
229  NSLog(@"%s", text);
230 }
231 
232 #endif /* SDL_VIDEO_DRIVER_COCOA */
233 
234 /* vim: set ts=4 sw=4 expandtab: */
void Cocoa_GetDisplayModes(_THIS, SDL_VideoDisplay *display)
int Cocoa_CreateWindowFrom(_THIS, SDL_Window *window, const void *data)
void Cocoa_SetTextInputRect(_THIS, SDL_Rect *rect)
void Cocoa_RegisterApp(void)
int(* GetDisplayDPI)(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi)
Definition: SDL_sysvideo.h:179
void Cocoa_InitMouse(_THIS)
#define SDL_ConvertSurfaceFormat
void(* RestoreWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:220
char * Cocoa_GetClipboardText(_THIS)
void Cocoa_MinimizeWindow(_THIS, SDL_Window *window)
int(* SetWindowHitTest)(SDL_Window *window, SDL_bool enabled)
Definition: SDL_sysvideo.h:287
void Cocoa_SetWindowIcon(_THIS, SDL_Window *window, SDL_Surface *icon)
void Cocoa_SetWindowMaximumSize(_THIS, SDL_Window *window)
int(* CreateWindowFrom)(_THIS, SDL_Window *window, const void *data)
Definition: SDL_sysvideo.h:204
void Cocoa_SetWindowResizable(_THIS, SDL_Window *window, SDL_bool resizable)
void Cocoa_SetWindowBordered(_THIS, SDL_Window *window, SDL_bool bordered)
void(* free)(_THIS)
Definition: SDL_sysvideo.h:358
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
int(* GL_SetSwapInterval)(_THIS, int interval)
Definition: SDL_sysvideo.h:253
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1967
void(* ShowWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:215
void(* StartTextInput)(_THIS)
Definition: SDL_sysvideo.h:268
void(* SetWindowSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:208
GLint GLint GLsizei GLsizei GLsizei GLint GLenum GLenum const GLvoid * pixels
Definition: SDL_opengl.h:1565
void Cocoa_SuspendScreenSaver(_THIS)
void Cocoa_SetWindowTitle(_THIS, SDL_Window *window)
void(* GL_SwapWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:255
void Cocoa_SetWindowPosition(_THIS, SDL_Window *window)
void Cocoa_StartTextInput(_THIS)
int(* GL_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:247
GLfloat GLfloat GLfloat alpha
int Cocoa_GetDisplayUsableBounds(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
int(* SetDisplayMode)(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode)
Definition: SDL_sysvideo.h:197
#define SDL_GetHintBoolean
void(* SetWindowBordered)(_THIS, SDL_Window *window, SDL_bool bordered)
Definition: SDL_sysvideo.h:221
void(* GL_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h)
Definition: SDL_sysvideo.h:252
void Cocoa_QuitKeyboard(_THIS)
static SDL_VideoDevice * _this
Definition: SDL_video.c:118
void Cocoa_RestoreWindow(_THIS, SDL_Window *window)
int Cocoa_SetClipboardText(_THIS, const char *text)
SDL_bool Cocoa_HasClipboardText(_THIS)
void(* HideWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:216
int Cocoa_SetWindowShape(SDL_WindowShaper *shaper, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
void(* RaiseWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:217
int(* SetWindowShape)(SDL_WindowShaper *shaper, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
Definition: SDL_sysvideo.h:59
void Cocoa_ShowWindow(_THIS, SDL_Window *window)
void(* SetTextInputRect)(_THIS, SDL_Rect *rect)
Definition: SDL_sysvideo.h:270
#define SDL_memcpy
void * SDL_calloc(size_t nmemb, size_t size)
GLint GLvoid * img
Definition: SDL_opengl.h:1973
SDL_bool(* GetWindowWMInfo)(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
Definition: SDL_sysvideo.h:240
int Cocoa_SetDisplayMode(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode)
NSImage * Cocoa_CreateImage(SDL_Surface *surface)
SDL_GLContext(* GL_CreateContext)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:250
void * pixels
Definition: SDL_surface.h:75
#define SDL_FreeSurface
void Cocoa_QuitMouse(_THIS)
#define _THIS
int(* GL_MakeCurrent)(_THIS, SDL_Window *window, SDL_GLContext context)
Definition: SDL_sysvideo.h:251
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:143
void Cocoa_PumpEvents(_THIS)
void SDL_free(void *mem)
int Cocoa_SetWindowGammaRamp(_THIS, SDL_Window *window, const Uint16 *ramp)
void Cocoa_DestroyWindow(_THIS, SDL_Window *window)
#define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES
A variable that dictates policy for fullscreen Spaces on Mac OS X.
Definition: SDL_hints.h:579
void Cocoa_RaiseWindow(_THIS, SDL_Window *window)
SDL_bool Cocoa_GetWindowWMInfo(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
BOOL screensaver_use_iopm
void(* SetWindowMinimumSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:209
int Cocoa_GetDisplayDPI(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hpdi, float *vdpi)
int(* GetDisplayBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Definition: SDL_sysvideo.h:174
void(* DestroyWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:227
void(* StopTextInput)(_THIS)
Definition: SDL_sysvideo.h:269
SDL_WindowShaper * Cocoa_CreateShaper(SDL_Window *window)
void(* SetWindowIcon)(_THIS, SDL_Window *window, SDL_Surface *icon)
Definition: SDL_sysvideo.h:206
int Cocoa_SetWindowOpacity(_THIS, SDL_Window *window, float opacity)
void Cocoa_SetWindowFullscreen(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
void(* GL_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:249
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
void(* GetDisplayModes)(_THIS, SDL_VideoDisplay *display)
Definition: SDL_sysvideo.h:189
void(* SetWindowMaximumSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:210
#define NULL
Definition: begin_code.h:143
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
void(* VideoQuit)(_THIS)
Definition: SDL_sysvideo.h:164
int Cocoa_CreateWindow(_THIS, SDL_Window *window)
SDL_WindowShaper *(* CreateShaper)(SDL_Window *window)
Definition: SDL_sysvideo.h:58
int Cocoa_GetWindowGammaRamp(_THIS, SDL_Window *window, Uint16 *ramp)
static char text[MAX_TEXT_LENGTH]
Definition: testime.c:47
int(* ResizeWindowShape)(SDL_Window *window)
Definition: SDL_sysvideo.h:60
int(* SetWindowOpacity)(_THIS, SDL_Window *window, float opacity)
Definition: SDL_sysvideo.h:212
void(* SetWindowPosition)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:207
int(* CreateWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:203
int(* GetWindowGammaRamp)(_THIS, SDL_Window *window, Uint16 *ramp)
Definition: SDL_sysvideo.h:225
void Cocoa_SetWindowSize(_THIS, SDL_Window *window)
void(* MinimizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:219
void Cocoa_InitKeyboard(_THIS)
int Cocoa_ResizeWindowShape(SDL_Window *window)
void Cocoa_StopTextInput(_THIS)
uint16_t Uint16
An unsigned 16-bit integer type.
Definition: SDL_stdinc.h:151
SDL_bool(* HasClipboardText)(_THIS)
Definition: SDL_sysvideo.h:281
SDL_ShapeDriver shape_driver
Definition: SDL_sysvideo.h:237
int(* VideoInit)(_THIS)
Definition: SDL_sysvideo.h:158
void(* SetWindowFullscreen)(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
Definition: SDL_sysvideo.h:223
void Cocoa_HideWindow(_THIS, SDL_Window *window)
int Cocoa_GetDisplayBounds(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
void(* GL_DeleteContext)(_THIS, SDL_GLContext context)
Definition: SDL_sysvideo.h:256
void Cocoa_SetWindowGrab(_THIS, SDL_Window *window, SDL_bool grabbed)
char *(* GetClipboardText)(_THIS)
Definition: SDL_sysvideo.h:280
void(* SetWindowTitle)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:205
void(* SetWindowResizable)(_THIS, SDL_Window *window, SDL_bool resizable)
Definition: SDL_sysvideo.h:222
int(* GetDisplayUsableBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Definition: SDL_sysvideo.h:184
int(* GL_GetSwapInterval)(_THIS)
Definition: SDL_sysvideo.h:254
void(* MaximizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:218
int(* SetClipboardText)(_THIS, const char *text)
Definition: SDL_sysvideo.h:279
void Cocoa_QuitModes(_THIS)
int(* SetWindowGammaRamp)(_THIS, SDL_Window *window, const Uint16 *ramp)
Definition: SDL_sysvideo.h:224
void(* SuspendScreenSaver)(_THIS)
Definition: SDL_sysvideo.h:265
#define floor
Definition: math_private.h:37
void Cocoa_InitModes(_THIS)
void(* SetWindowGrab)(_THIS, SDL_Window *window, SDL_bool grabbed)
Definition: SDL_sysvideo.h:226
void *(* GL_GetProcAddress)(_THIS, const char *proc)
Definition: SDL_sysvideo.h:248
void Cocoa_MaximizeWindow(_THIS, SDL_Window *window)
void(* PumpEvents)(_THIS)
Definition: SDL_sysvideo.h:262
int Cocoa_SetWindowHitTest(SDL_Window *window, SDL_bool enabled)
void Cocoa_SetWindowMinimumSize(_THIS, SDL_Window *window)