HGamer3D.Bindings.Ogre.ClassArchiveManager

Documentation

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Default destructor.

load

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

filename - The filename that will be opened

-> String

archiveType

-> IO HG3DClass

return value - If the function succeeds, a valid pointer to an

Opens an archive for file reading. The archives are created using class factories within extension libraries. If the function fails, an exception is thrown.

unload

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

arch

-> IO ()

Unloads an archive by name. You must ensure that this archive is not being used before removing it.

Unloads an archive. You must ensure that this archive is not being used before removing it.

unload2

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

filename

-> IO ()

Override standard Singleton retrieval. Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

getSingletonPtr

Arguments

:: IO HG3DClass

delete'_ :: HG3DClassPtr -> IO ()

load'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CChar -> HG3DClassPtr -> IO ()

unload'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

unload2'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getSingletonPtr'_ :: HG3DClassPtr -> IO ()