pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarified inline function documentation, removed obsolete Metrowerks compiler directive.

Browse source
This commit is contained in:
Sam Lantinga 2013-03-14 23:10:51 -07:00
parent a26645f7b1
commit 6ea7a3490d
1 changed files with 6 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

18
include/SDL_stdinc.h
View file

@ -175,10 +175,6 @@ SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
enums having the size of an int must be enabled. enums having the size of an int must be enabled.
This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11). This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
*/ */
/* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
#ifdef __MWERKS__
#pragma enumsalwaysint on
#endif
/** \cond */ /** \cond */
#ifndef DOXYGEN_SHOULD_IGNORE_THIS #ifndef DOXYGEN_SHOULD_IGNORE_THIS
@ -239,14 +235,12 @@ char *alloca();
/* SDL stdinc inline functions: /* SDL stdinc inline functions:
The theory here is that, by default, we forcibly inline what we can--with The theory here is that by default we forcibly inline what we can, and your
real inline functions that avoid macro side-effects--and your app will use app will use the inline version by default. However we expose a non-inline
the inline version by default. However, we expose a non-inline version version too, so the symbol is always available in the library even if your app
too, which internally just wraps the inline version in a real function, bypassed the inline version. The SDL_*_inline versions aren't guaranteed to
so the symbol is always available in the library even if your app exist, so never call them directly; use SDL_* instead, and trust the system
bypassed it with the inline version. The SDL_*_inline versions aren't to give you the right thing.
guaranteed to exist, so never call them directly; use SDL_* instead,
and trust the system to give you the right thing.
The benefit here is that you can dlsym() these functions, which you The benefit here is that you can dlsym() these functions, which you
couldn't if you had macros, you can link against a foreign build of SDL couldn't if you had macros, you can link against a foreign build of SDL