src/uobject/loadable.h

   1 /*
   2  *  upkg: tool for manipulating Unreal Tournament packages.
   3  *  Copyright © 2009-2011 Nick Bowler
   4  *
   5  *  This program is free software: you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation, either version 3 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef U_OBJECT_LOADABLE_H_
  20 #define U_OBJECT_LOADABLE_H_
  21
  22 #include <uobject/uobject.h>
  23
  24 #define U_TYPE_OBJECT_LOADABLE (u_object_loadable_get_type())
  25 #define U_OBJECT_LOADABLE(obj) G_TYPE_CHECK_INSTANCE_CAST(obj, \
  26         U_TYPE_OBJECT_LOADABLE, UObjectLoadableIface)
  27 #define U_OBJECT_IS_LOADABLE(obj) G_TYPE_CHECK_INSTANCE_TYPE(obj, \
  28         U_TYPE_OBJECT_LOADABLE)
  29 #define U_OBJECT_LOADABLE_GET_INTERFACE(inst) G_TYPE_INSTANCE_GET_INTERFACE \
  30         (inst, U_TYPE_OBJECT_LOADABLE, UObjectLoadableIface)
  31
  32 typedef struct UObjectLoadableIface UObjectLoadableIface;
  33
  34 /*
  35  * Interface for UObjects supporting "load" and "unload".  These are generally
  36  * objects that need to allocate large amounts of memory in order to be
  37  * useful -- textures and sounds, for example -- where you might want to keep
  38  * around instances but the actual texture or sound data is not needed.
  39  */
  40 struct UObjectLoadableIface {
  41         GTypeInterface parent;
  42
  43         int (*load)(UObject *obj);
  44         void (*unload)(UObject *obj);
  45 };
  46
  47 GType u_object_loadable_get_type(void);
  48
  49 int u_object_load(GObject *obj);
  50 void u_object_unload(GObject *obj);
  51
  52 #endif