IrrlichtDevice.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_IRRLICHT_DEVICE_H_INCLUDED__
#define __I_IRRLICHT_DEVICE_H_INCLUDED__

#include "IReferenceCounted.h"
#include "dimension2d.h"
#include "IVideoDriver.h"
#include "EDriverTypes.h"
#include "EDeviceTypes.h"
#include "IEventReceiver.h"
#include "ICursorControl.h"
#include "IVideoModeList.h"
#include "ITimer.h"
#include "IOSOperator.h"

namespace irr
{
    class ILogger;
    class IEventReceiver;
    class IRandomizer;

    namespace io {
        class IFileSystem;
    } // end namespace io

    namespace gui {
        class IGUIEnvironment;
    } // end namespace gui

    namespace scene {
        class ISceneManager;
    } // end namespace scene


    class IrrlichtDevice : public virtual IReferenceCounted
    {
    public:


        virtual bool run() = 0;


        virtual void yield() = 0;


        virtual void sleep(u32 timeMs, bool pauseTimer=false) = 0;


        virtual video::IVideoDriver* getVideoDriver() = 0;


        virtual io::IFileSystem* getFileSystem() = 0;


        virtual gui::IGUIEnvironment* getGUIEnvironment() = 0;


        virtual scene::ISceneManager* getSceneManager() = 0;


        virtual gui::ICursorControl* getCursorControl() = 0;


        virtual ILogger* getLogger() = 0;


        virtual video::IVideoModeList* getVideoModeList() = 0;


        virtual IOSOperator* getOSOperator() = 0;


        virtual ITimer* getTimer() = 0;


        virtual IRandomizer* getRandomizer() const =0;


        virtual void setRandomizer(IRandomizer* r) =0;


        virtual IRandomizer* createDefaultRandomizer() const =0;


        virtual void setWindowCaption(const wchar_t* text) = 0;


        virtual bool isWindowActive() const = 0;


        virtual bool isWindowFocused() const = 0;


        virtual bool isWindowMinimized() const = 0;


        virtual bool isFullscreen() const = 0;


        virtual video::ECOLOR_FORMAT getColorFormat() const = 0;


        virtual void closeDevice() = 0;


        virtual const c8* getVersion() const = 0;


        virtual void setEventReceiver(IEventReceiver* receiver) = 0;


        virtual IEventReceiver* getEventReceiver() = 0;


        virtual bool postEventFromUser(const SEvent& event) = 0;


        virtual void setInputReceivingSceneManager(scene::ISceneManager* sceneManager) = 0;


        virtual void setResizable(bool resize=false) = 0;

        virtual void minimizeWindow() =0;

        virtual void maximizeWindow() =0;

        virtual void restoreWindow() =0;


        virtual bool activateJoysticks(core::array<SJoystickInfo>& joystickInfo) =0;

        virtual bool setGammaRamp(f32 red, f32 green, f32 blue,
                    f32 relativebrightness, f32 relativecontrast) =0;

        virtual bool getGammaRamp(f32 &red, f32 &green, f32 &blue,
                    f32 &brightness, f32 &contrast) =0;


        virtual void clearSystemMessages() = 0;


        virtual E_DEVICE_TYPE getType() const = 0;


        static bool isDriverSupported(video::E_DRIVER_TYPE driver)
        {
            switch (driver)
            {
                case video::EDT_NULL:
                    return true;
                case video::EDT_SOFTWARE:
#ifdef _IRR_COMPILE_WITH_SOFTWARE_
                    return true;
#else
                    return false;
#endif
                case video::EDT_BURNINGSVIDEO:
#ifdef _IRR_COMPILE_WITH_BURNINGSVIDEO_
                    return true;
#else
                    return false;
#endif
                case video::EDT_DIRECT3D8:
#ifdef _IRR_COMPILE_WITH_DIRECT3D_8_
                    return true;
#else
                    return false;
#endif
                case video::EDT_DIRECT3D9:
#ifdef _IRR_COMPILE_WITH_DIRECT3D_9_
                    return true;
#else
                    return false;
#endif
                case video::EDT_OPENGL:
#ifdef _IRR_COMPILE_WITH_OPENGL_
                    return true;
#else
                    return false;
#endif
                default:
                    return false;
            }
        }
    };

} // end namespace irr

#endif