Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
Updated headers to match wiki documentation
  • Loading branch information
slouken committed Jan 12, 2011
1 parent f9adc1f commit 21c4f06b800aaf2c4fb5cff760822ae4b147ea9b
Showing with 27 additions and 27 deletions.
  1. +2 −2 include/SDL_events.h
  2. +5 −5 include/SDL_rwops.h
  3. +12 −12 include/SDL_surface.h
  4. +8 −8 include/SDL_video.h
@@ -66,8 +66,8 @@ typedef enum
SDL_SYSWMEVENT, /**< System specific event */

/* Keyboard events */
SDL_KEYDOWN = 0x300, /**< Keys pressed */
SDL_KEYUP, /**< Keys released */
SDL_KEYDOWN = 0x300, /**< Key pressed */
SDL_KEYUP, /**< Key released */
SDL_TEXTEDITING, /**< Keyboard text editing (composition) */
SDL_TEXTINPUT, /**< Keyboard text input */

@@ -24,7 +24,7 @@
* \file SDL_rwops.h
*
* This file provides a general interface for SDL to read and write
* data sources. It can easily be extended to files, memory, etc.
* data streams. It can easily be extended to files, memory, etc.
*/

#ifndef _SDL_rwops_h
@@ -50,14 +50,14 @@ typedef struct SDL_RWops
* Seek to \c offset relative to \c whence, one of stdio's whence values:
* RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
*
* \return the final offset in the data source.
* \return the final offset in the data stream.
*/
long (SDLCALL * seek) (struct SDL_RWops * context, long offset,
int whence);

/**
* Read up to \c maxnum objects each of size \c size from the data
* source to the area pointed at by \c ptr.
* stream to the area pointed at by \c ptr.
*
* \return the number of objects read, or 0 at error or end of file.
*/
@@ -66,7 +66,7 @@ typedef struct SDL_RWops

/**
* Write exactly \c num objects each of size \c size from the area
* pointed at by \c ptr to data source.
* pointed at by \c ptr to data stream.
*
* \return the number of objects written, or 0 at error or end of file.
*/
@@ -121,7 +121,7 @@ typedef struct SDL_RWops
/**
* \name RWFrom functions
*
* Functions to create SDL_RWops structures from various data sources.
* Functions to create SDL_RWops structures from various data streams.
*/
/*@{*/

@@ -161,9 +161,9 @@ extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);

/**
* Load a surface from a seekable SDL data source (memory or file).
* Load a surface from a seekable SDL data stream (memory or file).
*
* If \c freesrc is non-zero, the source will be closed after being read.
* If \c freesrc is non-zero, the stream will be closed after being read.
*
* The new surface should be freed with SDL_FreeSurface().
*
@@ -180,9 +180,9 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src,
#define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)

/**
* Save a surface to a seekable SDL data source (memory or file).
* Save a surface to a seekable SDL data stream (memory or file).
*
* If \c freedst is non-zero, the source will be closed after being written.
* If \c freedst is non-zero, the stream will be closed after being written.
*
* \return 0 if successful or -1 if there was an error.
*/
@@ -237,9 +237,9 @@ extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
* \brief Set an additional color value used in blit operations.
*
* \param surface The surface to update.
* \param r The red source color value multiplied into blit operations.
* \param g The green source color value multiplied into blit operations.
* \param b The blue source color value multiplied into blit operations.
* \param r The red color value multiplied into blit operations.
* \param g The green color value multiplied into blit operations.
* \param b The blue color value multiplied into blit operations.
*
* \return 0 on success, or -1 if the surface is not valid.
*
@@ -253,9 +253,9 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface,
* \brief Get the additional color value used in blit operations.
*
* \param surface The surface to query.
* \param r A pointer filled in with the source red color value.
* \param g A pointer filled in with the source green color value.
* \param b A pointer filled in with the source blue color value.
* \param r A pointer filled in with the current red color value.
* \param g A pointer filled in with the current green color value.
* \param b A pointer filled in with the current blue color value.
*
* \return 0 on success, or -1 if the surface is not valid.
*
@@ -269,7 +269,7 @@ extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface,
* \brief Set an additional alpha value used in blit operations.
*
* \param surface The surface to update.
* \param alpha The source alpha value multiplied into blit operations.
* \param alpha The alpha value multiplied into blit operations.
*
* \return 0 on success, or -1 if the surface is not valid.
*
@@ -282,7 +282,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface,
* \brief Get the additional alpha value used in blit operations.
*
* \param surface The surface to query.
* \param alpha A pointer filled in with the source alpha value.
* \param alpha A pointer filled in with the current alpha value.
*
* \return 0 on success, or -1 if the surface is not valid.
*
@@ -885,9 +885,9 @@ extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_Texture * texture,
* \brief Set an additional color value used in render copy operations.
*
* \param texture The texture to update.
* \param r The red source color value multiplied into copy operations.
* \param g The green source color value multiplied into copy operations.
* \param b The blue source color value multiplied into copy operations.
* \param r The red color value multiplied into copy operations.
* \param g The green color value multiplied into copy operations.
* \param b The blue color value multiplied into copy operations.
*
* \return 0 on success, or -1 if the texture is not valid or color modulation
* is not supported.
@@ -902,9 +902,9 @@ extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
* \brief Get the additional color value used in render copy operations.
*
* \param texture The texture to query.
* \param r A pointer filled in with the source red color value.
* \param g A pointer filled in with the source green color value.
* \param b A pointer filled in with the source blue color value.
* \param r A pointer filled in with the current red color value.
* \param g A pointer filled in with the current green color value.
* \param b A pointer filled in with the current blue color value.
*
* \return 0 on success, or -1 if the texture is not valid.
*
@@ -918,7 +918,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
* \brief Set an additional alpha value used in render copy operations.
*
* \param texture The texture to update.
* \param alpha The source alpha value multiplied into copy operations.
* \param alpha The alpha value multiplied into copy operations.
*
* \return 0 on success, or -1 if the texture is not valid or alpha modulation
* is not supported.
@@ -932,7 +932,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
* \brief Get the additional alpha value used in render copy operations.
*
* \param texture The texture to query.
* \param alpha A pointer filled in with the source alpha value.
* \param alpha A pointer filled in with the current alpha value.
*
* \return 0 on success, or -1 if the texture is not valid.
*

0 comments on commit 21c4f06

Please sign in to comment.