[sdl_omap.git] / docs / man3 / SDL_JoyHatEvent.3

.TH "SDL_JoyHatEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_JoyHatEvent \- Joystick hat position change event structure
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
  Uint8 type;
  Uint8 which;
  Uint8 hat;
  Uint8 value;
} SDL_JoyHatEvent;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBtype\fR
\fBSDL_JOY\fP
.TP 20
\fBwhich\fR
Joystick device index
.TP 20
\fBhat\fR
Joystick hat index
.TP 20
\fBvalue\fR
Hat position
.SH "DESCRIPTION"
.PP
\fBSDL_JoyHatEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYHATMOTION\fP is reported\&.
.PP
A \fBSDL_JOYHATMOTION\fP event occurs when ever a user moves a hat on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBhat\fR is the index of the hat (for a more detailed exlaination see the \fIJoystick section\fR)\&. \fBvalue\fR is the current position of the hat\&. It is a logically OR\&'d combination of the following values (whose meanings should be pretty obvious:) :
.IP "" 10
\fBSDL_HAT_CENTERED\fP
.IP "" 10
\fBSDL_HAT_UP\fP
.IP "" 10
\fBSDL_HAT_RIGHT\fP
.IP "" 10
\fBSDL_HAT_DOWN\fP
.IP "" 10
\fBSDL_HAT_LEFT\fP
.PP
The following defines are also provided:
.IP "" 10
\fBSDL_HAT_RIGHTUP\fP
.IP "" 10
\fBSDL_HAT_RIGHTDOWN\fP
.IP "" 10
\fBSDL_HAT_LEFTUP\fP
.IP "" 10
\fBSDL_HAT_LEFTDOWN\fP
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetHat\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59
Commit	Line	Data
e14743d1	1	.TH "SDL_JoyHatEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
	2	.SH "NAME"
	3	SDL_JoyHatEvent \- Joystick hat position change event structure
	4	.SH "STRUCTURE DEFINITION"
	5	.PP
	6	.nf
	7	\f(CWtypedef struct{
	8	Uint8 type;
	9	Uint8 which;
	10	Uint8 hat;
	11	Uint8 value;
	12	} SDL_JoyHatEvent;\fR
	13	.fi
	14	.PP
	15	.SH "STRUCTURE DATA"
	16	.TP 20
	17	\fBtype\fR
	18	\fBSDL_JOY\fP
	19	.TP 20
	20	\fBwhich\fR
	21	Joystick device index
	22	.TP 20
	23	\fBhat\fR
	24	Joystick hat index
	25	.TP 20
	26	\fBvalue\fR
	27	Hat position
	28	.SH "DESCRIPTION"
	29	.PP
	30	\fBSDL_JoyHatEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYHATMOTION\fP is reported\&.
	31	.PP
	32	A \fBSDL_JOYHATMOTION\fP event occurs when ever a user moves a hat on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBhat\fR is the index of the hat (for a more detailed exlaination see the \fIJoystick section\fR)\&. \fBvalue\fR is the current position of the hat\&. It is a logically OR\&'d combination of the following values (whose meanings should be pretty obvious:) :
	33	.IP "" 10
	34	\fBSDL_HAT_CENTERED\fP
	35	.IP "" 10
	36	\fBSDL_HAT_UP\fP
	37	.IP "" 10
	38	\fBSDL_HAT_RIGHT\fP
	39	.IP "" 10
	40	\fBSDL_HAT_DOWN\fP
	41	.IP "" 10
	42	\fBSDL_HAT_LEFT\fP
	43	.PP
	44	The following defines are also provided:
	45	.IP "" 10
	46	\fBSDL_HAT_RIGHTUP\fP
	47	.IP "" 10
	48	\fBSDL_HAT_RIGHTDOWN\fP
	49	.IP "" 10
	50	\fBSDL_HAT_LEFTUP\fP
	51	.IP "" 10
	52	\fBSDL_HAT_LEFTDOWN\fP
	53	.SH "SEE ALSO"
	54	.PP
	55	\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetHat\fP\fR
	56	.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59