mirror of
https://github.com/Armored-Dragon/overte.git
synced 2025-03-11 16:13:16 +01:00
103 lines
3.3 KiB
C++
103 lines
3.3 KiB
C++
//
|
|
// Created by Nissim Hadar on 2018/12/28
|
|
// Copyright 2013-2016 High Fidelity, Inc.
|
|
//
|
|
// Distributed under the Apache License, Version 2.0.
|
|
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
|
|
//
|
|
|
|
#ifndef hifi_PlatformInfoScriptingInterface_h
|
|
#define hifi_PlatformInfoScriptingInterface_h
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
class QScriptValue;
|
|
|
|
/**jsdoc
|
|
* The <code>PlatformInfo</code> API provides information about the computer and controllers being used.
|
|
*
|
|
* @namespace PlatformInfo
|
|
*
|
|
* @hifi-interface
|
|
* @hifi-client-entity
|
|
* @hifi-avatar
|
|
*/
|
|
class PlatformInfoScriptingInterface : public QObject {
|
|
Q_OBJECT
|
|
|
|
public slots:
|
|
/**jsdoc
|
|
* @function PlatformInfo.getInstance
|
|
* @deprecated This function is deprecated and will be removed.
|
|
*/
|
|
static PlatformInfoScriptingInterface* getInstance();
|
|
|
|
/**jsdoc
|
|
* Gets the operating system type.
|
|
* @function PlatformInfo.getOperatingSystemType
|
|
* @returns {string} <code>"WINDOWS"</code>, <code>"MACOS"</code>, or <code>"UNKNOWN"</code>.
|
|
*/
|
|
QString getOperatingSystemType();
|
|
|
|
/**jsdoc
|
|
* Gets information on the CPU.
|
|
* @function PlatformInfo.getCPUBrand
|
|
* @returns {string} Information on the CPU.
|
|
* @example <caption>Report the CPU being used.</caption>
|
|
* print("CPU: " + PlatformInfo.getCPUBrand());
|
|
* // Example: Intel(R) Core(TM) i7-7820HK CPU @ 2.90GHz
|
|
*/
|
|
QString getCPUBrand();
|
|
|
|
/**jsdoc
|
|
* Gets the number of logical CPU cores.
|
|
* @function PlatformInfo.getNumLogicalCores
|
|
* @returns {number} The number of logical CPU cores.
|
|
*/
|
|
unsigned int getNumLogicalCores();
|
|
|
|
/**jsdoc
|
|
* Returns the total system memory in megabytes.
|
|
* @function PlatformInfo.getTotalSystemMemoryMB
|
|
* @returns {number} The total system memory in megabytes.
|
|
*/
|
|
int getTotalSystemMemoryMB();
|
|
|
|
/**jsdoc
|
|
* Gets the graphics card type.
|
|
* @function PlatformInfo.getGraphicsCardType
|
|
* @returns {string} The graphics card type.
|
|
*/
|
|
QString getGraphicsCardType();
|
|
|
|
/**jsdoc
|
|
* Checks whether Oculus Touch controllers are connected.
|
|
* @function PlatformInfo.hasRiftControllers
|
|
* @returns {boolean} <code>true</code> if Oculus Touch controllers are connected, <code>false</code> if they aren't.
|
|
*/
|
|
bool hasRiftControllers();
|
|
|
|
/**jsdoc
|
|
* Checks whether Vive controllers are connected.
|
|
* @function PlatformInfo.hasViveControllers
|
|
* @returns {boolean} <code>true</code> if Vive controllers are connected, <code>false</code> if they aren't.
|
|
*/
|
|
bool hasViveControllers();
|
|
|
|
/**jsdoc
|
|
* Checks whether HTML on 3D surfaces (e.g., Web entities) is supported.
|
|
* @function PlatformInfo.has3DHTML
|
|
* @returns {boolean} <code>true</code> if the current display supports HTML on 3D surfaces, <code>false</code> if it
|
|
* doesn't.
|
|
*/
|
|
bool has3DHTML();
|
|
|
|
/**jsdoc
|
|
* Checks whether Interface is running on a stand-alone HMD device (CPU incorporated into the HMD display).
|
|
* @function PlatformInfo.isStandalone
|
|
* @returns {boolean} <code>true</code> if Interface is running on a stand-alone device, <code>false</code> if it isn't.
|
|
*/
|
|
bool isStandalone();
|
|
};
|
|
|
|
#endif // hifi_PlatformInfoScriptingInterface_h
|