Mercurial > sdl-ios-xcode

<HTML
><HEAD
><TITLE
>SDL_ShowCursor</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="Video"
HREF="video.html"><LINK
REL="PREVIOUS"
TITLE="SDL_GetCursor"
HREF="sdlgetcursor.html"><LINK
REL="NEXT"
TITLE="SDL_GL_LoadLibrary"
HREF="sdlglloadlibrary.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="sdlgetcursor.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlglloadlibrary.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLSHOWCURSOR"
></A
>SDL_ShowCursor</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2615"
></A
><H2
>Name</H2
>SDL_ShowCursor&nbsp;--&nbsp;Toggle whether or not the cursor is shown on the screen.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2618"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN2619"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_ShowCursor</B
></CODE
>(int toggle);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2625"
></A
><H2
>Description</H2
><P
>Toggle whether or not the cursor is shown on the screen. Passing <TT
CLASS="LITERAL"
>SDL_ENABLE</TT
> displays the cursor and passing <TT
CLASS="LITERAL"
>SDL_DISABLE</TT
> hides it. The current state of the mouse cursor can be queried by passing <TT
CLASS="LITERAL"
>SDL_QUERY</TT
>, either <TT
CLASS="LITERAL"
>SDL_DISABLE</TT
> or <TT
CLASS="LITERAL"
>SDL_ENABLE</TT
> will be returned.</P
><P
>The cursor starts off displayed, but can be turned off.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2634"
></A
><H2
>Return Value</H2
><P
>Returns the current state of the cursor.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2637"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlcreatecursor.html"
><TT
CLASS="FUNCTION"
>SDL_CreateCursor</TT
></A
>,
<A
HREF="sdlsetcursor.html"
><TT
CLASS="FUNCTION"
>SDL_SetCursor</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="sdlgetcursor.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="sdlglloadlibrary.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetCursor</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="video.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_GL_LoadLibrary</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
author	Ryan C. Gordon <icculus@icculus.org>
date	Sat, 16 Jun 2007 05:24:55 +0000
parents	355632dca928
children