libirrlicht-dev/html/irrlicht_8h_source.html

/* irrlicht.h -- interface of the 'Irrlicht Engine'


  Copyright (C) 2002-2012 Nikolaus Gebhardt


  This software is provided 'as-is', without any express or implied

  warranty.  In no event will the authors be held liable for any damages

  arising from the use of this software.


  Permission is granted to anyone to use this software for any purpose,

  including commercial applications, and to alter it and redistribute it

  freely, subject to the following restrictions:


  1. The origin of this software must not be misrepresented; you must not

     claim that you wrote the original software. If you use this software

     in a product, an acknowledgment in the product documentation would be

     appreciated but is not required.

  2. Altered source versions must be plainly marked as such, and must not be

     misrepresented as being the original software.

  3. This notice may not be removed or altered from any source distribution.


  Please note that the Irrlicht Engine is based in part on the work of the

  Independent JPEG Group, the zlib and the libPng. This means that if you use

  the Irrlicht Engine in your product, you must acknowledge somewhere in your

  documentation that you've used the IJG code. It would also be nice to mention

  that you use the Irrlicht Engine, the zlib and libPng. See the README files

  in the jpeglib, the zlib and libPng for further informations.

*/


#ifndef __IRRLICHT_H_INCLUDED__

#define __IRRLICHT_H_INCLUDED__


#include "IrrCompileConfig.h"

#include "aabbox3d.h"

#include "CDynamicMeshBuffer.h"

#include "CIndexBuffer.h"

#include "CMeshBuffer.h"

#include "coreutil.h"

#include "CVertexBuffer.h"

#include "dimension2d.h"

#include "ECullingTypes.h"

#include "EDebugSceneTypes.h"

#include "EDriverFeatures.h"

#include "EDriverTypes.h"

#include "EGUIAlignment.h"

#include "EGUIElementTypes.h"

#include "EHardwareBufferFlags.h"

#include "EMaterialFlags.h"

#include "EMaterialTypes.h"

#include "EMeshWriterEnums.h"

#include "EMessageBoxFlags.h"

#include "ESceneNodeAnimatorTypes.h"

#include "ESceneNodeTypes.h"

#include "ETerrainElements.h"

#include "fast_atof.h"

#include "heapsort.h"

#include "IAnimatedMesh.h"

#include "IAnimatedMeshMD2.h"

#include "IAnimatedMeshMD3.h"

#include "IAnimatedMeshSceneNode.h"

#include "IAttributeExchangingObject.h"

#include "IAttributes.h"

#include "IBillboardSceneNode.h"

#include "IBillboardTextSceneNode.h"

#include "IBoneSceneNode.h"

#include "ICameraSceneNode.h"

#include "ICursorControl.h"

#include "IDummyTransformationSceneNode.h"

#include "IDynamicMeshBuffer.h"

#include "IEventReceiver.h"

#include "IFileList.h"

#include "IFileSystem.h"

#include "IGeometryCreator.h"

#include "IGPUProgrammingServices.h"

#include "IGUIButton.h"

#include "IGUICheckBox.h"

#include "IGUIColorSelectDialog.h"

#include "IGUIComboBox.h"

#include "IGUIContextMenu.h"

#include "IGUIEditBox.h"

#include "IGUIElement.h"

#include "IGUIElementFactory.h"

#include "IGUIEnvironment.h"

#include "IGUIFileOpenDialog.h"

#include "IGUIFont.h"

#include "IGUIFontBitmap.h"

#include "IGUIImage.h"

#include "IGUIInOutFader.h"

#include "IGUIListBox.h"

#include "IGUIMeshViewer.h"

#include "IGUIScrollBar.h"

#include "IGUISkin.h"

#include "IGUISpinBox.h"

#include "IGUISpriteBank.h"

#include "IGUIStaticText.h"

#include "IGUITabControl.h"

#include "IGUITable.h"

#include "IGUIToolbar.h"

#include "IGUIWindow.h"

#include "IGUITreeView.h"

#include "IImage.h"

#include "IImageLoader.h"

#include "IImageWriter.h"

