Mercurial > sdl-ios-xcode
diff include/SDL_shape.h @ 4782:b6930aefd008
Finished X11 shaped-window functionality and removed ellipse+polygon rendering.
author | Eli Gottlieb <eligottlieb@gmail.com> |
---|---|
date | Wed, 30 Jun 2010 16:19:44 -0400 |
parents | fc4c775b468a |
children | 506a9165491b |
line wrap: on
line diff
--- a/include/SDL_shape.h Mon Jun 21 23:08:10 2010 -0400 +++ b/include/SDL_shape.h Wed Jun 30 16:19:44 2010 -0400 @@ -114,10 +114,11 @@ * \brief Get the shape parameters of a shaped window. * * \param window The shaped window whose parameters should be retrieved. - * \param shapeMode An empty shape-parameters structure to fill. + * \param shapeMode An empty shape-mode structure to fill, or NULL to check whether the window has a shape. * - * \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 - * SDL_Window given is a window that can be shaped but isn't. + * \return 0 if the window has a shape and, provided shapeMode was not NULL, shapeMode has been filled with the mode + * data, -1 if the SDL_Window given is not a shaped window, or -2 if the SDL_Window* given is a shapeable + * window currently lacking a shape. * * \sa SDL_WindowShapeMode * \sa SDL_SetWindowShape