Mercurial > sdl-ios-xcode
annotate README.MacOSX @ 4157:baf615f9f2a0 SDL-1.2
Date: Thu, 16 Oct 2008 20:27:34 +0400
From: "Ilya Kasnacheev" <ilya.kasnacheev@gmail.com>
To: sdl@lists.libsdl.org
Subject: [SDL] SDL for Windows CE: a few GAPI patches
Hi *!
I've just ported a POWDER roguelike ( http://www.zincland.com/powder/ ) to
Windows CE (PDAs, Windows Mobile/Pocket PC). To do that, I had to get libsdl
working. Thanks for the awesome project files, it built without a hitch.
Nevertheless, I've found quite a few bugs in Windows CE (GAPI) SDL
implementation, which I've solved and now present as a serie of patches.
I'll try carefully annotate them. Please annotate them so I can work
toward accepting
them into the main source tree since without them SDL isn't really working on
Windows CE (I wonder why nobody fixed them before, btw: why isn't SDL popular as
a way to develop Windows CE games? Where are no ports?)
These changes can't be considered flawless, but they can be considered working
because I've yet to hear complains about things I fixed and POWDER build for
Windows CE is now considered stable.
Note: my comments start with !!, delete them before applying.
diff -bru SDL-1.2.13/src/video/gapi/SDL_gapivideo.c
SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.c
--- SDL-1.2.13/src/video/gapi/SDL_gapivideo.c 2007-12-31
07:48:00.000000000 +0300
+++ SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.c 2008-10-16
20:02:11.000000000 +0400
@@ -643,6 +643,7 @@
}
gapi->userOrientation = SDL_ORIENTATION_UP;
+ gapi->systemOrientation = SDL_ORIENTATION_UP;
video->flags = SDL_FULLSCREEN; /* Clear flags, GAPI supports
fullscreen only */
/* GAPI or VGA? */
@@ -661,18 +662,21 @@
}
/* detect user landscape mode */
- if( (width > height) && (GetSystemMetrics(SM_CXSCREEN) <
GetSystemMetrics(SM_CYSCREEN)))
+ if( (width > height) && (gapi->gxProperties.cxWidth <
gapi->gxProperties.cyHeight))
gapi->userOrientation = SDL_ORIENTATION_RIGHT;
+ if(GetSystemMetrics(SM_CYSCREEN) < GetSystemMetrics(SM_CXSCREEN))
+ gapi->systemOrientation = SDL_ORIENTATION_RIGHT;
+
/* shall we apply hires fix? for example when we do not use
hires resource */
gapi->hiresFix = 0;
- if( gapi->userOrientation == SDL_ORIENTATION_RIGHT )
+ if( gapi->systemOrientation == gapi->userOrientation )
{
- if( (width > GetSystemMetrics(SM_CYSCREEN)) || (height
> GetSystemMetrics(SM_CXSCREEN)))
+ if( (width > GetSystemMetrics(SM_CXSCREEN)) || (height
> GetSystemMetrics(SM_CYSCREEN)))
gapi->hiresFix = 1;
} else
- if( (width > GetSystemMetrics(SM_CXSCREEN)) || (height
> GetSystemMetrics(SM_CYSCREEN)))
- if( !((width == GetSystemMetrics(SM_CYSCREEN))
&& (height == GetSystemMetrics(SM_CXSCREEN)))) // user portrait,
device landscape
+ if( (width > GetSystemMetrics(SM_CYSCREEN)) || (height
> GetSystemMetrics(SM_CXSCREEN)))
+// if( !((width == gapi->gxProperties.cyHeight)
&& (height == gapi->gxProperties.cxWidth))) // user portrait, device
landscape
gapi->hiresFix = 1;
switch( gapi->userOrientation )
!! It used to query system metrics which return dimensions according to screen
!! orientation, which can really be portrait, left landscape or right landscape.
!! This is presumably incorrect because we couldn't care less about user mode
!! dimensions - all we want are the GAPI framebuffer dimensions, which
only match
!! user dimensions in one of possible orientations.
!! There's a fair dose of cargo cult programming involved in this fix, but it
!! used to work only in one orientation (portrait for PDAs, where frame-buffer
!! have same orientation as user screen), and now it works on all orientations.
@@ -742,21 +746,30 @@
WIN_FlushMessageQueue();
/* Open GAPI display */
- if( !gapi->useVga && this->hidden->useGXOpenDisplay )
+ if( !gapi->useVga && this->hidden->useGXOpenDisplay &&
!this->hidden->alreadyGXOpened )
+ {
+ this->hidden->alreadyGXOpened = 1;
if( !gapi->gxFunc.GXOpenDisplay(SDL_Window, GX_FULLSCREEN) )
{
SDL_SetError("Couldn't initialize GAPI");
return(NULL);
}
+ }
#if REPORT_VIDEO_INFO
printf("Video properties:\n");
printf("display bpp: %d\n", gapi->gxProperties.cBPP);
printf("display width: %d\n", gapi->gxProperties.cxWidth);
printf("display height: %d\n", gapi->gxProperties.cyHeight);
+ printf("system display width: %d\n", GetSystemMetrics(SM_CXSCREEN));
+ printf("system display height: %d\n", GetSystemMetrics(SM_CYSCREEN));
printf("x pitch: %d\n", gapi->gxProperties.cbxPitch);
printf("y pitch: %d\n", gapi->gxProperties.cbyPitch);
printf("gapi flags: 0x%x\n", gapi->gxProperties.ffFormat);
+ printf("user orientation: %d\n", gapi->userOrientation);
+ printf("system orientation: %d\n", gapi->userOrientation);
+ printf("gapi orientation: %d\n", gapi->gapiOrientation);
+
if( !gapi->useVga && this->hidden->useGXOpenDisplay && gapi->needUpdate)
{
!! Previous version used to call gapi->gxFunc.GXOpenDisplay each time the video
!! mode would be changed. You shouldn't, because this call has a
meaning "Lock the
!! GAPI framebuffer, designate it as busy", so the second call will fail (it is
!! already locked/busy).
!! Testing might not find that because most programs set up the video mode only
!! once, but POWDER does this once in a while, so it crashed when in
320x240 mode
!! (640x480 mode doesn't use that code, it worked fine).
diff -bru SDL-1.2.13/src/video/gapi/SDL_gapivideo.h
SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.h
--- SDL-1.2.13/src/video/gapi/SDL_gapivideo.h 2007-12-31
07:48:00.000000000 +0300
+++ SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.h 2008-10-16
20:02:11.000000000 +0400
@@ -132,12 +132,17 @@
#define NUM_MODELISTS 4 /* 8, 16, 24, and 32 bits-per-pixel */
int SDL_nummodes[NUM_MODELISTS];
SDL_Rect **SDL_modelist[NUM_MODELISTS];
+ // The orientation of the video mode user wants to get
+ // Probably restricted to UP and RIGHT
enum SDL_ScreenOrientation userOrientation;
int invert;
char hiresFix; // using hires mode without defining hires resource
// --------------
int useGXOpenDisplay; /* use GXOpenDispplay */
+ int alreadyGXOpened;
int w, h;
+ // The orientation of GAPI framebuffer.
+ // Never changes on the same device.
enum SDL_ScreenOrientation gapiOrientation;
void *buffer; // may be 8, 16, 24, 32 bpp
@@ -153,6 +158,10 @@
int startOffset; // in bytes
int useVga;
int suspended; // do not pu anything into video memory
+ // The orientation of the system, as defined by SM_CXSCREEN
and SM_CYSCREEN
+ // User can change it by using 'screen layout' in system options
+ // Restricted to UP or RIGHT
+ enum SDL_ScreenOrientation systemOrientation;
};
!! This is a flag variable, see the previous comment
!! And yet another orientation: now we have to keep three of them in mind.
diff -bru SDL-1.2.13/src/video/wincommon/SDL_sysevents.c
SDL-1.2.13-new/src/video/wincommon/SDL_sysevents.c
--- SDL-1.2.13/src/video/wincommon/SDL_sysevents.c 2007-12-31
07:48:02.000000000 +0300
+++ SDL-1.2.13-new/src/video/wincommon/SDL_sysevents.c 2008-10-16
20:02:12.000000000 +0400
@@ -160,10 +160,22 @@
#endif */
}
break;
+ // FIXME: Older version used just SDL_VideoSurface->(w, h)
+ // w and h are "clipped" while x and y are "raw", which caused
+ // x in former and y in latter case to be clipped in a
wrong direction,
+ // thus offsetting the coordinate on 2 x clip pixels
+ // (like, 128 for 640 -> 512 clipping).
+ // We will now try to extract and use raw values.
+ // The way to do that RIGHT is do
(orientation-dependent) clipping before
+ // doing this transform, but it's hardly possible.
+
+ // SEE SDL_mouse.c /ClipOffset to understand these calculations.
case SDL_ORIENTATION_RIGHT:
if (!SDL_VideoSurface)
break;
- rotatedX = SDL_VideoSurface->w - *y;
+ rotatedX = (2 *
((SDL_VideoSurface->offset%SDL_VideoSurface->pitch)/
+ SDL_VideoSurface->format->BytesPerPixel))
+ + SDL_VideoSurface->w - *y;
rotatedY = *x;
*x = rotatedX;
*y = rotatedY;
@@ -172,7 +184,8 @@
if (!SDL_VideoSurface)
break;
rotatedX = *y;
- rotatedY = SDL_VideoSurface->h - *x;
+ rotatedY = (2 *
(SDL_VideoSurface->offset/SDL_VideoSurface->pitch))
+ + SDL_VideoSurface->h - *x;
*x = rotatedX;
*y = rotatedY;
break;
!! That's the trickest part, hence the long comment.
!! GAPI would really support only 320x240 or 640x480 mode, if application
!! requested the different screen size (as POWDER did, wishing
256x192), then SDL
!! is going to grab the first mode that fits the requested, and pad the screen
!! with black bars (as they do with wide-screen films).
!! It would also get, say, 240x320 mode, and to turn it into 256x192 it would
!! need to rotate mouse clicks.
!! It worked, but one bug slipped through: it would receive mouse clicks
!! unpadded, then rotate them, and then pad the black bars. The
problem is: rotate
!! is done by GAPI driver while padding is done by SDL core. SDL core
doesn't know
!! anything about rotating, so it would pad one of dimensions incorrectly.
I understand that some of my claims (or code) might seem unbacked, but you can
always grab the POWDER binary, compile your own libsdl with one or more of
those fixes turned off, and see how weird it would misbehave. I can even supply
you with those custom builds of libsdl if you don't want to set up the build
environment for windows ce, you'll just need a PDA or a smartphone with it.
I plan to take care of SDL on Windows CE as long as I maintain the POWDER port.
POWDER is good for that because it:
Employs both padded (with centered image, black bars) and unpadded
(image occupies full screen) graphics; initializes video more than
once; uses both 320x240 and 640x480 video; uses both stylus and
buttons.
There's still a list of unresolved issues which I'm planning to fix:
1) Arrow buttons on PDA return weird scancodes compared to PC, this
caused the game to misbehave before I've fixed that. You can see it on
those diagrams:
http://wrar.name/upload/powder-htc.png
http://wrar.name/upload/powder-pda.png
2) SDL (or underlying windows) doesn't care to rotate arrow presses
when we're in a low-res GAPI mode, but it will rotate them in VGA mode
(because of different screen orientations, the same arrow buttons can
suddently mean different directions). Solution: we should stick to
GAPI user orientation (the orientation the program supposedly wants)
and rotate the keys on our own.
_______________________________________________
SDL mailing list
SDL@lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 07 Nov 2008 04:15:36 +0000 |
parents | 78da406ad139 |
children |
rev | line source |
---|---|
0 | 1 ============================================================================== |
2 Using the Simple DirectMedia Layer with Mac OS X | |
3 ============================================================================== | |
4 | |
5 These instructions are for people using Apple's Mac OS X (pronounced | |
6 "ten"). | |
7 | |
8 From the developer's point of view, OS X is a sort of hybrid Mac and | |
9 Unix system, and you have the option of using either traditional | |
1006
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
10 command line tools or Apple's IDE Xcode. |
0 | 11 |
869
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
12 To build SDL using the command line, use the standard configure and make |
0 | 13 process: |
14 | |
15 ./configure | |
16 make | |
869
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
17 sudo make install |
0 | 18 |
1649
9705d5d69691
Added info about fatbuild.sh
Sam Lantinga <slouken@libsdl.org>
parents:
1621
diff
changeset
|
19 You can also build SDL as a Universal library (a single binary for both |
9705d5d69691
Added info about fatbuild.sh
Sam Lantinga <slouken@libsdl.org>
parents:
1621
diff
changeset
|
20 PowerPC and Intel architectures), on Mac OS X 10.4 and newer, by using |
9705d5d69691
Added info about fatbuild.sh
Sam Lantinga <slouken@libsdl.org>
parents:
1621
diff
changeset
|
21 the fatbuild.sh script in build-scripts: |
9705d5d69691
Added info about fatbuild.sh
Sam Lantinga <slouken@libsdl.org>
parents:
1621
diff
changeset
|
22 sh build-scripts/fatbuild.sh |
9705d5d69691
Added info about fatbuild.sh
Sam Lantinga <slouken@libsdl.org>
parents:
1621
diff
changeset
|
23 sudo build-scripts/fatbuild.sh install |
1839
78da406ad139
Added information about gcc-fat.sh to README.MacOSX
Sam Lantinga <slouken@libsdl.org>
parents:
1650
diff
changeset
|
24 This script builds SDL with 10.2 ABI compatibility on PowerPC and 10.4 |
78da406ad139
Added information about gcc-fat.sh to README.MacOSX
Sam Lantinga <slouken@libsdl.org>
parents:
1650
diff
changeset
|
25 ABI compatibility on Intel architectures. For best compatibility you |
78da406ad139
Added information about gcc-fat.sh to README.MacOSX
Sam Lantinga <slouken@libsdl.org>
parents:
1650
diff
changeset
|
26 should compile your application the same way. A script which wraps |
78da406ad139
Added information about gcc-fat.sh to README.MacOSX
Sam Lantinga <slouken@libsdl.org>
parents:
1650
diff
changeset
|
27 gcc to make this easy is provided in test/gcc-fat.sh |
0 | 28 |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
29 To use the library once it's built, you essential have two possibilities: |
1650
ee4f2d77206f
Whoops, you can't use Project Builder anymore...
Sam Lantinga <slouken@libsdl.org>
parents:
1649
diff
changeset
|
30 use the traditional autoconf/automake/make method, or use Xcode. |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
31 |
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
32 ============================================================================== |
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
33 Using the Simple DirectMedia Layer with a traditional Makefile |
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
34 ============================================================================== |
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
35 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
36 An existing autoconf/automake build system for your SDL app has good chances |
1621 | 37 to work almost unchanged on OS X. However, to produce a "real" Mac OS X binary |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
38 that you can distribute to users, you need to put the generated binary into a |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
39 so called "bundle", which basically is a fancy folder with a name like |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
40 "MyCoolGame.app". |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
41 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
42 To get this build automatically, add something like the following rule to |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
43 your Makefile.am: |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
44 |
199
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
45 bundle_contents = APP_NAME.app/Contents |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
46 APP_NAME_bundle: EXE_NAME |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
47 mkdir -p $(bundle_contents)/MacOS |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
48 mkdir -p $(bundle_contents)/Resources |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
49 echo "APPL????" > $(bundle_contents)/PkgInfo |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
50 $(INSTALL_PROGRAM) $< $(bundle_contents)/MacOS/ |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
51 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
52 You should replace EXE_NAME with the name of the executable. APP_NAME is what |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
53 will be visible to the user in the Finder. Usually it will be the same |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
54 as EXE_NAME but capitalized. E.g. if EXE_NAME is "testgame" then APP_NAME |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
55 usually is "TestGame". You might also want to use @PACKAGE@ to use the package |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
56 name as specified in your configure.in file. |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
57 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
58 If your project builds more than one application, you will have to do a bit |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
59 more. For each of your target applications, you need a seperate rule. |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
60 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
61 If you want the created bundles to be installed, you may want to add this |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
62 rule to your Makefile.am: |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
63 |
199
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
64 install-exec-hook: APP_NAME_bundle |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
65 rm -rf $(DESTDIR)$(prefix)/Applications/APP_NAME.app |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
66 mkdir -p $(DESTDIR)$(prefix)/Applications/ |
2ad0957f6265
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
191
diff
changeset
|
67 cp -r $< /$(DESTDIR)$(prefix)Applications/ |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
68 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
69 This rule takes the Bundle created by the rule from step 3 and installs them |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
70 into $(DESTDIR)$(prefix)/Applications/. |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
71 |
221
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
72 Again, if you want to install multiple applications, you will have to augment |
50620ec9c86a
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
207
diff
changeset
|
73 the make rule accordingly. |
172
37e3ca9254c7
Date: Sat, 8 Sep 2001 04:42:23 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
53
diff
changeset
|
74 |
0 | 75 |
869
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
76 But beware! That is only part of the story! With the above, you end up with |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
77 a bare bone .app bundle, which is double clickable from the Finder. But |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
78 there are some more things you should do before shipping yor product... |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
79 |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
80 1) The bundle right now probably is dynamically linked against SDL. That |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
81 means that when you copy it to another computer, *it will not run*, |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
82 unless you also install SDL on that other computer. A good solution |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
83 for this dilemma is to static link against SDL. On OS X, you can |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
84 achieve that by linkinag against the libraries listed by |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
85 sdl-config --static-libs |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
86 instead of those listed by |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
87 sdl-config --libs |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
88 Depending on how exactly SDL is integrated into your build systems, the |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
89 way to achieve that varies, so I won't describe it here in detail |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
90 2) Add an 'Info.plist' to your application. That is a special XML file which |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
91 contains some meta-information about your application (like some copyright |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
92 information, the version of your app, the name of an optional icon file, |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
93 and other things). Part of that information is displayed by the Finder |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
94 when you click on the .app, or if you look at the "Get Info" window. |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
95 More information about Info.plist files can be found on Apple's homepage. |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
96 |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
97 |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
98 As a final remark, let me add that I use some of the techniques (and some |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
99 variations of them) in Exult and ScummVM; both are available in source on |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
100 the net, so feel free to take a peek at them for inspiration! |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
101 |
ae4ab3ac89a9
Instructive comments from Max Horn
Sam Lantinga <slouken@libsdl.org>
parents:
221
diff
changeset
|
102 |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
103 ============================================================================== |
1006
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
104 Using the Simple DirectMedia Layer with Xcode |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
105 ============================================================================== |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
106 |
1006
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
107 These instructions are for using Apple's Xcode IDE to build SDL applications. |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
108 |
53
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
109 - First steps |
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
110 |
1006
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
111 The first thing to do is to unpack the Xcode.tar.gz archive in the |
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
112 top level SDL directory (where the Xcode.tar.gz archive resides). |
53
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
113 Because Stuffit Expander will unpack the archive into a subdirectory, |
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
114 you should unpack the archive manually from the command line: |
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
115 cd [path_to_SDL_source] |
1006
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
116 tar zxf Xcode.tar.gz |
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
117 This will create a new folder called Xcode, which you can browse |
53
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
118 normally from the Finder. |
25dfe480c75e
Added MacOS X Project Builder projects
Sam Lantinga <slouken@lokigames.com>
parents:
47
diff
changeset
|
119 |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
120 - Building the Framework |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
121 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
122 The SDL Library is packaged as a framework bundle, an organized |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
123 relocatable folder heirarchy of executible code, interface headers, |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
124 and additional resources. For practical purposes, you can think of a |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
125 framework as a more user and system-friendly shared library, whose library |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
126 file behaves more or less like a standard UNIX shared library. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
127 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
128 To build the framework, simply open the framework project and build it. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
129 By default, the framework bundle "SDL.framework" is installed in |
1006
3d9a199d2a70
Updated SDL for MacOS X Xcode support
Sam Lantinga <slouken@libsdl.org>
parents:
869
diff
changeset
|
130 /Library/Frameworks. Therefore, the testers and project stationary expect |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
131 it to be located there. However, it will function the same in any of the |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
132 following locations: |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
133 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
134 ~/Library/Frameworks |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
135 /Local/Library/Frameworks |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
136 /System/Library/Frameworks |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
137 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
138 - Build Options |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
139 There are two "Build Styles" (See the "Targets" tab) for SDL. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
140 "Deployment" should be used if you aren't tweaking the SDL library. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
141 "Development" should be used to debug SDL apps or the library itself. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
142 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
143 - Building the Testers |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
144 Open the SDLTest project and build away! |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
145 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
146 - Using the Project Stationary |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
147 Copy the stationary to the indicated folders to access it from |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
148 the "New Project" and "Add target" menus. What could be easier? |
0 | 149 |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
150 - Setting up a new project by hand |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
151 Some of you won't want to use the Stationary so I'll give some tips: |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
152 * Create a new "Cocoa Application" |
207
c03846dd489b
Added Darrell Walisser's updated project-builder projects
Sam Lantinga <slouken@libsdl.org>
parents:
199
diff
changeset
|
153 * Add src/main/macosx/SDLMain.m , .h and .nib to your project |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
154 * Remove "main.c" from your project |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
155 * Remove "MainMenu.nib" from your project |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
156 * Add "$(HOME)/Library/Frameworks/SDL.framework/Headers" to include path |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
157 * Add "$(HOME)/Library/Frameworks" to the frameworks search path |
207
c03846dd489b
Added Darrell Walisser's updated project-builder projects
Sam Lantinga <slouken@libsdl.org>
parents:
199
diff
changeset
|
158 * Add "-framework SDL -framework Foundation -framework AppKit" to "OTHER_LDFLAGS" |
c03846dd489b
Added Darrell Walisser's updated project-builder projects
Sam Lantinga <slouken@libsdl.org>
parents:
199
diff
changeset
|
159 * Set the "Main Nib File" under "Application Settings" to "SDLMain.nib" |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
160 * Add your files |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
161 * Clean and build |
0 | 162 |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
163 - Building from command line |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
164 Use pbxbuild in the same directory as your .pbproj file |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
165 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
166 - Running your app |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
167 You can send command line args to your app by either invoking it from |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
168 the command line (in *.app/Contents/MacOS) or by entering them in the |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
169 "Executibles" panel of the target settings. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
170 |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
171 - Implementation Notes |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
172 Some things that may be of interest about how it all works... |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
173 * Working directory |
191
c151cfc43c07
Changed SDLMain to SDL_main for MacOS X stuff
Sam Lantinga <slouken@libsdl.org>
parents:
172
diff
changeset
|
174 As defined in the SDL_main.m file, the working directory of your SDL app |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
175 is by default set to its parent. You may wish to change this to better |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
176 suit your needs. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
177 * You have a Cocoa App! |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
178 Your SDL app is essentially a Cocoa application. When your app |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
179 starts up and the libraries finish loading, a Cocoa procedure is called, |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
180 which sets up the working directory and calls your main() method. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
181 You are free to modify your Cocoa app with generally no consequence |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
182 to SDL. You cannot, however, easily change the SDL window itself. |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
183 Functionality may be added in the future to help this. |
207
c03846dd489b
Added Darrell Walisser's updated project-builder projects
Sam Lantinga <slouken@libsdl.org>
parents:
199
diff
changeset
|
184 |
c03846dd489b
Added Darrell Walisser's updated project-builder projects
Sam Lantinga <slouken@libsdl.org>
parents:
199
diff
changeset
|
185 |
0 | 186 Known bugs are listed in the file "BUGS" |