#include "IIndexBuffer.h"

#include "ILightSceneNode.h"

#include "ILogger.h"

#include "IMaterialRenderer.h"

#include "IMaterialRendererServices.h"

#include "IMesh.h"

#include "IMeshBuffer.h"

#include "IMeshCache.h"

#include "IMeshLoader.h"

#include "IMeshManipulator.h"

#include "IMeshSceneNode.h"

#include "IMeshWriter.h"

#include "IColladaMeshWriter.h"

#include "IMetaTriangleSelector.h"

#include "IOSOperator.h"

#include "IParticleSystemSceneNode.h" // also includes all emitters and attractors

#include "IQ3LevelMesh.h"

#include "IQ3Shader.h"

#include "IReadFile.h"

#include "IReferenceCounted.h"

#include "irrArray.h"

#include "IRandomizer.h"

#include "IrrlichtDevice.h"

#include "irrList.h"

#include "irrMap.h"

#include "irrMath.h"

#include "irrString.h"

#include "irrTypes.h"

#include "path.h"

#include "irrXML.h"

#include "ISceneCollisionManager.h"

#include "ISceneLoader.h"

#include "ISceneManager.h"

#include "ISceneNode.h"

#include "ISceneNodeAnimator.h"

#include "ISceneNodeAnimatorCameraFPS.h"

#include "ISceneNodeAnimatorCameraMaya.h"

#include "ISceneNodeAnimatorCollisionResponse.h"

#include "ISceneNodeAnimatorFactory.h"

#include "ISceneNodeFactory.h"

#include "ISceneUserDataSerializer.h"

#include "IShaderConstantSetCallBack.h"

#include "IShadowVolumeSceneNode.h"

#include "ISkinnedMesh.h"

#include "ITerrainSceneNode.h"

#include "ITextSceneNode.h"

#include "ITexture.h"

#include "ITimer.h"

#include "ITriangleSelector.h"

#include "IVertexBuffer.h"

#include "IVideoDriver.h"

#include "IVideoModeList.h"

#include "IVolumeLightSceneNode.h"

#include "IWriteFile.h"

#include "IXMLReader.h"

#include "IXMLWriter.h"

#include "ILightManager.h"

#include "Keycodes.h"

#include "line2d.h"

#include "line3d.h"

#include "matrix4.h"

#include "plane3d.h"

#include "position2d.h"

#include "quaternion.h"

#include "rect.h"

#include "S3DVertex.h"

#include "SAnimatedMesh.h"

#include "SceneParameters.h"

#include "SColor.h"

#include "SExposedVideoData.h"

#include "SIrrCreationParameters.h"

#include "SKeyMap.h"

#include "SLight.h"

#include "SMaterial.h"

#include "SMesh.h"

#include "SMeshBuffer.h"

#include "SMeshBufferLightMap.h"

#include "SMeshBufferTangents.h"

#include "SParticle.h"

#include "SSharedMeshBuffer.h"

#include "SSkinMeshBuffer.h"

#include "SVertexIndex.h"

#include "SViewFrustum.h"

#include "triangle3d.h"

#include "vector2d.h"

#include "vector3d.h"


#include "SIrrCreationParameters.h"


namespace irr

{


    extern "C" IRRLICHT_API IrrlichtDevice* IRRCALLCONV createDevice(

        video::E_DRIVER_TYPE deviceType = video::EDT_SOFTWARE,

        // parantheses are necessary for some compilers

        const core::dimension2d<u32>& windowSize = (core::dimension2d<u32>(640,480)),

        u32 bits = 16,

        bool fullscreen = false,

        bool stencilbuffer = false,

        bool vsync = false,

        IEventReceiver* receiver = 0);


    typedef IrrlichtDevice* (IRRCALLCONV *funcptr_createDevice )(

            video::E_DRIVER_TYPE deviceType,

            const core::dimension2d<u32>& windowSize,

            u32 bits,

            bool fullscreen,

            bool stencilbuffer,

            bool vsync,

            IEventReceiver* receiver);


