physfsrwops.h File Reference

#include "physfs.h"
#include "SDL.h"

Include dependency graph for physfsrwops.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
__EXPORT__ SDL_RWops *	PHYSFSRWOPS_openRead (const char *fname)
	Open a platform-independent filename for reading, and make it accessible via an SDL_RWops structure.
__EXPORT__ SDL_RWops *	PHYSFSRWOPS_openWrite (const char *fname)
	Open a platform-independent filename for writing, and make it accessible via an SDL_RWops structure.
__EXPORT__ SDL_RWops *	PHYSFSRWOPS_openAppend (const char *fname)
	Open a platform-independent filename for appending, and make it accessible via an SDL_RWops structure.
__EXPORT__ SDL_RWops *	PHYSFSRWOPS_makeRWops (PHYSFS_file *handle)
	Make a SDL_RWops from an existing PhysicsFS file handle.

---

Function Documentation

__EXPORT__ SDL_RWops* PHYSFSRWOPS_makeRWops (  PHYSFS_file *  handle  )

Make a SDL_RWops from an existing PhysicsFS file handle. You should dispose of any references to the handle after successful creation of the RWops. The actual PhysicsFS handle will be destroyed when the RWops is closed. Parameters: handle  a valid PhysicsFS file handle. Returns: A valid SDL_RWops structure on success, NULL on error. Specifics of the error can be gleaned from PHYSFS_getLastError(). Definition at line 142 of file physfsrwops.cpp. References create_rwops().

__EXPORT__ SDL_RWops* PHYSFSRWOPS_openAppend (  const char *  fname  )

Open a platform-independent filename for appending, and make it accessible via an SDL_RWops structure. The file will be closed in PhysicsFS when the RWops is closed. PhysicsFS should be configured to your liking before opening files through this method. Parameters: filename  File to open in platform-independent notation. Returns: A valid SDL_RWops structure on success, NULL on error. Specifics of the error can be gleaned from PHYSFS_getLastError(). Definition at line 163 of file physfsrwops.cpp. References create_rwops(). Referenced by PG_FileArchive::OpenFileRWops().

__EXPORT__ SDL_RWops* PHYSFSRWOPS_openRead (  const char *  fname  )

Open a platform-independent filename for reading, and make it accessible via an SDL_RWops structure. The file will be closed in PhysicsFS when the RWops is closed. PhysicsFS should be configured to your liking before opening files through this method. Parameters: filename  File to open in platform-independent notation. Returns: A valid SDL_RWops structure on success, NULL on error. Specifics of the error can be gleaned from PHYSFS_getLastError(). Definition at line 153 of file physfsrwops.cpp. References create_rwops(). Referenced by PG_FileArchive::OpenFileRWops().

__EXPORT__ SDL_RWops* PHYSFSRWOPS_openWrite (  const char *  fname  )

Open a platform-independent filename for writing, and make it accessible via an SDL_RWops structure. The file will be closed in PhysicsFS when the RWops is closed. PhysicsFS should be configured to your liking before opening files through this method. Parameters: filename  File to open in platform-independent notation. Returns: A valid SDL_RWops structure on success, NULL on error. Specifics of the error can be gleaned from PHYSFS_getLastError(). Definition at line 158 of file physfsrwops.cpp. References create_rwops(). Referenced by PG_FileArchive::OpenFileRWops().

---