1106b669a6
Ken Bull 2009-02-25 13:22:02 PST Adds Doxygen support for all headers (except config and boilerplate headers) in the include folder for SDL-1.2 revision 4446. While in general SDL is quite thoroughly commented, none of these comments are correctly formatted for Doxygen and are generally inconsistent in their formatting. --HG-- branch : SDL-1.2 extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/branches/SDL-1.2%403857
78 lines
2.7 KiB
C
78 lines
2.7 KiB
C
/*
|
|
SDL - Simple DirectMedia Layer
|
|
Copyright (C) 1997-2009 Sam Lantinga
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
Sam Lantinga
|
|
slouken@libsdl.org
|
|
*/
|
|
|
|
/** @file SDL_loadso.h
|
|
* System dependent library loading routines
|
|
*/
|
|
|
|
/** @file SDL_loadso.h
|
|
* Some things to keep in mind:
|
|
* - These functions only work on C function names. Other languages may
|
|
* have name mangling and intrinsic language support that varies from
|
|
* compiler to compiler.
|
|
* - Make sure you declare your function pointers with the same calling
|
|
* convention as the actual library function. Your code will crash
|
|
* mysteriously if you do not do this.
|
|
* - Avoid namespace collisions. If you load a symbol from the library,
|
|
* it is not defined whether or not it goes into the global symbol
|
|
* namespace for the application. If it does and it conflicts with
|
|
* symbols in your code or other shared libraries, you will not get
|
|
* the results you expect. :)
|
|
*/
|
|
|
|
|
|
#ifndef _SDL_loadso_h
|
|
#define _SDL_loadso_h
|
|
|
|
#include "SDL_stdinc.h"
|
|
#include "SDL_error.h"
|
|
|
|
#include "begin_code.h"
|
|
/* Set up for C function definitions, even when using C++ */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* This function dynamically loads a shared object and returns a pointer
|
|
* to the object handle (or NULL if there was an error).
|
|
* The 'sofile' parameter is a system dependent name of the object file.
|
|
*/
|
|
extern DECLSPEC void * SDLCALL SDL_LoadObject(const char *sofile);
|
|
|
|
/**
|
|
* Given an object handle, this function looks up the address of the
|
|
* named function in the shared object and returns it. This address
|
|
* is no longer valid after calling SDL_UnloadObject().
|
|
*/
|
|
extern DECLSPEC void * SDLCALL SDL_LoadFunction(void *handle, const char *name);
|
|
|
|
/** Unload a shared object from memory */
|
|
extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#include "close_code.h"
|
|
|
|
#endif /* _SDL_loadso_h */
|