    extern "C" IRRLICHT_API IrrlichtDevice* IRRCALLCONV createDeviceEx(

        const SIrrlichtCreationParameters& parameters);


    typedef IrrlichtDevice* (IRRCALLCONV *funcptr_createDeviceEx )( const SIrrlichtCreationParameters& parameters );


    // THE FOLLOWING IS AN EMPTY LIST OF ALL SUB NAMESPACES

    // EXISTING ONLY FOR THE DOCUMENTATION SOFTWARE DOXYGEN.


    namespace core

    {

    }


    namespace gui

    {

    }


    namespace io

    {

    }


    namespace scene

    {

    }


    namespace video

    {

    }

}


#endif


CDynamicMeshBuffer.h

CIndexBuffer.h

CMeshBuffer.h

CVertexBuffer.h

ECullingTypes.h

EDebugSceneTypes.h

EDriverFeatures.h

EDriverTypes.h

EGUIAlignment.h

EGUIElementTypes.h

EHardwareBufferFlags.h

EMaterialFlags.h

EMaterialTypes.h

EMeshWriterEnums.h

EMessageBoxFlags.h

ESceneNodeAnimatorTypes.h

ESceneNodeTypes.h

ETerrainElements.h

IAnimatedMesh.h

IAnimatedMeshMD2.h

IAnimatedMeshMD3.h

IAnimatedMeshSceneNode.h

IAttributeExchangingObject.h

IAttributes.h

IBillboardSceneNode.h

IBillboardTextSceneNode.h

IBoneSceneNode.h

ICameraSceneNode.h

IColladaMeshWriter.h

ICursorControl.h

IDummyTransformationSceneNode.h

IDynamicMeshBuffer.h

IEventReceiver.h

IFileList.h

IFileSystem.h

IGPUProgrammingServices.h

IGUIButton.h

IGUICheckBox.h

IGUIColorSelectDialog.h

IGUIComboBox.h

IGUIContextMenu.h

IGUIEditBox.h

IGUIElement.h

IGUIElementFactory.h

IGUIEnvironment.h

IGUIFileOpenDialog.h

IGUIFont.h

IGUIFontBitmap.h

IGUIImage.h

IGUIInOutFader.h

IGUIListBox.h

IGUIMeshViewer.h

IGUIScrollBar.h

IGUISkin.h

IGUISpinBox.h

IGUISpriteBank.h

IGUIStaticText.h

IGUITabControl.h

IGUITable.h

IGUIToolbar.h

IGUITreeView.h

IGUIWindow.h

IGeometryCreator.h

IImage.h

IImageLoader.h

IImageWriter.h

IIndexBuffer.h

ILightManager.h

ILightSceneNode.h

ILogger.h

IMaterialRenderer.h

IMaterialRendererServices.h

IMesh.h

IMeshBuffer.h

IMeshCache.h

IMeshLoader.h

IMeshManipulator.h

IMeshSceneNode.h

IMeshWriter.h

IMetaTriangleSelector.h

IOSOperator.h

IParticleSystemSceneNode.h

IQ3LevelMesh.h

IQ3Shader.h

IRandomizer.h

IReadFile.h

IReferenceCounted.h

ISceneCollisionManager.h

ISceneLoader.h

ISceneManager.h

ISceneNode.h

ISceneNodeAnimator.h

ISceneNodeAnimatorCameraFPS.h

ISceneNodeAnimatorCameraMaya.h

ISceneNodeAnimatorCollisionResponse.h

ISceneNodeAnimatorFactory.h

ISceneNodeFactory.h

ISceneUserDataSerializer.h

IShaderConstantSetCallBack.h

IShadowVolumeSceneNode.h

ISkinnedMesh.h

ITerrainSceneNode.h

ITextSceneNode.h

ITexture.h

ITimer.h

ITriangleSelector.h

IVertexBuffer.h

IVideoDriver.h

IVideoModeList.h

IVolumeLightSceneNode.h

IWriteFile.h

IXMLReader.h

IXMLWriter.h

IrrCompileConfig.h

IRRCALLCONV
#define IRRCALLCONV
Definition IrrCompileConfig.h:697

