Mercurial > sdl-ios-xcode

comparison include/SDL_surface.h @ 4971:158bb5752974

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated headers to match wiki documentation
author Sam Lantinga <slouken@libsdl.org>
date Wed, 12 Jan 2011 09:47:33 -0800
parents 68da5a234bba
children da10636e5eca
comparison
equal deleted inserted replaced
4970:b9eed029844a 4971:158bb5752974
159 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface); 159 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
160 /** \sa SDL_LockSurface() */ 160 /** \sa SDL_LockSurface() */
161 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface); 161 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
162 162
163 /** 163 /**
164 * Load a surface from a seekable SDL data source (memory or file). 164 * Load a surface from a seekable SDL data stream (memory or file).
165 * 165 *
166 * If \c freesrc is non-zero, the source will be closed after being read. 166 * If \c freesrc is non-zero, the stream will be closed after being read.
167 * 167 *
168 * The new surface should be freed with SDL_FreeSurface(). 168 * The new surface should be freed with SDL_FreeSurface().
169 * 169 *
170 * \return the new surface, or NULL if there was an error. 170 * \return the new surface, or NULL if there was an error.
171 */ 171 */
178 * Convenience macro. 178 * Convenience macro.
179 */ 179 */
180 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1) 180 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
181 181
182 /** 182 /**
183 * Save a surface to a seekable SDL data source (memory or file). 183 * Save a surface to a seekable SDL data stream (memory or file).
184 * 184 *
185 * If \c freedst is non-zero, the source will be closed after being written. 185 * If \c freedst is non-zero, the stream will be closed after being written.
186 * 186 *
187 * \return 0 if successful or -1 if there was an error. 187 * \return 0 if successful or -1 if there was an error.
188 */ 188 */
189 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW 189 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
190 (SDL_Surface * surface, SDL_RWops * dst, int freedst); 190 (SDL_Surface * surface, SDL_RWops * dst, int freedst);
235 235
236 /** 236 /**
237 * \brief Set an additional color value used in blit operations. 237 * \brief Set an additional color value used in blit operations.
238 * 238 *
239 * \param surface The surface to update. 239 * \param surface The surface to update.
240 * \param r The red source color value multiplied into blit operations. 240 * \param r The red color value multiplied into blit operations.
241 * \param g The green source color value multiplied into blit operations. 241 * \param g The green color value multiplied into blit operations.
242 * \param b The blue source color value multiplied into blit operations. 242 * \param b The blue color value multiplied into blit operations.
243 * 243 *
244 * \return 0 on success, or -1 if the surface is not valid. 244 * \return 0 on success, or -1 if the surface is not valid.
245 * 245 *
246 * \sa SDL_GetSurfaceColorMod() 246 * \sa SDL_GetSurfaceColorMod()
247 */ 247 */
251 251
252 /** 252 /**
253 * \brief Get the additional color value used in blit operations. 253 * \brief Get the additional color value used in blit operations.
254 * 254 *
255 * \param surface The surface to query. 255 * \param surface The surface to query.
256 * \param r A pointer filled in with the source red color value. 256 * \param r A pointer filled in with the current red color value.
257 * \param g A pointer filled in with the source green color value. 257 * \param g A pointer filled in with the current green color value.
258 * \param b A pointer filled in with the source blue color value. 258 * \param b A pointer filled in with the current blue color value.
259 * 259 *
260 * \return 0 on success, or -1 if the surface is not valid. 260 * \return 0 on success, or -1 if the surface is not valid.
261 * 261 *
262 * \sa SDL_SetSurfaceColorMod() 262 * \sa SDL_SetSurfaceColorMod()
263 */ 263 */
267 267
268 /** 268 /**
269 * \brief Set an additional alpha value used in blit operations. 269 * \brief Set an additional alpha value used in blit operations.
270 * 270 *
271 * \param surface The surface to update. 271 * \param surface The surface to update.
272 * \param alpha The source alpha value multiplied into blit operations. 272 * \param alpha The alpha value multiplied into blit operations.
273 * 273 *
274 * \return 0 on success, or -1 if the surface is not valid. 274 * \return 0 on success, or -1 if the surface is not valid.
275 * 275 *
276 * \sa SDL_GetSurfaceAlphaMod() 276 * \sa SDL_GetSurfaceAlphaMod()
277 */ 277 */
280 280
281 /** 281 /**
282 * \brief Get the additional alpha value used in blit operations. 282 * \brief Get the additional alpha value used in blit operations.
283 * 283 *
284 * \param surface The surface to query. 284 * \param surface The surface to query.
285 * \param alpha A pointer filled in with the source alpha value. 285 * \param alpha A pointer filled in with the current alpha value.
286 * 286 *
287 * \return 0 on success, or -1 if the surface is not valid. 287 * \return 0 on success, or -1 if the surface is not valid.
288 * 288 *
289 * \sa SDL_SetSurfaceAlphaMod() 289 * \sa SDL_SetSurfaceAlphaMod()
290 */ 290 */