fsIHardware.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        31/3/2014   11:03
*
*       File:           fsIHardware.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Hardware / platform related api
*
*********************************************************************/
 
#ifndef fsIHardwarehdr
#define fsIHardwarehdr
 
#include <memory>
 
#include <fsCore/fsStr.h>
#include <fsCore/fsPoint.h>
 
struct fsDisplayInfo;
class fsCResourceName;
 
class fsIHardware
{
public:
 
        enum ePlatform
        {
                eWINDOWS = 0,
                eOSX,
                eMOBILE,
                eWINUWP
        };
 
#if defined fsDesktop
        virtual void hardwareCursorInit() = 0;
        virtual void hardwareCursorUninit() = 0;
        virtual void hardwareCursorChange(const fsStr& pID) = 0;
        virtual void appMinimize() = 0;
        virtual void appMaximize() = 0;
        virtual void windowedDisplayModeSet(fsS32 pWidth, fsS32 pHeight, fsS32 pRefresh, fsBool pFullScreen) {};
        virtual void windowedDisplayModesEnumerate(fsDisplayInfo*& pAvailableModeList, fsS32& pNumModesInList) = 0;
 
        virtual void appHideEnable() {}
#endif
 
    virtual void cursorPosSet(const fsVec2d& pPos) {};
 
        virtual void hardwareCursorEnabledSet(fsBool pEnabled) const = 0;
 
        virtual void hardwareCursorSet(const fsCResourceName& pFilename, fsBool pFlipped) {};
 
        void freeMemoryReset();
        fsU32 freeMemoryPercentageGet();
 
        void wallpaperApply(const fsCResourceName& pWallpaper);
 
        void update(fsS32 pDeltaMs);
 
 
        virtual void timeScaleSet(fsF32 pScale) = 0;
 
        virtual void engineCacheFlush() const {};
 
        virtual fsS32 volumeGet() const { return 0; }
 
        virtual fsPoint currentDisplayModeResolutionGet() const { return fsPoint(0, 0); }
 
        virtual fsBool smallDeviceGet() const = 0;
 
        virtual fsU64 utcTimeGet() const = 0;
        virtual ePlatform platformGet() const = 0;
 
        virtual fsStr sdkVersionStringGet() const = 0;
 
        virtual fsStr appDataFolderGet() const = 0;
        virtual fsBool multipleAppInstances() const = 0;
        virtual fsBool processRunning(const fsStr& pProcessName) const = 0;
 
        virtual void browserLaunch(const fsStr& pUrl) const = 0;
        virtual fsBool windowedModePossibleGet() const = 0;
 
        static std::unique_ptr<fsIHardware> create();
 
        virtual ~fsIHardware();
 
protected:
 
        virtual fsU32 freeMemoryResetDo() { return 0; }
        virtual fsU32 freeMemoryPercentageGetDo() const { return 0; }
 
#if defined fsDesktop
        virtual void wallpaperApplyDo(const fsCResourceName& pWallpaper) = 0;
#endif
 
        virtual void rndSeedDo() const = 0;
 
        virtual void updateDo(fsS32 pDeltaMs) {}
 
        fsIHardware();
 
private:
 
        void rndSeed() const;
 
        fsU32 mLowestFreeMemory;
};
 
#endif