NAME
Ogre - Perl binding for the OGRE C++ graphics library
SYNOPSIS
use Ogre;
# see examples/README.txtDESCRIPTION
For more details, see README.txt.
For documentation on specific classes, see the perldoc for the class. There is a list below of classes currently wrapped. The documentation for each class is somewhat minimal. In the DESCRIPTION section there will be a link to the corresponding C++ API documentation on the OGRE website. The documentation of methods uses C++ types to describe its parameters and return values, so some translation to Perl is generally required.
Not all methods are currently wrapped, although there are enough to run the examples, which isn't bad. But expect to find that your favorite method isn't wrapped yet. I'm working on completely wrapping the methods, but it's still not there. One particular "category" of methods not yet wrapped is those that return a C++ reference, rather than a pointer (one exception is Node::getPosition). Methods that return fundamental types, like bool or int, are usually wrapped, provided their arguments aren't too weird. There are also some overloaded C++ methods (i.e. different argument parameter types but the same method name) that have only one version of that method implemented; I have to work on how to handle that.
See TODO.txt for more things that aren't done yet.
CLASSES
This is the list of classes that are at least partially wrapped.
- Ogre::AnimableObject
- Ogre::AnimableValue
- Ogre::Animation
- Ogre::AnimationControllerFunction
- Ogre::AnimationObject
- Ogre::AnimationState
- Ogre::AnimationStateSet
- Ogre::AnimationTrack
- Ogre::AxisAlignedBox
- Ogre::AxisAlignedBoxSceneQuery
- Ogre::Billboard
- Ogre::BillboardChain
- Ogre::BillboardSet
- Ogre::Bone
- Ogre::BorderPanelOverlayElement
- Ogre::Camera
- Ogre::ColourValue
- Ogre::CompositionPass
- Ogre::CompositionTargetPass
- Ogre::ConfigFile
- Ogre::ControllerManager
- Ogre::ControllerReal
- Ogre::DataStream
- Ogre::Degree
- Ogre::EdgeData
- Ogre::Entity
- Ogre::ExampleApplication
- Ogre::ExampleFrameListener
- Ogre::Exception
- Ogre::FrameEvent
- Ogre::FrameStats
- Ogre::Frustum
- Ogre::GpuProgram
- Ogre::GpuProgramParameters
- Ogre::HardwareBuffer
- Ogre::HardwareBufferManager
- Ogre::HardwareIndexBuffer
- Ogre::HardwarePixelBuffer
- Ogre::HardwareVertexBuffer
- Ogre::Image
- Ogre::IndexData
- Ogre::InstancedGeometry
- Ogre::IntersectionSceneQuery
- Ogre::KeyFrame
- Ogre::Light
- Ogre::Log
- Ogre::LogManager
- Ogre::ManualObject
- Ogre::ManualObjectSection
- Ogre::ManualResourceLoader
- Ogre::Material
- Ogre::MaterialManager
- Ogre::Math
- Ogre::Matrix3
- Ogre::Matrix4
- Ogre::Mesh
- Ogre::MeshManager
- Ogre::MeshPtr
- Ogre::MovableObject
- Ogre::MovablePlane
- Ogre::MultiRenderTarget
- Ogre::Node
- Ogre::NodeAnimationTrack
- Ogre::NumericAnimationTrack
- Ogre::Overlay
- Ogre::OverlayContainer
- Ogre::OverlayElement
- Ogre::OverlayManager
- Ogre::PanelOverlayElement
- Ogre::Particle
- Ogre::ParticleAffector
- Ogre::ParticleEmitter
- Ogre::ParticleSystem
- Ogre::ParticleSystemRenderer
- Ogre::Pass
- Ogre::PassthroughControllerFunction
- Ogre::PatchMesh
- Ogre::PatchSurface
- Ogre::Plane
- Ogre::PlaneBoundedVolume
- Ogre::PlaneBoundedVolumeListSceneQuery
- Ogre::Pose
- Ogre::ProgressiveMesh
- Ogre::Quaternion
- Ogre::QueuedRenderableCollection
- Ogre::Radian
- Ogre::Ray
- Ogre::RaySceneQuery
- Ogre::RegionSceneQuery
- Ogre::Renderable
- Ogre::RenderOperation
- Ogre::RenderQueue
- Ogre::RenderSystem
- Ogre::RenderSystemCapabilities
- Ogre::RenderTarget
- Ogre::RenderTexture
- Ogre::RenderWindow
- Ogre::Resource
- Ogre::ResourceGroupManager
- Ogre::ResourceManager
- Ogre::RibbonTrail
- Ogre::Root
- Ogre::ScaleControllerFunction
- Ogre::SceneManager
- Ogre::SceneNode
- Ogre::SceneQuery
- Ogre::ScriptLoader
- Ogre::Serializer
- Ogre::ShadowCaster
- Ogre::SimpleRenderable
- Ogre::Skeleton
- Ogre::SkeletonInstance
- Ogre::SkeletonManager
- Ogre::Sphere
- Ogre::SphereSceneQuery
- Ogre::StaticGeometry
- Ogre::StringInterface
- Ogre::SubEntity
- Ogre::SubMesh
- Ogre::TagPoint
- Ogre::Technique
- Ogre::TextAreaOverlayElement
- Ogre::Texture
- Ogre::TextureManager
- Ogre::TextureUnitState
- Ogre::TimeIndex
- Ogre::Timer
- Ogre::TransformKeyFrame
- Ogre::Vector2
- Ogre::Vector3
- Ogre::Vector4
- Ogre::VertexAnimationTrack
- Ogre::VertexBufferBinding
- Ogre::VertexCacheProfiler
- Ogre::VertexData
- Ogre::VertexDeclaration
- Ogre::VertexElement
- Ogre::Viewport
- Ogre::WaveformControllerFunction
- Ogre::WindowEventUtilities
- Ogre::WorldFragment
AUTHOR
Scott Lanning <slanning@cpan.org>
For licensing info, see README.txt.