Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_Surface.3 @ 632:85e104fe14c2
Date: Sun, 1 Jun 2003 15:38:45 -0700 (PDT)
From: Jeff Brown <jabrown@caida.org>
Subject: [patch] SDL-1.2.5 + FreeBSD joystick axes, hat fixes
Hello again! When I sent in some SDL fixes last December, I found out
they'd already been fixed in the CVS version. This time, I checked the
repository before bugging you. =)
I'm using SDL-1.2.5 on a FreeBSD 4.6.2-RELEASE system, and in the course
of getting my multi-analog-axis USB controller (with a hat switch!)
working with d2x-sdl -- the SDL port of the Descent 2 engine -- I came
across a few problems:
1) The second analog stick is reported as a slider in one direction, and
"Rz" in the other. SDL was ignoring the Rz axis, so I added Rx/Ry/Rz to
the set of things SDL considers to be axes.
2) After the above change, the set of JOYAXE_* axes for my gamepad was
{0,1,3,7}; however, d2x-sdl expects the axes to be contiguously numbered
from 0, which seems like a pretty reasonable expectation, rather than
having to scan the entire space of axes that SDL may or may not have.
So, I added a table lookup which maps the JOYAXE_* axis numbers to 0,1,...
in the order they're detected by SDL_SYS_JoystickOpen(), when reporting
them to the application. I also added a function "usage_to_joyaxe()"
which maps the USB HUG_* usage values to JOYAXE_values, since the repeated
case statements testing for HUG_* were getting out of hand.
3) The BSD joystick driver had no hat support, so I added it. It looks
like our USB library can only support one hat switch per device, which
makes life easy.
The patch against SDL-1.2.5 which implements these changes is at:
http://www.caida.org/~jabrown/patches/sdl-1.2.5-bsdhat.diff
After applying, SDL's "testjoystick" reports all activity from my gamepad
correctly, and d2x works too (though it needed some other fixes).
Moving on...
There is also a problem with slightly different USBHID library interfaces
on different versions of FreeBSD. I wasn't going to mention this since the
FreeBSD port for SDL-1.2.5 (and not SDL itself) was doing the FreeBSD
version-specific patching, so I e-mailed the port maintainer with this
change. However, I see that you've incorporated the FreeBSD
version-checking stuff into the CVS version of SDL, so now it's relevant
for you too.
The problem is, the FreeBSD #if tests don't work right for FreeBSD
4.6.2-RELEASE. There may be other versions with this problem, but I've
only tested 4.6.2-R. The following patch against your latest CVS version
fixes this:
--- SDL_sysjoystick.c-1.16 Tue Apr 15 09:02:08 2003
+++ SDL_sysjoystick.c Sun Jun 1 15:10:28 2003
@@ -420,6 +420,8 @@
# else
len = hid_report_size(rd, repinfo[repind].kind, r->rid);
# endif
+# elif (__FreeBSD_version == 460002)
+ len = hid_report_size(rd, r->rid, repinfo[repind].kind);
# else
len = hid_report_size(rd, repinfo[repind].kind, &r->rid);
#endif
I hope this is all useful to you. I've been getting myself dizzy playing
Descent 2 with it, all morning!
-Jeff Brown
P.S. My USB controller is a Thrustmaster Firestorm Dual Analog 2. That's
probably irrelevant, but I threw it in for completeness.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Mon, 02 Jun 2003 14:50:22 +0000 |
parents | e5bc29de3f0a |
children | 546f7c1eb755 |
rev | line source |
---|---|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_Surface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
0 | 2 .SH "NAME" |
3 SDL_Surface\- Graphical Surface Structure | |
4 .SH "STRUCTURE DEFINITION" | |
5 .PP | |
6 .nf | |
7 \f(CWtypedef struct SDL_Surface { | |
8 Uint32 flags; /* Read-only */ | |
9 SDL_PixelFormat *format; /* Read-only */ | |
10 int w, h; /* Read-only */ | |
11 Uint16 pitch; /* Read-only */ | |
12 void *pixels; /* Read-write */ | |
13 | |
14 /* clipping information */ | |
15 SDL_Rect clip_rect; /* Read-only */ | |
16 | |
17 /* Reference count -- used when freeing surface */ | |
18 int refcount; /* Read-mostly */ | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
19 |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
20 /* This structure also contains private fields not shown here */ |
0 | 21 } SDL_Surface;\fR |
22 .fi | |
23 .PP | |
24 .SH "STRUCTURE DATA" | |
25 .TP 20 | |
26 \fBflags\fR | |
27 Surface flags | |
28 .TP 20 | |
29 \fBformat\fR | |
30 Pixel \fIformat\fR | |
31 .TP 20 | |
32 \fBw, h\fR | |
33 Width and height of the surface | |
34 .TP 20 | |
35 \fBpitch\fR | |
36 Length of a surface scanline in bytes | |
37 .TP 20 | |
38 \fBpixels\fR | |
39 Pointer to the actual pixel data | |
40 .TP 20 | |
41 \fBclip_rect\fR | |
42 surface clip \fIrectangle\fR | |
43 .SH "DESCRIPTION" | |
44 .PP | |
45 \fBSDL_Surface\fR\&'s represent areas of "graphical" memory, memory that can be drawn to\&. The video framebuffer is returned as a \fBSDL_Surface\fR by \fI\fBSDL_SetVideoMode\fP\fR and \fI\fBSDL_GetVideoSurface\fP\fR\&. Most of the fields should be pretty obvious\&. \fBw\fR and \fBh\fR are the width and height of the surface in pixels\&. \fBpixels\fR is a pointer to the actual pixel data, the surface should be \fIlocked\fR before accessing this field\&. The \fBclip_rect\fR field is the clipping rectangle as set by \fI\fBSDL_SetClipRect\fP\fR\&. | |
46 .PP | |
47 The following are supported in the \fBflags\fR field\&. | |
48 .TP 20 | |
49 \fBSDL_SWSURFACE\fP | |
50 Surface is stored in system memory | |
51 .TP 20 | |
52 \fBSDL_HWSURFACE\fP | |
53 Surface is stored in video memory | |
54 .TP 20 | |
55 \fBSDL_ASYNCBLIT\fP | |
56 Surface uses asynchronous blits if possible | |
57 .TP 20 | |
58 \fBSDL_ANYFORMAT\fP | |
59 Allows any pixel-format (Display surface) | |
60 .TP 20 | |
61 \fBSDL_HWPALETTE\fP | |
62 Surface has exclusive palette | |
63 .TP 20 | |
64 \fBSDL_DOUBLEBUF\fP | |
65 Surface is double buffered (Display surface) | |
66 .TP 20 | |
67 \fBSDL_FULLSCREEN\fP | |
68 Surface is full screen (Display Surface) | |
69 .TP 20 | |
70 \fBSDL_OPENGL\fP | |
71 Surface has an OpenGL context (Display Surface) | |
72 .TP 20 | |
73 \fBSDL_OPENGLBLIT\fP | |
74 Surface supports OpenGL blitting (Display Surface) | |
75 .TP 20 | |
76 \fBSDL_RESIZABLE\fP | |
77 Surface is resizable (Display Surface) | |
78 .TP 20 | |
79 \fBSDL_HWACCEL\fP | |
80 Surface blit uses hardware acceleration | |
81 .TP 20 | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
82 \fBSDL_SRCCOLORKEY\fP |
0 | 83 Surface use colorkey blitting |
84 .TP 20 | |
85 \fBSDL_RLEACCEL\fP | |
86 Colorkey blitting is accelerated with RLE | |
87 .TP 20 | |
88 \fBSDL_SRCALPHA\fP | |
89 Surface blit uses alpha blending | |
90 .TP 20 | |
91 \fBSDL_PREALLOC\fP | |
92 Surface uses preallocated memory | |
93 .SH "SEE ALSO" | |
94 .PP | |
95 \fI\fBSDL_PixelFormat\fR\fR | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
96 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |