Class TIrrlichtDevice

DescriptionHierarchyFieldsMethodsProperties

Unit

Irrlicht

Declaration

type TIrrlichtDevice = class(TReferenceCounted)

Description

The Main Engine Class

Hierarchy

Overview

Methods

Public constructor Create(const Params: TIrrlichtCreationParameters); overload;
Public constructor Create(DriverType: TVideoDriverType; const WindowSize: TSize; BitsPerPixel: LongWord = 16; FullScreen: Boolean = False; StencilBuffer: Boolean = False; VSync: Boolean = False; Receiver: TCustomEventReceiver = nil); overload;
Public constructor Create(DriverType: TVideoDriverType = vdtSoftware); overload;
Public destructor Destroy; override;
Public function ActivateJoysticks: TJoystickInfo; inline;
Public function GetGammaRamp: TGammaRamp; inline;
Public function GetVideoModeList: TVideoModeList; inline;
Public function IsFullScreen: Boolean; inline;
Public class function IsVideoDriverSupported(Driver: TVideoDriverType): Boolean;
Public function IsWindowActive: Boolean; inline;
Public function IsWindowFocused: Boolean; inline;
Public function IsWindowMinimized: Boolean; inline;
Public function PostEventFromUser(Event: TIrrlichtEvent): Boolean; inline;
Public function Run: Boolean; inline;
Public procedure ClearSystemMessages; inline;
Public procedure CloseDevice; inline;
Public procedure MaximizeWindow; inline;
Public procedure MinimizeWindow; inline;
Public procedure RestoreWindow; inline;
Public procedure SetGammaRamp(const Ramp: TGammaRamp); inline;
Public procedure SetInputReceivingSceneManager(Manager: TSceneManager); inline;
Public procedure Sleep(Milliseconds: LongWord; PauseTimer: Boolean = False); inline;
Public procedure Yield; inline;

Properties

Public property ColorFormat: TColorFormat read GetColorFormat;
Public property CursorControl: TCursorControl read FCursorControl;
Public property DeviceType: TDeviceType read GetDeviceType;
Public property EventReceiver: TCustomEventReceiver read FReceiver write FReceiver;
Public property FileSystem: TFileSystem read FFileSystem;
Public property GUIEnvironment: TGUIEnvironment read FGUIEnvironment;
Public property Logger: TLogger read FLogger;
Public property OSOperator: TOSOperator read FOSOperator;
Public property Resizable: Boolean read FResizable write SetResizable;
Public property SceneManager: TSceneManager read FSceneManager;
Public property Timer: TDeviceTimer read FTimer;
Public property Version: AnsiString read GetVersion;
Public property VideoDriver: TVideoDriver read FDriver;
Public property WindowCaption: StringType read FWindowCaption write SetWindowCaption;

Description

Methods

Public constructor Create(const Params: TIrrlichtCreationParameters); overload;

Creates and starts a new device from a parameter set.

Public constructor Create(DriverType: TVideoDriverType; const WindowSize: TSize; BitsPerPixel: LongWord = 16; FullScreen: Boolean = False; StencilBuffer: Boolean = False; VSync: Boolean = False; Receiver: TCustomEventReceiver = nil); overload;

Creates an Irrlicht device.

If you need more parameters to be passed to the creation of the Irrlicht Engine device, use the constructor taking an TIrrlichtCreationParameters argument.

Parameters
DriverType
Type of the device. This can currently be vdtNull, vdtSoftware, vdtBurningsVideo, vdtDirect3D8, vdtDirect3D9 and vdtOpenGL.
WindowSize
Size of the window or the video mode in fullscreen mode.
BitsPerPixel
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.
Public constructor Create(DriverType: TVideoDriverType = vdtSoftware); overload;

Overloaded for default parameters.

Public destructor Destroy; override;

Frees allocated resources.

Public function ActivateJoysticks: TJoystickInfo; inline;

Activates all available Joysticks and generates events for them. Irrlicht contains support for joysticks, but does not generate joystick events by default, as this would consume joystick info that 3rd party libraries might rely on. Call this method to activate joystick support in Irrlicht and to receive TJoystickEvent events. The returned object is managed by the engine.

Returns

Information about the activated Joysticks, if any, else nil.

Public function GetGammaRamp: TGammaRamp; inline;

Get the current Gamma Value for the Display.

Public function GetVideoModeList: TVideoModeList; inline;

Gets a list with all video modes available.

Public function IsFullScreen: Boolean; inline;

Checks if the Irrlicht window is running in fullscreen mode.

Public class function IsVideoDriverSupported(Driver: TVideoDriverType): Boolean;

Check if a driver type is supported by the engine.

Public function IsWindowActive: Boolean; inline;

Returns if the window is active.

Public function IsWindowFocused: Boolean; inline;

Checks if the Irrlicht window has focus.

Public function IsWindowMinimized: Boolean; inline;

Checks if the Irrlicht window is minimized.

Public function PostEventFromUser(Event: TIrrlichtEvent): Boolean; inline;

Sends a user created event to the engine.

Public function Run: Boolean; inline;

Runs the device.

Public procedure ClearSystemMessages; inline;

Remove messages pending in the system message loop.

Public procedure CloseDevice; inline;

Notifies the device that it should close itself.

Public procedure MaximizeWindow; inline;

Maximizes the window if possible.

Public procedure MinimizeWindow; inline;

Minimizes the window if possible.

Public procedure RestoreWindow; inline;

Restore the window to normal size if possible.

Public procedure SetGammaRamp(const Ramp: TGammaRamp); inline;

Set the current Gamma Value for the Display.

Public procedure SetInputReceivingSceneManager(Manager: TSceneManager); inline;

Sets the input receiving scene manager.

Public procedure Sleep(Milliseconds: LongWord; PauseTimer: Boolean = False); inline;

Pause execution and let other processes to run for a specified amount of time.

Public procedure Yield; inline;

Cause the device to temporarily pause execution and let other processes run.

Properties

Public property ColorFormat: TColorFormat read GetColorFormat;

Get the current color format of the window.

Public property CursorControl: TCursorControl read FCursorControl;

Provides access to the cursor control.

Public property DeviceType: TDeviceType read GetDeviceType;

Get the type of the device.

Public property EventReceiver: TCustomEventReceiver read FReceiver write FReceiver;

Provides access to the current event receiver.

Public property FileSystem: TFileSystem read FFileSystem;

Provides access to the virtual file system.

Public property GUIEnvironment: TGUIEnvironment read FGUIEnvironment;

Provides access to the 2d user interface environment.

Public property Logger: TLogger read FLogger;

Provides access to the message logger.

Public property OSOperator: TOSOperator read FOSOperator;

Provides access to the operation system operator object.

Public property Resizable: Boolean read FResizable write SetResizable;

Sets if the window should be resizable in windowed mode.

Public property SceneManager: TSceneManager read FSceneManager;

Provides access to the scene manager.

Public property Timer: TDeviceTimer read FTimer;

Provides access to the engine's timer.

Public property Version: AnsiString read GetVersion;

Get the version of the engine.

Public property VideoDriver: TVideoDriver read FDriver;

Provides access to the video driver for drawing 3d and 2d geometry.

Public property WindowCaption: StringType read FWindowCaption write SetWindowCaption;

The caption of the window.

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22