2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2023-12-08 00:13:39 +08:00
|
|
|
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __CCDEVICE_H__
|
|
|
|
#define __CCDEVICE_H__
|
|
|
|
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "platform/PlatformMacros.h"
|
|
|
|
#include "base/Macros.h"
|
|
|
|
#include "base/Data.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
struct FontDefinition;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup platform
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @class Device
|
2021-12-25 10:04:45 +08:00
|
|
|
* @brief
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL Device
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/** Defines the alignment of text. */
|
|
|
|
enum class TextAlign
|
|
|
|
{
|
2021-12-25 10:04:45 +08:00
|
|
|
CENTER = 0x33, /** Horizontal center and vertical center. */
|
|
|
|
TOP = 0x13, /** Horizontal center and vertical top. */
|
|
|
|
TOP_RIGHT = 0x12, /** Horizontal right and vertical top. */
|
|
|
|
RIGHT = 0x32, /** Horizontal right and vertical center. */
|
|
|
|
BOTTOM_RIGHT = 0x22, /** Horizontal right and vertical bottom. */
|
|
|
|
BOTTOM = 0x23, /** Horizontal center and vertical bottom. */
|
|
|
|
BOTTOM_LEFT = 0x21, /** Horizontal left and vertical bottom. */
|
|
|
|
LEFT = 0x31, /** Horizontal left and vertical center. */
|
|
|
|
TOP_LEFT = 0x11, /** Horizontal left and vertical top. */
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
2023-05-31 20:14:31 +08:00
|
|
|
/** Defines the impact haptic feedback style. */
|
|
|
|
enum ImpactFeedbackStyle
|
|
|
|
{
|
|
|
|
ImpactFeedbackStyleLight = 0,
|
|
|
|
ImpactFeedbackStyleMedium,
|
|
|
|
ImpactFeedbackStyleHeavy
|
|
|
|
};
|
|
|
|
|
|
|
|
/** Defines the notification haptic feedback style. */
|
|
|
|
enum NotificationFeedbackType
|
|
|
|
{
|
|
|
|
NotificationFeedbackTypeSuccess = 0,
|
|
|
|
NotificationFeedbackTypeWarning,
|
|
|
|
NotificationFeedbackTypeError
|
|
|
|
};
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Gets the DPI of device
|
|
|
|
* @return The DPI of device.
|
|
|
|
*/
|
|
|
|
static int getDPI();
|
2023-11-06 00:19:44 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the device pixel ratio
|
|
|
|
*/
|
|
|
|
static float getPixelRatio();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* To enable or disable accelerometer.
|
|
|
|
*/
|
|
|
|
static void setAccelerometerEnabled(bool isEnabled);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the interval of accelerometer.
|
|
|
|
*/
|
|
|
|
static void setAccelerometerInterval(float interval);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Controls whether the screen should remain on.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param keepScreenOn One flag indicating that the screen should remain on.
|
|
|
|
*/
|
|
|
|
static void setKeepScreenOn(bool keepScreenOn);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Vibrate for the specified amount of time.
|
|
|
|
* If vibrate is not supported, then invoking this method has no effect.
|
|
|
|
* Some platforms limit to a maximum duration of 5 seconds.
|
|
|
|
* Duration is ignored on iOS due to API limitations.
|
|
|
|
* @param duration The duration in seconds.
|
|
|
|
*/
|
|
|
|
static void vibrate(float duration);
|
|
|
|
|
2023-05-31 20:14:31 +08:00
|
|
|
/**
|
|
|
|
* Prepare haptic feedback impact with selected style
|
|
|
|
* If haptic feedback is not supported, then invoking this method has no effect.
|
|
|
|
* @param style The style of the feedback.
|
|
|
|
*/
|
|
|
|
static void prepareImpactFeedbackGenerator(ImpactFeedbackStyle style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Generate haptic feedback impact with selected style
|
|
|
|
* If haptic feedback is not supported, then invoking this method has no effect.
|
|
|
|
*/
|
|
|
|
static void impactOccurred(ImpactFeedbackStyle style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Prepare haptic feedback notification
|
|
|
|
* If haptic feedback is not supported, then invoking this method has no effect.
|
|
|
|
* @param style The style of the feedback.
|
|
|
|
*/
|
|
|
|
static void prepareNotificationFeedbackGenerator();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Generate haptic feedback notification with selected type
|
|
|
|
* If haptic feedback is not supported, then invoking this method has no effect.
|
|
|
|
*/
|
|
|
|
static void notificationOccurred(NotificationFeedbackType type);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Prepare haptic feedback selection
|
|
|
|
* If haptic feedback is not supported, then invoking this method has no effect.
|
|
|
|
* @param style The style of the feedback.
|
|
|
|
*/
|
|
|
|
static void prepareSelectionFeedbackGenerator();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Generate haptic feedback selection changed
|
|
|
|
* If haptic feedback is not supported, then invoking this method has no effect.
|
|
|
|
*/
|
|
|
|
static void selectionChanged();
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Gets texture data for text.
|
|
|
|
*/
|
2023-03-11 22:10:18 +08:00
|
|
|
static Data getTextureDataForText(std::string_view text,
|
2021-12-25 10:04:45 +08:00
|
|
|
const FontDefinition& textDefinition,
|
|
|
|
TextAlign align,
|
|
|
|
int& width,
|
|
|
|
int& height,
|
|
|
|
bool& hasPremultipliedAlpha);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
private:
|
2022-07-16 10:43:05 +08:00
|
|
|
AX_DISALLOW_IMPLICIT_CONSTRUCTORS(Device);
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
// end group
|
|
|
|
/// @}
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
#endif /* __CCDEVICE_H__ */
|