HGamer3D-Ogre-Binding-0.1.8: Library to enable 3D game development for Haskell - Ogre Bindings

Safe HaskellSafe-Infered

HGamer3D.Bindings.Ogre.ClassLogManager

Synopsis

Documentation

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

createLogSource

Arguments

:: HG3DClass

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

-> String

name - The name to give the log e.g. log

-> Bool

defaultLog - If true, this is the default log output will be sent to if the generic logging methods on this class are used. The first log created is always the default log unless this parameter is set.

-> Bool

debuggerOutput - If true, output to this log will also be routed to the debugger's output window.

-> Bool

suppressFileOutput - If true, this is a logical rather than a physical log and no file output will be written. If you do this you should register a LogListener so log output is not lost.

-> IO HG3DClass 

Creates a new log with the given name.

getLogSource

Arguments

:: HG3DClass

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

-> String

name

-> IO HG3DClass 

Retrieves a log managed by this class.

getDefaultLogSource

Arguments

:: HG3DClass

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

-> IO HG3DClass 

Returns a pointer to the default log.

destroyLogSource

Arguments

:: HG3DClass

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

-> String

name

-> IO () 

Closes and removes a log.

Closes and removes a named log.

destroyLog2Source

Arguments

:: HG3DClass

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

-> HG3DClass

log

-> IO () 

Sets the passed in log as the default log.

setDefaultLogSource

Arguments

:: HG3DClass

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

-> HG3DClass

newLog

-> IO HG3DClass

return value - The previous default log.

logMessageSource

Arguments

:: HG3DClass

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

-> String

message

-> EnumLogMessageLevel

lml

-> Bool

maskDebug

-> IO () 

Log

Log

logMessage2Source

Arguments

:: HG3DClass

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

-> EnumLogMessageLevel

lml

-> String

message

-> Bool

maskDebug

-> IO () 

Sets the level of detail of the default log.

setLogDetailSource

Arguments

:: HG3DClass

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

-> EnumLoggingLevel

ll

-> 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.