Mercurial > sdl-ios-xcode

comparison include/SDL_shape.h @ 4849:0b918c186938

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Finally got the Win32 API code for shaping to work! Just need to fix SDL_CalculateShapeTree() now!
author egottlieb
date Sat, 14 Aug 2010 16:14:36 -0400
parents 4f1573996a65
children
comparison
equal deleted inserted replaced
4848:40b46225e3cf 4849:0b918c186938
110 /** 110 /**
111 * \brief Set the shape and parameters of a shaped window. 111 * \brief Set the shape and parameters of a shaped window.
112 * 112 *
113 * \param window The shaped window whose parameters should be set. 113 * \param window The shaped window whose parameters should be set.
114 * \param shape A surface encoding the desired shape for the window. 114 * \param shape A surface encoding the desired shape for the window.
115 * \param shapeMode The parameters to set for the shaped window. 115 * \param shape_mode The parameters to set for the shaped window.
116 * 116 *
117 * \return 0 on success, SDL_INVALID_SHAPE_ARGUMENT on invalid an invalid shape argument, or SDL_NONSHAPEABLE_WINDOW 117 * \return 0 on success, SDL_INVALID_SHAPE_ARGUMENT on invalid an invalid shape argument, or SDL_NONSHAPEABLE_WINDOW
118 * if the SDL_Window* given does not reference a valid shaped window. 118 * if the SDL_Window* given does not reference a valid shaped window.
119 * 119 *
120 * \sa SDL_WindowShapeMode 120 * \sa SDL_WindowShapeMode
121 * \sa SDL_GetShapedWindowMode. 121 * \sa SDL_GetShapedWindowMode.
122 */ 122 */
123 extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shapeMode); 123 extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
124 124
125 /** 125 /**
126 * \brief Get the shape parameters of a shaped window. 126 * \brief Get the shape parameters of a shaped window.
127 * 127 *
128 * \param window The shaped window whose parameters should be retrieved. 128 * \param window The shaped window whose parameters should be retrieved.
129 * \param shapeMode An empty shape-mode structure to fill, or NULL to check whether the window has a shape. 129 * \param shape_mode An empty shape-mode structure to fill, or NULL to check whether the window has a shape.
130 * 130 *
131 * \return 0 if the window has a shape and, provided shapeMode was not NULL, shapeMode has been filled with the mode 131 * \return 0 if the window has a shape and, provided shape_mode was not NULL, shape_mode has been filled with the mode
132 * data, SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped window, or SDL_WINDOW_LACKS_SHAPE if 132 * data, SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped window, or SDL_WINDOW_LACKS_SHAPE if
133 * the SDL_Window* given is a shapeable window currently lacking a shape. 133 * the SDL_Window* given is a shapeable window currently lacking a shape.
134 * 134 *
135 * \sa SDL_WindowShapeMode 135 * \sa SDL_WindowShapeMode
136 * \sa SDL_SetWindowShape 136 * \sa SDL_SetWindowShape
137 */ 137 */
138 extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shapeMode); 138 extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);
139 139
140 /* Ends C function definitions when using C++ */ 140 /* Ends C function definitions when using C++ */
141 #ifdef __cplusplus 141 #ifdef __cplusplus
142 /* *INDENT-OFF* */ 142 /* *INDENT-OFF* */
143 } 143 }