HGamer3D.Bindings.Ogre.ClassResourceManager

Documentation

delete

Arguments

:: HG3DClass

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

-> IO ()

setMemoryBudget

Arguments

:: HG3DClass

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

-> Int

bytes

-> IO ()

Get the limit on the amount of memory this resource handler may use.

Set a limit on the amount of memory this resource handler may use. If, when asked to load a new resource, the manager believes it will exceed this memory budget, it will temporarily unload a resource to make room for the new one. This unloading is not permanent and the Resource

getMemoryBudget

Arguments

:: HG3DClass

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

-> IO Int

getMemoryUsage

Arguments

:: HG3DClass

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

-> IO Int

Gets the current memory usage, in bytes.

unload

Arguments

:: HG3DClass

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

-> String

name

-> IO ()

Unloads all resources. Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded. ResourceGroupManagerResource::isReloadable

Unloads a single resource by name. Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded. ResourceGroupManager

unloadAll

Arguments

:: HG3DClass

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

-> Bool

reloadableOnly - If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

-> IO ()

Caused all currently loaded resources to be reloaded. All resources currently being held in this manager which are also marked as currently loaded will be unloaded, then loaded again. Resource::isReloadable

reloadAll

Arguments

:: HG3DClass

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

-> Bool

reloadableOnly - If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

-> IO ()

Unload all resources which are not referenced by any other object. This method behaves like unloadAll, except that it only unloads resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory). Some referenced resource may exists weak pointer to their sub-components (e.g. Entity

unloadUnreferencedResources

Arguments

:: HG3DClass

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

-> Bool

reloadableOnly - If true (the default), only unloads resources which can be subsequently automatically reloaded.

-> IO ()

Caused all currently loaded but not referenced by any other object resources to be reloaded. This method behaves like reloadAll, except that it only reloads resources which are not in use, i.e. not referenced by other objects. Some referenced resource may exists weak pointer to their sub-components (e.g. Entity

reloadUnreferencedResources

Arguments

:: HG3DClass

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

-> Bool

reloadableOnly - If true (the default), only reloads resources which can be subsequently automatically reloaded.

-> IO ()

Remove a single resource by name. Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded. The word Destroy is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently. If you do have shared pointers to resources hanging around after the ResourceManager

remove2

Arguments

:: HG3DClass

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

-> String

name

-> IO ()

Removes all resources. The word Destroy is not used here, since if any other pointers are referring to these resources, they will persist until they have been finished with; however to all intents and purposes the resources no longer exist and will get destroyed imminently. If you do have shared pointers to resources hanging around after the ResourceManager

removeAll

Arguments

:: HG3DClass

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

-> IO ()

Remove all resources which are not referenced by any other object. This method behaves like removeAll, except that it only removes resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory). Some referenced resource may exists weak pointer to their sub-components (e.g. Entity

removeUnreferencedResources

Arguments

:: HG3DClass

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

-> Bool

reloadableOnly - If true (the default), only removes resources which can be subsequently automatically reloaded.

-> IO ()

Returns whether the named resource exists in this manager.

resourceExists

Arguments

:: HG3DClass

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

-> String

name

-> IO Bool

getLoadingOrder

Arguments

:: HG3DClass

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

-> IO Float

Gets the relative loading order of resources of this type. There are dependencies between some kinds of resource in terms of loading order, and this value enumerates that. Higher values load later during bulk loading tasks.

getResourceType

Arguments

:: HG3DClass

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

-> IO String

Gets a string identifying the type of resource this manager handles.

setVerbose

Arguments

:: HG3DClass

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

-> Bool

v

-> IO ()

Gets whether this manager and its resources habitually produce log output

Sets whether this manager and its resources habitually produce log output

getVerbose

Arguments

:: HG3DClass

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

-> IO Bool

destroyResourcePool2

Arguments

:: HG3DClass

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

-> String

name

-> IO ()

destroy all pools

Destroy a resource pool.

destroyAllResourcePools

Arguments

:: HG3DClass

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

-> IO ()

delete'_ :: HG3DClassPtr -> IO ()

setMemoryBudget'_ :: HG3DClassPtr -> CInt -> IO ()

getMemoryBudget'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getMemoryUsage'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

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

unloadAll'_ :: HG3DClassPtr -> CInt -> IO ()

reloadAll'_ :: HG3DClassPtr -> CInt -> IO ()

unloadUnreferencedResources'_ :: HG3DClassPtr -> CInt -> IO ()

reloadUnreferencedResources'_ :: HG3DClassPtr -> CInt -> IO ()

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

removeAll'_ :: HG3DClassPtr -> IO ()

removeUnreferencedResources'_ :: HG3DClassPtr -> CInt -> IO ()

resourceExists'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CInt -> IO ()

getLoadingOrder'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

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

setVerbose'_ :: HG3DClassPtr -> CInt -> IO ()

getVerbose'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

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

destroyAllResourcePools'_ :: HG3DClassPtr -> IO ()