misc/libphyslayer/physfsrwops.h
changeset 13538 f8c0a62fa3ac
parent 10129 cd2a64a1f4aa
child 15853 fcea0f51d94f
equal deleted inserted replaced
13537:ecdf6ce2301e 13538:f8c0a62fa3ac
    39  *  RWops is closed. PhysicsFS should be configured to your liking before
    39  *  RWops is closed. PhysicsFS should be configured to your liking before
    40  *  opening files through this method.
    40  *  opening files through this method.
    41  *
    41  *
    42  *   @param filename File to open in platform-independent notation.
    42  *   @param filename File to open in platform-independent notation.
    43  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    43  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    44  *           of the error can be gleaned from PHYSFS_getLastError().
    44  *           of the error can be gleaned from PHYSFS_getLastErrorCode().
    45  */
    45  */
    46 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_openRead(const char *fname);
    46 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_openRead(const char *fname);
    47 
    47 
    48 /**
    48 /**
    49  * Open a platform-independent filename for writing, and make it accessible
    49  * Open a platform-independent filename for writing, and make it accessible
    51  *  RWops is closed. PhysicsFS should be configured to your liking before
    51  *  RWops is closed. PhysicsFS should be configured to your liking before
    52  *  opening files through this method.
    52  *  opening files through this method.
    53  *
    53  *
    54  *   @param filename File to open in platform-independent notation.
    54  *   @param filename File to open in platform-independent notation.
    55  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    55  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    56  *           of the error can be gleaned from PHYSFS_getLastError().
    56  *           of the error can be gleaned from PHYSFS_getLastErrorCode().
    57  */
    57  */
    58 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_openWrite(const char *fname);
    58 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_openWrite(const char *fname);
    59 
    59 
    60 /**
    60 /**
    61  * Open a platform-independent filename for appending, and make it accessible
    61  * Open a platform-independent filename for appending, and make it accessible
    63  *  RWops is closed. PhysicsFS should be configured to your liking before
    63  *  RWops is closed. PhysicsFS should be configured to your liking before
    64  *  opening files through this method.
    64  *  opening files through this method.
    65  *
    65  *
    66  *   @param filename File to open in platform-independent notation.
    66  *   @param filename File to open in platform-independent notation.
    67  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    67  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    68  *           of the error can be gleaned from PHYSFS_getLastError().
    68  *           of the error can be gleaned from PHYSFS_getLastErrorCode().
    69  */
    69  */
    70 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_openAppend(const char *fname);
    70 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_openAppend(const char *fname);
    71 
    71 
    72 /**
    72 /**
    73  * Make a SDL_RWops from an existing PhysicsFS file handle. You should
    73  * Make a SDL_RWops from an existing PhysicsFS file handle. You should
    75  *  the RWops. The actual PhysicsFS handle will be destroyed when the
    75  *  the RWops. The actual PhysicsFS handle will be destroyed when the
    76  *  RWops is closed.
    76  *  RWops is closed.
    77  *
    77  *
    78  *   @param handle a valid PhysicsFS file handle.
    78  *   @param handle a valid PhysicsFS file handle.
    79  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    79  *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
    80  *           of the error can be gleaned from PHYSFS_getLastError().
    80  *           of the error can be gleaned from PHYSFS_getLastErrorCode().
    81  */
    81  */
    82 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_makeRWops(PHYSFS_File *handle);
    82 PHYSFS_DECL SDL_RWops *PHYSFSRWOPS_makeRWops(PHYSFS_File *handle);
    83 
    83 
    84 #ifdef __cplusplus
    84 #ifdef __cplusplus
    85 }
    85 }