irrlicht.h File Reference

Main header file of the irrlicht, the only file needed to include. More...

Go to the source code of this file.

Namespaces

namespace irr

namespace irr::core

namespace irr::gui

namespace irr::io

namespace irr::scene

namespace irr::video

Functions

IRRLICHT_API IrrlichtDevice
*IRRCALLCONV createDevice (video::E_DRIVER_TYPE deviceType=video::EDT_SOFTWARE, const core::dimension2d< s32 > &windowSize=(core::dimension2d< s32 >(640, 480)), u32 bits=16, bool fullscreen=false, bool stencilbuffer=false, bool vsync=false, IEventReceiver *receiver=0, const c8 *sdk_version_do_not_use=IRRLICHT_SDK_VERSION)

Creates an Irrlicht device. The Irrlicht device is the root object for using the engine.

IRRLICHT_API IrrlichtDevice
*IRRCALLCONV createDeviceEx (const SIrrlichtCreationParameters &parameters)

Creates an Irrlicht device with the option to specify advanced parameters.

Detailed Description

Main header file of the irrlicht, the only file needed to include.

Definition in file irrlicht.h.

Function Documentation

IRRLICHT_API IrrlichtDevice* IRRCALLCONV irr::createDevice ( video::E_DRIVER_TYPE deviceType = video::EDT_SOFTWARE,

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

u32 bits = 16,

bool fullscreen = false,

bool stencilbuffer = false,

bool vsync = false,

IEventReceiver * receiver = 0,

const c8 * sdk_version_do_not_use = IRRLICHT_SDK_VERSION

)

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.
Parameters:

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.

sdk_version_do_not_use,: Don't use or change this parameter. Always set it to IRRLICHT_SDK_VERSION, which is done by default. This is needed for sdk version checks.

Returns:
Returns pointer to the created IrrlichtDevice or null if the device could not be created.

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:

parameters,: Structure containing advanced parameters for the creation of the device. See irr::SIrrlichtCreationParameters for details.

Returns:
Returns pointer to the created IrrlichtDevice or null if the device could not be created.


Namespaces
namespace	irr
namespace	irr::core
namespace	irr::gui
namespace	irr::io
namespace	irr::scene
namespace	irr::video
Functions
IRRLICHT_API IrrlichtDevice *IRRCALLCONV	createDevice (video::E_DRIVER_TYPE deviceType=video::EDT_SOFTWARE, const core::dimension2d< s32 > &windowSize=(core::dimension2d< s32 >(640, 480)), u32 bits=16, bool fullscreen=false, bool stencilbuffer=false, bool vsync=false, IEventReceiver receiver=0, const c8 sdk_version_do_not_use=IRRLICHT_SDK_VERSION)
	Creates an Irrlicht device. The Irrlicht device is the root object for using the engine.
IRRLICHT_API IrrlichtDevice *IRRCALLCONV	createDeviceEx (const SIrrlichtCreationParameters &parameters)
	Creates an Irrlicht device with the option to specify advanced parameters.