 |
Irrlicht 3D Engine
|
|
|
Irrlicht 3D Engine
|
|
Everything in the Irrlicht Engine can be found in this namespace. More...
Basic classes such as vectors, planes, arrays, lists, and so on can be found in this namespace.
The gui namespace contains useful classes for easy creation of a graphical user interface.
This namespace provides interfaces for input/output: Reading and writing files, accessing zip archives, xml files, ...
All scene management can be found in this namespace: Mesh loading, special scene nodes like octrees and billboards, ...
The video namespace contains classes for accessing the video driver. All 2d and 3d rendering is done here.
Everything in the Irrlicht Engine can be found in this namespace.
As of Irrlicht 1.6, position2d is a synonym for vector2d.
You should consider position2d to be deprecated, and use vector2d by preference.
| typedef char irr::c8 |
8 bit character variable.
This is a typedef for char, it ensures portability of the engine.
Definition at line 31 of file irrTypes.h.
| typedef float irr::f32 |
32 bit floating point variable.
This is a typedef for float, it ensures portability of the engine.
Definition at line 104 of file irrTypes.h.
| typedef double irr::f64 |
64 bit floating point variable.
This is a typedef for double, it ensures portability of the engine.
Definition at line 108 of file irrTypes.h.
| typedef char irr::fschar_t |
Type name for character type used by the file system.
Should the wide character version of the FileSystem be used it is a 16 bit character variable. Used for unicode Filesystem and unicode strings. Else it is a 8 bit character variable. Used for ansi Filesystem and non-unicode strings
Definition at line 158 of file irrTypes.h.
| typedef IrrlichtDevice* IRRCALLCONV* irr::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 at line 335 of file irrlicht.h.
| typedef IrrlichtDevice* IRRCALLCONV* irr::funcptr_createDeviceEx(const SIrrlichtCreationParameters ¶meters) |
typedef for Function Pointer
Definition at line 357 of file irrlicht.h.
| typedef signed short irr::s16 |
16 bit signed variable.
This is a typedef for signed short, it ensures portability of the engine.
Definition at line 48 of file irrTypes.h.
| typedef signed int irr::s32 |
32 bit signed variable.
This is a typedef for signed int, it ensures portability of the engine.
Definition at line 66 of file irrTypes.h.
| typedef long long irr::s64 |
64 bit signed variable.
This is a typedef for 64bit int, it ensures portability of the engine.
Definition at line 96 of file irrTypes.h.
| typedef signed char irr::s8 |
8 bit signed variable.
This is a typedef for signed char, it ensures portability of the engine.
Definition at line 26 of file irrTypes.h.
| typedef unsigned short irr::u16 |
16 bit unsigned variable.
This is a typedef for unsigned short, it ensures portability of the engine.
Definition at line 40 of file irrTypes.h.
| typedef unsigned int irr::u32 |
32 bit unsigned variable.
This is a typedef for unsigned int, it ensures portability of the engine.
Definition at line 58 of file irrTypes.h.
| typedef unsigned long long irr::u64 |
64 bit unsigned variable.
This is a typedef for 64bit uint, it ensures portability of the engine.
Definition at line 82 of file irrTypes.h.
| typedef unsigned char irr::u8 |
8 bit unsigned variable.
This is a typedef for unsigned char, it ensures portability of the engine.
Definition at line 18 of file irrTypes.h.
| enum irr::E_DEVICE_TYPE |
An enum for the different device types supported by the Irrlicht Engine.
| EIDT_WIN32 |
A device native to Microsoft Windows. This device uses the Win32 API and works in all versions of Windows. |
| EIDT_WINCE |
A device native to Windows CE devices. This device works on Windows Mobile, Pocket PC and Microsoft SmartPhone devices |
| EIDT_X11 |
A device native to Unix style operating systems. This device uses the X11 windowing system and works in Linux, Solaris, FreeBSD, OSX and other operating systems which support X11. |
| EIDT_OSX |
A device native to Mac OSX. This device uses Apple's Cocoa API and works in Mac OSX 10.2 and above. |
| EIDT_SDL |
A device which uses Simple DirectMedia Layer. The SDL device works under all platforms supported by SDL but first must be compiled in by defining the IRR_USE_SDL_DEVICE macro in IrrCompileConfig.h |
| EIDT_FRAMEBUFFER |
A device for raw framebuffer access. Best used with embedded devices and mobile systems. Does not need X11 or other graphical subsystems. May support hw-acceleration via OpenGL-ES for FBDirect |
| EIDT_CONSOLE |
A simple text only device supported by all platforms. This device allows applications to run from the command line without opening a window. It can render the output of the software drivers to the console as ASCII. It only supports mouse and keyboard in Windows operating systems. |
| EIDT_BEST |
This selection allows Irrlicht to choose the best device from the ones available. If this selection is chosen then Irrlicht will try to use the IrrlichtDevice native to your operating system. If this is unavailable then the X11, SDL and then console device will be tried. This ensures that Irrlicht will run even if your platform is unsupported, although it may not be able to render anything. |
Definition at line 12 of file EDeviceTypes.h.
Masks for mouse button states.
| EMBSM_LEFT | |
| EMBSM_RIGHT | |
| EMBSM_MIDDLE | |
| EMBSM_EXTRA1 |
currently only on windows |
| EMBSM_EXTRA2 |
currently only on windows |
| EMBSM_FORCE_32_BIT |
Definition at line 130 of file IEventReceiver.h.
| enum irr::EEVENT_TYPE |
Enumeration for all event types there are.
| EET_GUI_EVENT |
An event of the graphical user interface. GUI events are created by the GUI environment or the GUI elements in response to mouse or keyboard events. When a GUI element receives an event it will either process it and return true, or pass the event to its parent. If an event is not absorbed before it reaches the root element then it will then be passed to the user receiver. |
| EET_MOUSE_INPUT_EVENT |
A mouse input event. Mouse events are created by the device and passed to IrrlichtDevice::postEventFromUser in response to mouse input received from the operating system. Mouse events are first passed to the user receiver, then to the GUI environment and its elements, then finally the input receiving scene manager where it is passed to the active camera. |
| EET_KEY_INPUT_EVENT |
A key input event. Like mouse events, keyboard events are created by the device and passed to IrrlichtDevice::postEventFromUser. They take the same path as mouse events. |
| EET_JOYSTICK_INPUT_EVENT |
A joystick (joypad, gamepad) input event. Joystick events are created by polling all connected joysticks once per device run() and then passing the events to IrrlichtDevice::postEventFromUser. They take the same path as mouse events. Windows, SDL: Implemented. Linux: Implemented, with POV hat issues. MacOS / Other: Not yet implemented. |
| EET_LOG_TEXT_EVENT |
A log event. Log events are only passed to the user receiver if there is one. If they are absorbed by the user receiver then no text will be sent to the console. |
| EET_USER_EVENT |
A user event with user data. This is not used by Irrlicht and can be used to send user specific data though the system. The Irrlicht 'window handle' can be obtained from IrrlichtDevice::getExposedVideoData() The usage and behavior depends on the operating system: Windows: send a WM_USER message to the Irrlicht Window; the wParam and lParam will be used to populate the UserData1 and UserData2 members of the SUserEvent. Linux: send a ClientMessage via XSendEvent to the Irrlicht Window; the data.l[0] and data.l[1] members will be casted to s32 and used as UserData1 and UserData2. MacOS: Not yet implemented |
| EGUIET_FORCE_32_BIT |
This enum is never used, it only forces the compiler to compile these enumeration values to 32 bit. |
Definition at line 15 of file IEventReceiver.h.
| enum irr::EKEY_ACTION |
| enum irr::EKEY_CODE |
Definition at line 11 of file Keycodes.h.
| enum irr::ELOG_LEVEL |
Possible log levels. When used has filter ELL_DEBUG means => log everything and ELL_NONE means => log (nearly) nothing. When used to print logging information ELL_DEBUG will have lowest priority while ELL_NONE messages are never filtered and always printed.
Enumeration for all mouse input events.
Definition at line 74 of file IEventReceiver.h.
| IRRLICHT_API IrrlichtDevice* IRRCALLCONV irr::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.
If you need more parameters to be passed to the creation of the Irrlicht Engine device, use the createDeviceEx() function.
| deviceType,: | Type of the device. This can currently be video::EDT_NULL, video::EDT_SOFTWARE, video::EDT_BURNINGSVIDEO, video::EDT_DIRECT3D8, video::EDT_DIRECT3D9 and video::EDT_OPENGL. |
| windowSize,: | Size of the window or the video mode in fullscreen mode. |
| bits,: | Bits per pixel in fullscreen mode. Ignored if windowed mode. |
| fullscreen,: | Should be set to true if the device should run in fullscreen. Otherwise the device runs in windowed mode. |
| stencilbuffer,: | Specifies if the stencil buffer should be enabled. Set this to true, if you want the engine be able to draw stencil buffer shadows. Note that not all devices are able to use the stencil buffer. If they don't no shadows will be drawn. |
| vsync,: | Specifies vertical syncronisation: If set to true, the driver will wait for the vertical retrace period, otherwise not. |
| receiver,: | A user created event receiver. |
| IRRLICHT_API IrrlichtDevice* IRRCALLCONV irr::createDeviceEx | ( | const SIrrlichtCreationParameters & | parameters | ) |
Creates an Irrlicht device with the option to specify advanced parameters.
Usually you should used createDevice() for creating an Irrlicht Engine device. Use this function only if you wish to specify advanced parameters like a window handle in which the device should be created.
| parameters,: | Structure containing advanced parameters for the creation of the device. See irr::SIrrlichtCreationParameters for details. |