IRRLICHT_API
#define IRRLICHT_API
Set FPU settings.
Definition IrrCompileConfig.h:694

IrrlichtDevice.h

Keycodes.h

S3DVertex.h

SAnimatedMesh.h

SColor.h

SExposedVideoData.h

SIrrCreationParameters.h

SKeyMap.h

SLight.h

SMaterial.h

SMesh.h

SMeshBuffer.h

SMeshBufferLightMap.h

SMeshBufferTangents.h

SParticle.h

SSharedMeshBuffer.h

SSkinMeshBuffer.h

SVertexIndex.h

SViewFrustum.h

SceneParameters.h
Header file containing all scene parameters for modifying mesh loading etc.

aabbox3d.h

irr::IEventReceiver
Interface of an object which can receive events.
Definition IEventReceiver.h:434

irr::IrrlichtDevice
The Irrlicht device. You can create it with createDevice() or createDeviceEx().
Definition IrrlichtDevice.h:44

irr::core::dimension2d
Specifies a 2 dimensional size.
Definition dimension2d.h:21

coreutil.h
File containing useful basic utility functions.

dimension2d.h

fast_atof.h

heapsort.h

irrArray.h

irrList.h

irrMap.h

irrMath.h

irrString.h

irrTypes.h

irrXML.h
Header file of the irrXML, the Irrlicht XML parser.

line2d.h

line3d.h

matrix4.h

irr::core
Basic classes such as vectors, planes, arrays, lists, and so on can be found in this namespace.
Definition aabbox3d.h:15

irr::io
This namespace provides interfaces for input/output: Reading and writing files, accessing zip archive...
Definition EAttributes.h:11

irr::scene
All scene management can be found in this namespace: Mesh loading, special scene nodes like octrees a...
Definition CDynamicMeshBuffer.h:16

irr::video
The video namespace contains classes for accessing the video driver. All 2d and 3d rendering is done ...
Definition EDriverFeatures.h:11

irr::video::E_DRIVER_TYPE
E_DRIVER_TYPE
An enum for all types of drivers the Irrlicht Engine supports.
Definition EDriverTypes.h:15

irr::video::EDT_SOFTWARE
@ EDT_SOFTWARE
The Irrlicht Engine Software renderer.
Definition EDriverTypes.h:26

irr
Everything in the Irrlicht Engine can be found in this namespace.
Definition aabbox3d.h:13

irr::u32
unsigned int u32
32 bit unsigned variable.
Definition irrTypes.h:58

irr::createDevice
IRRLICHT_API IrrlichtDevice *IRRCALLCONV createDevice(video::E_DRIVER_TYPE deviceType=video::EDT_SOFTWARE, const core::dimension2d< u32 > &windowSize=(core::dimension2d< u32 >(640, 480)), u32 bits=16, bool fullscreen=false, bool stencilbuffer=false, bool vsync=false, IEventReceiver *receiver=0)
Creates an Irrlicht device. The Irrlicht device is the root object for using the engine.

irr::funcptr_createDeviceEx
IrrlichtDevice *IRRCALLCONV * funcptr_createDeviceEx(const SIrrlichtCreationParameters &parameters)
typedef for Function Pointer
Definition irrlicht.h:357

irr::funcptr_createDevice
IrrlichtDevice *IRRCALLCONV * funcptr_createDevice(video::E_DRIVER_TYPE deviceType, const core::dimension2d< u32 > &windowSize, u32 bits, bool fullscreen, bool stencilbuffer, bool vsync, IEventReceiver *receiver)
typedef for Function Pointer
Definition irrlicht.h:335

irr::createDeviceEx
IRRLICHT_API IrrlichtDevice *IRRCALLCONV createDeviceEx(const SIrrlichtCreationParameters &parameters)
Creates an Irrlicht device with the option to specify advanced parameters.

path.h

plane3d.h

position2d.h

quaternion.h

rect.h

irr::SIrrlichtCreationParameters
Structure for holding Irrlicht Device creation parameters.
Definition SIrrCreationParameters.h:20

triangle3d.h

vector2d.h

vector3d.h