include/SDL_mouse.h
branchSDL-1.3
changeset 1671 89f7510fe17a
parent 1670 eef792d31de8
child 1673 624e1412fbba
     1.1 --- a/include/SDL_mouse.h	Wed Jun 07 16:10:28 2006 +0000
     1.2 +++ b/include/SDL_mouse.h	Fri Jun 09 06:42:42 2006 +0000
     1.3 @@ -57,7 +57,7 @@
     1.4   *
     1.5   * \brief Set the index of the currently selected mouse.
     1.6   *
     1.7 - * \return The index of the currently selected mouse.
     1.8 + * \return The index of the previously selected mouse.
     1.9   *
    1.10   * \note You can query the currently selected mouse by passing an index of -1.
    1.11   *
    1.12 @@ -109,7 +109,11 @@
    1.13                                                     int x, int y);
    1.14  
    1.15  /*
    1.16 - * Create a cursor using the specified data and mask (in MSB format).
    1.17 + * \fn SDL_Cursor *SDL_CreateCursor (const Uint8 * data, const Uint8 * mask, int w, int h, int hot_x, int hot_y)
    1.18 + *
    1.19 + * \brief Create a cursor for the currently selected mouse, using the
    1.20 + *        specified bitmap data and mask (in MSB format).
    1.21 + *
    1.22   * The cursor width must be a multiple of 8 bits.
    1.23   *
    1.24   * The cursor is created in black and white according to the following:
    1.25 @@ -119,34 +123,46 @@
    1.26   *  0     0       Transparent
    1.27   *  1     0       Inverted color if possible, black if not.
    1.28   *
    1.29 - * Cursors created with this function must be freed with SDL_FreeCursor().
    1.30 + * \sa SDL_FreeCursor()
    1.31   */
    1.32 -extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor
    1.33 -    (Uint8 * data, Uint8 * mask, int w, int h, int hot_x, int hot_y);
    1.34 +extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
    1.35 +                                                     const Uint8 * mask,
    1.36 +                                                     int w, int h, int hot_x,
    1.37 +                                                     int hot_y);
    1.38  
    1.39  /*
    1.40 - * Set the currently active cursor to the specified one.
    1.41 - * If the cursor is currently visible, the change will be immediately 
    1.42 - * represented on the display.
    1.43 + * \fn void SDL_SetCursor(SDL_Cursor * cursor)
    1.44 + *
    1.45 + * \brief Set the active cursor for the currently selected mouse.
    1.46 + *
    1.47 + * \note The cursor must have been created for the selected mouse.
    1.48   */
    1.49  extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
    1.50  
    1.51  /*
    1.52 - * Returns the currently active cursor.
    1.53 + * \fn SDL_Cursor *SDL_GetCursor(void)
    1.54 + *
    1.55 + * \brief Return the active cursor for the currently selected mouse.
    1.56   */
    1.57  extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
    1.58  
    1.59  /*
    1.60 - * Deallocates a cursor created with SDL_CreateCursor().
    1.61 + * \fn void SDL_FreeCursor(SDL_Cursor * cursor)
    1.62 + *
    1.63 + * \brief Frees a cursor created with SDL_CreateCursor().
    1.64 + *
    1.65 + * \sa SDL_CreateCursor()
    1.66   */
    1.67  extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
    1.68  
    1.69  /*
    1.70 - * Toggle whether or not the cursor is shown on the screen.
    1.71 - * The cursor start off displayed, but can be turned off.
    1.72 - * SDL_ShowCursor() returns 1 if the cursor was being displayed
    1.73 - * before the call, or 0 if it was not.  You can query the current
    1.74 - * state by passing a 'toggle' value of -1.
    1.75 + * \fn int SDL_ShowCursor(int toggle)
    1.76 + *
    1.77 + * \brief Toggle whether or not the cursor is shown for the currently selected mouse.
    1.78 + *
    1.79 + * \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current state.
    1.80 + *
    1.81 + * \return 1 if the cursor is shown, or 0 if the cursor is hidden.
    1.82   */
    1.83  extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
    1.84