HGamer3D-CEGUI-Binding-0.1.9: Windows Game Engine for the Haskell Programmer - CEGUI Bindings

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassOgreRenderer

Synopsis

Documentation

bootstrapSystemSource

Arguments

:: IO HG3DClass 

Convenience function that creates all the OgreCEGUI - Details: The created Renderer will use the default Ogre rendering window as the default output surface.

This will create and initialise the following objects for you:

Convenience function to cleanup the CEGUI - Details: This function will destroy the following objects for you:

Create an OgreRendererOgre - Details: For this to succeed you must have initialised Ogre

destroySystemSource

Arguments

:: IO () 

destory an OgreRenderer

destroySource

Arguments

:: HG3DClass

renderer

-> IO () 

function to create a CEGUI::OgreResourceProvider

destroyOgreResourceProviderSource

Arguments

:: HG3DClass

rp

-> IO () 

set whether CEGUI

function to destroy a CEGUI::OgreResourceProvider

setRenderingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

return whether CEGUI

isRenderingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

setupRenderingBlendModeSource

Arguments

:: HG3DClass

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

-> EnumBlendMode

mode

-> Bool

force

-> IO () 

Controls whether rendering done by CEGUI - Details: This defaults to enabled and is required when using the default hook that automatically calls CEGUI::System::renderGUI via a frame listener. If you disable this setting, the automated rendering will also be disabled, which is useful when you wish to perform your own calls to the CEGUI::System::renderGUI function (and is the sole purpose for this setting).

set the render states for the specified BlendMode.

setFrameControlExecutionEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Returns whether rendering done by CEGUI - Details: This defaults to enabled and is required when using the default hook that automatically calls CEGUI::System::renderGUI via a frame listener. If you disable this setting, the automated rendering will also be disabled, which is useful when you wish to perform your own calls to the CEGUI::System::renderGUI function (and is the sole purpose for this setting).

initialiseRenderStateSettingsSource

Arguments

:: HG3DClass

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

-> IO () 

Destroy all GeometryBuffer objects created by this Renderer

isFrameControlExecutionEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

Sets all the required render states needed for CEGUI - Details: This is a low-level function intended for certain advanced concepts; in general it will not be required to call this function directly, since it is called automatically by the system when rendering is done.

destroyAllGeometryBuffersSource

Arguments

:: HG3DClass

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

-> IO () 

Destory all TextureTarget objects created by this Renderer

destroyAllTextureTargetsSource

Arguments

:: HG3DClass

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

-> IO () 

Destroy all Texture objects created by this Renderer

destroyAllTexturesSource

Arguments

:: HG3DClass

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

-> IO () 

Perform any operations required to put the system into a state ready for rendering operations to begin.

beginRenderingSource

Arguments

:: HG3DClass

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

-> IO () 

Perform any operations required to finalise rendering.

endRenderingSource

Arguments

:: HG3DClass

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

-> IO () 

Return the pixel size of the maximum supported texture.

getMaxTextureSizeSource

Arguments

:: HG3DClass

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

-> IO Int

return value - Size of the maximum supported texture in pixels.

getIdentifierStringSource

Arguments

:: HG3DClass

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

-> IO String

return value - String object holding text that identifies the

Return identification string for the renderer module.