Mercurial > sdl-ios-xcode
view docs/html/sdljoystickgethat.html @ 1258:b2283b0ded26
Date: Thu, 19 Jan 2006 20:02:29 +0200
From: Vassilis Virvilis <vasvir@iit.demokritos.gr>
Subject: [SDL] Request: Please reconsider adding tag in SDL_Event
Hi,
Patch in question:
--- include/SDL_events.h 20 Aug 2004 18:57:01 -0000 1.11
+++ include/SDL_events.h 19 Jan 2006 17:35:09 -0000
@@ -214,7 +214,7 @@
} SDL_SysWMEvent;
/* General event structure */
-typedef union {
+typedef union SDL_Event {
Uint8 type;
SDL_ActiveEvent active;
SDL_KeyboardEvent key;
Reasoning:
----------
1) Allows forward declaration of the SDL_Event union in C++. Please
note that in plain C it is possible to forward declare it.
2) Forward declaration is good because it allows encapsulation. It hides
the specific implementation and does not necessarily exposes SDL staff
to my appication's namespace
3) It can't harm plain C because tags are living in a different namespace
than typenames
4) It is already done like this in other places in SDL. Check for example
SDL_KeySym, and SDL_.*Event structures.
5) Right now I have to include SDL/event.h from a C++ header file. See 2)
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 20 Jan 2006 13:07:25 +0000 |
parents | 355632dca928 |
children |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_JoystickGetHat</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Joystick" HREF="joystick.html"><LINK REL="PREVIOUS" TITLE="SDL_JoystickGetAxis" HREF="sdljoystickgetaxis.html"><LINK REL="NEXT" TITLE="SDL_JoystickGetButton" HREF="sdljoystickgetbutton.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFF8DC" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" ALINK="#ff0000" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >SDL Library Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="sdljoystickgetaxis.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdljoystickgetbutton.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLJOYSTICKGETHAT" ></A >SDL_JoystickGetHat</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN6358" ></A ><H2 >Name</H2 >SDL_JoystickGetHat -- Get the current state of a joystick hat</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN6361" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN6362" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >Uint8 <B CLASS="FSFUNC" >SDL_JoystickGetHat</B ></CODE >(SDL_Joystick *joystick, int hat);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN6368" ></A ><H2 >Description</H2 ><P >SDL_JoystickGetHat returns the current state of the given <TT CLASS="PARAMETER" ><I >hat</I ></TT > on the given <TT CLASS="PARAMETER" ><I >joystick</I ></TT >.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN6373" ></A ><H2 >Return Value</H2 ><P >The current state is returned as a Uint8 which is defined as an OR'd combination of one or more of the following</P ><P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_CENTERED</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_UP</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_RIGHT</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_DOWN</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_LEFT</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_RIGHTUP</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_RIGHTDOWN</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_LEFTUP</TT ></TD ></TR ><TR ><TD ><TT CLASS="LITERAL" >SDL_HAT_LEFTDOWN</TT ></TD ></TR ></TBODY ></TABLE ><P ></P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN6395" ></A ><H2 >See Also</H2 ><P ><A HREF="sdljoysticknumhats.html" ><TT CLASS="FUNCTION" >SDL_JoystickNumHats</TT ></A ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdljoystickgetaxis.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdljoystickgetbutton.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_JoystickGetAxis</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="joystick.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_JoystickGetButton</TD ></TR ></TABLE ></DIV ></BODY ></HTML >