include/SDL_shape.h
changeset 4782 b6930aefd008
parent 4781 fc4c775b468a
child 4801 506a9165491b
     1.1 --- a/include/SDL_shape.h	Mon Jun 21 23:08:10 2010 -0400
     1.2 +++ b/include/SDL_shape.h	Wed Jun 30 16:19:44 2010 -0400
     1.3 @@ -114,10 +114,11 @@
     1.4   * \brief Get the shape parameters of a shaped window.
     1.5   *
     1.6   * \param window The shaped window whose parameters should be retrieved.
     1.7 - * \param shapeMode An empty shape-parameters structure to fill.
     1.8 + * \param shapeMode An empty shape-mode structure to fill, or NULL to check whether the window has a shape.
     1.9   *
    1.10 - * \return 0 on success, -1 on a null shapeMode, or -2 if the SDL_Window given is not a shaped window, or -3 if the
    1.11 - *         SDL_Window given is a window that can be shaped but isn't.
    1.12 + * \return 0 if the window has a shape and, provided shapeMode was not NULL, shapeMode has been filled with the mode
    1.13 + *           data, -1 if the SDL_Window given is not a shaped window, or -2 if the SDL_Window* given is a shapeable
    1.14 + *           window currently lacking a shape.
    1.15   *
    1.16   * \sa SDL_WindowShapeMode
    1.17   * \sa SDL_SetWindowShape