Blender: BKE_packedFile.h Source File

Blender V2.59
00001 /*
00002  * $Id: BKE_packedFile.h 34962 2011-02-18 13:05:18Z jesterking $ 
00003  *
00004  * ***** BEGIN GPL LICENSE BLOCK *****
00005  *
00006  * This program is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU General Public License
00008  * as published by the Free Software Foundation; either version 2
00009  * of the License, or (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software Foundation,
00018  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00019  *
00020  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
00021  * All rights reserved.
00022  *
00023  * The Original Code is: all of this file.
00024  *
00025  * Contributor(s): none yet.
00026  *
00027  * ***** END GPL LICENSE BLOCK *****
00028  */
00029 #ifndef BKE_PACKEDFILE_H
00030 #define BKE_PACKEDFILE_H
00031 
00037 #define RET_OK          0
00038 #define RET_ERROR       1
00039 
00040 struct bSound;
00041 struct Image;
00042 struct Main;
00043 struct PackedFile;
00044 struct ReportList;
00045 struct VFont;
00046 
00047 /* pack */
00048 struct PackedFile *newPackedFile(struct ReportList *reports, const char *filename);
00049 struct PackedFile *newPackedFileMemory(void *mem, int memlen);
00050 
00051 void packAll(struct Main *bmain, struct ReportList *reports);
00052 
00053 /* unpack */
00054 char *unpackFile(struct ReportList *reports, char *abs_name, char *local_name, struct PackedFile *pf, int how);
00055 int unpackVFont(struct ReportList *reports, struct VFont *vfont, int how);
00056 int unpackSound(struct Main *bmain, struct ReportList *reports, struct bSound *sound, int how);
00057 int unpackImage(struct ReportList *reports, struct Image *ima, int how);
00058 void unpackAll(struct Main *bmain, struct ReportList *reports, int how);
00059 
00060 int writePackedFile(struct ReportList *reports, const char *filename, struct PackedFile *pf, int guimode);
00061 
00062 /* free */
00063 void freePackedFile(struct PackedFile *pf);
00064 
00065 /* info */
00066 int countPackedFiles(struct Main *bmain);
00067 int checkPackedFile(const char *filename, struct PackedFile *pf);
00068 
00069 /* read */
00070 int seekPackedFile(struct PackedFile *pf, int offset, int whence);
00071 void rewindPackedFile(struct PackedFile *pf);
00072 int readPackedFile(struct PackedFile *pf, void *data, int size);
00073 
00074 #endif
00075