extras/physfsrwops.h
changeset 123 53305c50c541
child 132 b53fa5093749
equal deleted inserted replaced
122:402ee2bf165c 123:53305c50c541
       
     1 /*
       
     2  * This code provides a glue layer between PhysicsFS and Simple Directmedia
       
     3  *  Layer's (SDL) RWops i/o abstraction.
       
     4  *
       
     5  * License: this code is public domain. I make no warranty that it is useful,
       
     6  *  correct, harmless, or environmentally safe.
       
     7  *
       
     8  * This particular file may be used however you like, including copying it
       
     9  *  verbatim into a closed-source project, exploiting it commercially, and
       
    10  *  removing any trace of my name from the source (although I hope you won't
       
    11  *  do that). I welcome enhancements and corrections to this file, but I do
       
    12  *  not require you to send me patches if you make changes.
       
    13  *
       
    14  * Unless otherwise stated, the rest of PhysicsFS falls under the GNU Lesser
       
    15  *  General Public License: http://www.gnu.org/licenses/lgpl.txt
       
    16  *
       
    17  * SDL falls under the LGPL, too. You can get SDL at http://www.libsdl.org/
       
    18  *
       
    19  *  This file was written by Ryan C. Gordon. (icculus@clutteredmind.org).
       
    20  */
       
    21 
       
    22 #ifndef _INCLUDE_PHYSFSRWOPS_H_
       
    23 #define _INCLUDE_PHYSFSRWOPS_H_
       
    24 
       
    25 #include "physfs.h"
       
    26 #include "SDL.h"
       
    27 
       
    28 #ifdef __cplusplus
       
    29 extern "C" {
       
    30 #endif
       
    31 
       
    32 #if (defined _MSC_VER)
       
    33 #define __EXPORT__ __declspec(dllexport)
       
    34 #else
       
    35 #define __EXPORT__
       
    36 #endif
       
    37 
       
    38 /**
       
    39  * Open a platform-independent filename for reading, and make it accessible
       
    40  *  via an SDL_RWops structure. The file will be closed in PhysicsFS when the
       
    41  *  RWops is closed. PhysicsFS should be configured to your liking before
       
    42  *  opening files through this method.
       
    43  *
       
    44  *   @param filename File to open in platform-independent notation.
       
    45  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
       
    46  *           of the error can be gleaned from PHYSFS_getLastError().
       
    47  */
       
    48 __EXPORT__ SDL_RWops *PHYSFSRWOPS_openRead(const char *fname);
       
    49 
       
    50 /**
       
    51  * Open a platform-independent filename for writing, and make it accessible
       
    52  *  via an SDL_RWops structure. The file will be closed in PhysicsFS when the
       
    53  *  RWops is closed. PhysicsFS should be configured to your liking before
       
    54  *  opening files through this method.
       
    55  *
       
    56  *   @param filename File to open in platform-independent notation.
       
    57  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
       
    58  *           of the error can be gleaned from PHYSFS_getLastError().
       
    59  */
       
    60 __EXPORT__ SDL_RWops *PHYSFSRWOPS_openWrite(const char *fname);
       
    61 
       
    62 /**
       
    63  * Open a platform-independent filename for appending, and make it accessible
       
    64  *  via an SDL_RWops structure. The file will be closed in PhysicsFS when the
       
    65  *  RWops is closed. PhysicsFS should be configured to your liking before
       
    66  *  opening files through this method.
       
    67  *
       
    68  *   @param filename File to open in platform-independent notation.
       
    69  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
       
    70  *           of the error can be gleaned from PHYSFS_getLastError().
       
    71  */
       
    72 __EXPORT__ SDL_RWops *PHYSFSRWOPS_openAppend(const char *fname);
       
    73 
       
    74 /**
       
    75  * Make a SDL_RWops from an existing PhysicsFS file handle. You should
       
    76  *  dispose of any references to the handle after successful creation of
       
    77  *  the RWops. The actual PhysicsFS handle will be destroyed when the
       
    78  *  RWops is closed.
       
    79  *
       
    80  *   @param handle a valid PhysicsFS file handle.
       
    81  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
       
    82  *           of the error can be gleaned from PHYSFS_getLastError().
       
    83  */
       
    84 __EXPORT__ SDL_RWops *PHYSFSRWOPS_makeRWops(PHYSFS_file *handle);
       
    85 
       
    86 #ifdef __cplusplus
       
    87 }
       
    88 #endif
       
    89 
       
    90 #endif /* include-once blocker */
       
    91 
       
    92 /* end of physfsrwops.h ... */
       
    93