Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
L
libSDL
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PocketInsanity
libSDL
Commits
a8c8dc3e
Commit
a8c8dc3e
authored
Jan 12, 2011
by
Sam Lantinga
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated headers to match wiki documentation
parent
baf0c994
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
27 additions
and
27 deletions
+27
-27
SDL_events.h
include/SDL_events.h
+2
-2
SDL_rwops.h
include/SDL_rwops.h
+5
-5
SDL_surface.h
include/SDL_surface.h
+12
-12
SDL_video.h
include/SDL_video.h
+8
-8
No files found.
include/SDL_events.h
View file @
a8c8dc3e
...
@@ -66,8 +66,8 @@ typedef enum
...
@@ -66,8 +66,8 @@ typedef enum
SDL_SYSWMEVENT
,
/**< System specific event */
SDL_SYSWMEVENT
,
/**< System specific event */
/* Keyboard events */
/* Keyboard events */
SDL_KEYDOWN
=
0x300
,
/**< Key
s
pressed */
SDL_KEYDOWN
=
0x300
,
/**< Key pressed */
SDL_KEYUP
,
/**< Key
s
released */
SDL_KEYUP
,
/**< Key released */
SDL_TEXTEDITING
,
/**< Keyboard text editing (composition) */
SDL_TEXTEDITING
,
/**< Keyboard text editing (composition) */
SDL_TEXTINPUT
,
/**< Keyboard text input */
SDL_TEXTINPUT
,
/**< Keyboard text input */
...
...
include/SDL_rwops.h
View file @
a8c8dc3e
...
@@ -24,7 +24,7 @@
...
@@ -24,7 +24,7 @@
* \file SDL_rwops.h
* \file SDL_rwops.h
*
*
* This file provides a general interface for SDL to read and write
* This file provides a general interface for SDL to read and write
* data s
ource
s. It can easily be extended to files, memory, etc.
* data s
tream
s. It can easily be extended to files, memory, etc.
*/
*/
#ifndef _SDL_rwops_h
#ifndef _SDL_rwops_h
...
@@ -50,14 +50,14 @@ typedef struct SDL_RWops
...
@@ -50,14 +50,14 @@ typedef struct SDL_RWops
* Seek to \c offset relative to \c whence, one of stdio's whence values:
* Seek to \c offset relative to \c whence, one of stdio's whence values:
* RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
* RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
*
*
* \return the final offset in the data s
ource
.
* \return the final offset in the data s
tream
.
*/
*/
long
(
SDLCALL
*
seek
)
(
struct
SDL_RWops
*
context
,
long
offset
,
long
(
SDLCALL
*
seek
)
(
struct
SDL_RWops
*
context
,
long
offset
,
int
whence
);
int
whence
);
/**
/**
* Read up to \c maxnum objects each of size \c size from the data
* Read up to \c maxnum objects each of size \c size from the data
* s
ource
to the area pointed at by \c ptr.
* s
tream
to the area pointed at by \c ptr.
*
*
* \return the number of objects read, or 0 at error or end of file.
* \return the number of objects read, or 0 at error or end of file.
*/
*/
...
@@ -66,7 +66,7 @@ typedef struct SDL_RWops
...
@@ -66,7 +66,7 @@ typedef struct SDL_RWops
/**
/**
* Write exactly \c num objects each of size \c size from the area
* Write exactly \c num objects each of size \c size from the area
* pointed at by \c ptr to data s
ource
.
* pointed at by \c ptr to data s
tream
.
*
*
* \return the number of objects written, or 0 at error or end of file.
* \return the number of objects written, or 0 at error or end of file.
*/
*/
...
@@ -121,7 +121,7 @@ typedef struct SDL_RWops
...
@@ -121,7 +121,7 @@ typedef struct SDL_RWops
/**
/**
* \name RWFrom functions
* \name RWFrom functions
*
*
* Functions to create SDL_RWops structures from various data s
ource
s.
* Functions to create SDL_RWops structures from various data s
tream
s.
*/
*/
/*@{*/
/*@{*/
...
...
include/SDL_surface.h
View file @
a8c8dc3e
...
@@ -161,9 +161,9 @@ extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
...
@@ -161,9 +161,9 @@ extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
extern
DECLSPEC
void
SDLCALL
SDL_UnlockSurface
(
SDL_Surface
*
surface
);
extern
DECLSPEC
void
SDLCALL
SDL_UnlockSurface
(
SDL_Surface
*
surface
);
/**
/**
* Load a surface from a seekable SDL data s
ource
(memory or file).
* Load a surface from a seekable SDL data s
tream
(memory or file).
*
*
* If \c freesrc is non-zero, the s
ource
will be closed after being read.
* If \c freesrc is non-zero, the s
tream
will be closed after being read.
*
*
* The new surface should be freed with SDL_FreeSurface().
* The new surface should be freed with SDL_FreeSurface().
*
*
...
@@ -180,9 +180,9 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src,
...
@@ -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)
#define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
/**
/**
* Save a surface to a seekable SDL data s
ource
(memory or file).
* Save a surface to a seekable SDL data s
tream
(memory or file).
*
*
* If \c freedst is non-zero, the s
ource
will be closed after being written.
* If \c freedst is non-zero, the s
tream
will be closed after being written.
*
*
* \return 0 if successful or -1 if there was an error.
* \return 0 if successful or -1 if there was an error.
*/
*/
...
@@ -237,9 +237,9 @@ extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
...
@@ -237,9 +237,9 @@ extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
* \brief Set an additional color value used in blit operations.
* \brief Set an additional color value used in blit operations.
*
*
* \param surface The surface to update.
* \param surface The surface to update.
* \param r The red
source
color value multiplied into blit operations.
* \param r The red color value multiplied into blit operations.
* \param g The green
source
color value multiplied into blit operations.
* \param g The green color value multiplied into blit operations.
* \param b The blue
source
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.
* \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,
...
@@ -253,9 +253,9 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface,
* \brief Get the additional color value used in blit operations.
* \brief Get the additional color value used in blit operations.
*
*
* \param surface The surface to query.
* \param surface The surface to query.
* \param r A pointer filled in with the
source
red color value.
* \param r A pointer filled in with the
current
red color value.
* \param g A pointer filled in with the
source
green color value.
* \param g A pointer filled in with the
current
green color value.
* \param b A pointer filled in with the
source
blue 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.
* \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,
...
@@ -269,7 +269,7 @@ extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface,
* \brief Set an additional alpha value used in blit operations.
* \brief Set an additional alpha value used in blit operations.
*
*
* \param surface The surface to update.
* \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.
* \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,
...
@@ -282,7 +282,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface,
* \brief Get the additional alpha value used in blit operations.
* \brief Get the additional alpha value used in blit operations.
*
*
* \param surface The surface to query.
* \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.
* \return 0 on success, or -1 if the surface is not valid.
*
*
...
...
include/SDL_video.h
View file @
a8c8dc3e
...
@@ -885,9 +885,9 @@ extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_Texture * texture,
...
@@ -885,9 +885,9 @@ extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_Texture * texture,
* \brief Set an additional color value used in render copy operations.
* \brief Set an additional color value used in render copy operations.
*
*
* \param texture The texture to update.
* \param texture The texture to update.
* \param r The red
source
color value multiplied into copy operations.
* \param r The red color value multiplied into copy operations.
* \param g The green
source
color value multiplied into copy operations.
* \param g The green color value multiplied into copy operations.
* \param b The blue
source
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
* \return 0 on success, or -1 if the texture is not valid or color modulation
* is not supported.
* is not supported.
...
@@ -902,9 +902,9 @@ extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
...
@@ -902,9 +902,9 @@ extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
* \brief Get the additional color value used in render copy operations.
* \brief Get the additional color value used in render copy operations.
*
*
* \param texture The texture to query.
* \param texture The texture to query.
* \param r A pointer filled in with the
source
red color value.
* \param r A pointer filled in with the
current
red color value.
* \param g A pointer filled in with the
source
green color value.
* \param g A pointer filled in with the
current
green color value.
* \param b A pointer filled in with the
source
blue 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.
* \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,
...
@@ -918,7 +918,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
* \brief Set an additional alpha value used in render copy operations.
* \brief Set an additional alpha value used in render copy operations.
*
*
* \param texture The texture to update.
* \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
* \return 0 on success, or -1 if the texture is not valid or alpha modulation
* is not supported.
* is not supported.
...
@@ -932,7 +932,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
...
@@ -932,7 +932,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
* \brief Get the additional alpha value used in render copy operations.
* \brief Get the additional alpha value used in render copy operations.
*
*
* \param texture The texture to query.
* \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.
* \return 0 on success, or -1 if the texture is not valid.
*
*
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment