NAME

Ogre::Root

SYNOPSIS

use Ogre;
use Ogre::Root;
# (for now see examples/README.txt)

DESCRIPTION

See the online API documentation at http://www.ogre3d.org/docs/api/html/classOgre_1_1Root.html

Note: this Perl binding is currently experimental and subject to API changes.

CLASS METHODS

Ogre::Root->new(...)

Parameter types

... : this varies... (sorry, look in the .xs file)

Returns

Root *

Ogre::Root->DESTROY()

This method is called automatically; don't call it yourself.

INSTANCE METHODS

$obj->saveConfig()

Returns

void

$obj->restoreConfig()

Returns

bool

$obj->showConfigDialog()

Returns

bool

$obj->initialise($autoCreateWindow, $windowTitle)

Parameter types

$autoCreateWindow : bool

$windowTitle : String

Returns

RenderWindow *

$obj->isInitialised()

Returns

bool

$obj->createSceneManager($typeMask, $instanceName)

Parameter types

$typeMask : uint16

$instanceName : String

Returns

SceneManager *

$obj->destroySceneManager($sm)

Parameter types

$sm : SceneManager *

Returns

void

$obj->getSceneManager($instanceName)

Parameter types

$instanceName : String

Returns

SceneManager *

$obj->getTextureManager()

Returns

TextureManager *

$obj->getMeshManager()

Returns

MeshManager *

$obj->getErrorDescription($errorNumber)

Parameter types

$errorNumber : long

Returns

String

$obj->addFrameListener($perlListener)

Parameter types

$perlListener : SV *

Returns

void

$obj->removeFrameListener($perlListener)

Parameter types

$perlListener : SV *

Returns

void

$obj->queueEndRendering()

Returns

void

$obj->startRendering()

Returns

void

$obj->renderOneFrame()

Returns

bool

$obj->shutdown()

Returns

void

$obj->getAutoCreatedWindow()

Returns

RenderWindow *

$obj->createRenderWindow($name, $width, $height, $fullScreen, ...)

Parameter types

$name : String

$width : unsigned int

$height : unsigned int

$fullScreen : bool

... : this varies... (sorry, look in the .xs file)

Returns

RenderWindow *

$obj->detachRenderTarget($name)

Parameter types

$name : String

Returns

void

$obj->getRenderTarget($name)

Parameter types

$name : String

Returns

RenderTarget *

$obj->loadPlugin($pluginName)

Parameter types

$pluginName : String

Returns

void

$obj->unloadPlugin($pluginName)

Parameter types

$pluginName : String

Returns

void

$obj->getCurrentFrameNumber()

Returns

unsigned long

$obj->clearEventTimes()

Returns

void

$obj->setFrameSmoothingPeriod($period)

Parameter types

$period : Real

Returns

void

$obj->getFrameSmoothingPeriod()

Returns

Real

AUTHOR

Scott Lanning <slanning@cpan.org>

For licensing information, see README.txt .

cpanm Ogre

perl -MCPAN -e shell
install Ogre