| Safe Haskell | Safe-Infered |
|---|
HGamer3D.Bindings.Ogre.ClassResource
- delete :: HG3DClass -> IO ()
- prepare :: HG3DClass -> Bool -> IO ()
- load :: HG3DClass -> Bool -> IO ()
- reload :: HG3DClass -> IO ()
- isReloadable :: HG3DClass -> IO Bool
- isManuallyLoaded :: HG3DClass -> IO Bool
- unload :: HG3DClass -> IO ()
- getSize :: HG3DClass -> IO Int
- touch :: HG3DClass -> IO ()
- getName :: HG3DClass -> IO String
- isPrepared :: HG3DClass -> IO Bool
- isLoaded :: HG3DClass -> IO Bool
- isLoading :: HG3DClass -> IO Bool
- isBackgroundLoaded :: HG3DClass -> IO Bool
- setBackgroundLoaded :: HG3DClass -> Bool -> IO ()
- escalateLoading :: HG3DClass -> IO ()
- getGroup :: HG3DClass -> IO String
- changeGroupOwnership :: HG3DClass -> String -> IO ()
- getCreator :: HG3DClass -> IO HG3DClass
- getOrigin :: HG3DClass -> IO String
- getStateCount :: HG3DClass -> IO Int
- delete'_ :: HG3DClassPtr -> IO ()
- prepare'_ :: HG3DClassPtr -> CInt -> IO ()
- load'_ :: HG3DClassPtr -> CInt -> IO ()
- reload'_ :: HG3DClassPtr -> IO ()
- isReloadable'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isManuallyLoaded'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- unload'_ :: HG3DClassPtr -> IO ()
- getSize'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- touch'_ :: HG3DClassPtr -> IO ()
- getName'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- isPrepared'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isLoaded'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isLoading'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isBackgroundLoaded'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- setBackgroundLoaded'_ :: HG3DClassPtr -> CInt -> IO ()
- escalateLoading'_ :: HG3DClassPtr -> IO ()
- getGroup'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- changeGroupOwnership'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- getCreator'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- getOrigin'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- getStateCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
Documentation
Arguments
| :: HG3DClass | classpointer - pointer of Class instance which is going to be deleted. |
| -> IO () |
Virtual destructor. Shouldn't need to be overloaded, as the resource deallocation code should reside in unload()Resource::unload()
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | backgroundThread - Whether this is occurring in a background thread |
| -> IO () |
Loads the resource, if it is not already. If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own.
Prepares the resource for load, if it is not already. One can call prepare()load()load()prepare()load()prepare()prepare()prepare()load()prepare()load()prepare()prepare()
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | backgroundThread - Indicates whether the caller of this method is the background resource loading thread. |
| -> IO () |
Reloads the resource, if it is already loaded. Calls unload()load()
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () |
Returns true if the Resource
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
Is this resource manually loaded?
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () |
Retrieves info about the size of the resource.
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () |
Gets resource name.
Touches the resource to indicate it has been used.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
Returns true if the Resource
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
Returns true if the Resource
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
Returns whether the resource is currently in the process of background loading.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
Returns whether this ResourceThis option only makes sense when you have built Ogreload()load()isLoaded()
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | bl |
| -> IO () |
Escalates the loading of a background loaded resource. If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.
Tells the resource whether it is background loaded or not. Resource::isBackgroundLoaded
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () |
Gets the group which this resource is a member of.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> String | newGroup - Name of the new group |
| -> IO () |
Gets the manager which created this resource.
Change the resource group ownership of a ResourceThis method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO String |
Get the origin of this resource, e.g. a script file name. This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Int |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.
delete'_ :: HG3DClassPtr -> IO ()Source
reload'_ :: HG3DClassPtr -> IO ()Source
isReloadable'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isManuallyLoaded'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
unload'_ :: HG3DClassPtr -> IO ()Source
touch'_ :: HG3DClassPtr -> IO ()Source
isPrepared'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isLoaded'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isLoading'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isBackgroundLoaded'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
setBackgroundLoaded'_ :: HG3DClassPtr -> CInt -> IO ()Source
getGroup'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source
changeGroupOwnership'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source
getCreator'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
getOrigin'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source
getStateCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source