Files
cocos4/native/cocos/engine/BaseEngine.h
T
qiuguohua eeb9d5c689 Merge the code of v3.3.1 platform adaptation layer into the development branch (#3958)
* 1、Merge platform adaptation layer code into the development branch
2、It passed the test in windows and ohos system

* 1、Merge platform adaptation layer code into the development branch
2、It passed the test in windows and ohos system

* 1、Fix github compile windows error

* 1、Fix github compile windows error

* 1. Adjust the code format;
2. Fix js automatic generation binding
3. Adjust github CI compilation

* 1. Adjust the code format;
2. Fix js automatic generation binding
3. Adjust github CI compilation

* Solve mac and ios compilation failure

* Fix the problem of compilation of Windows-side simulator

* 1. Adapt the simulator to a new adaptation layer;
2. Fix the compilation warning of ios, and the implicit conversion failed;
3. Fix the mac compilation error, due to the problem of adding the link identification -all_load;

* 1.Add the isDisplayStats and setDisplayStats method to the screen interface

* Fix clang-tidy compilation warning

* Fix clang-tidy compilation warning

* Repair the emulator, compatible with mac and win

* 1、Repair detailed errors, including name modification and calling method modification
2、Delete redundant files in the template directory
3、Change the vibrate interface to vibrator
4、Fix word spelling errors

* Rename interfaces to modules

* Replace CC_ASSERT with CCASSERT

* Replace CC_ASSERT with CCASSERT

Co-authored-by: qiuguohua <>
2021-10-27 10:51:02 +08:00

106 lines
3.3 KiB
C++

/****************************************************************************
Copyright (c) 2017-2021 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
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.
****************************************************************************/
#pragma once
#include <functional>
#include "base/Scheduler.h"
#include "base/TypeDef.h"
#include "platform/BasePlatform.h"
namespace cc {
class BaseEngine : public std::enable_shared_from_this<BaseEngine> {
public:
virtual ~BaseEngine();
using Ptr = std::shared_ptr<BaseEngine>;
/**
@brief Get operating system interface template.
*/
template <class T>
T* getInterface() const {
BasePlatform* platform = BasePlatform::getPlatform();
return platform->getInterface<T>();
}
/**
@brief Create default engine.
*/
static BaseEngine::Ptr createEngine();
/**
@brief Initialization engine interface.
*/
virtual int32_t init() = 0;
/**
@brief Run engine main logical interface.
*/
virtual int32_t run() = 0;
/**
@brief Pause engine main logical.
*/
virtual void pause() = 0;
/**
@brief Resume engine main logical.
*/
virtual void resume() = 0;
/**
@brief Restart engine main logical.
*/
virtual int restart() = 0;
/**
@brief Close engine main logical.
*/
virtual void close() = 0;
/**
@brief Gets the total number of frames in the main loop.
*/
virtual uint getTotalFrames() const = 0;
/**
* @brief Sets the preferred frame rate for main loop callback.
* @param fps The preferred frame rate for main loop callback.
*/
virtual void setPreferredFramesPerSecond(int fps) = 0;
using EventCb = std::function<void(const OSEvent&)>;
/**
@brief Add listening event callback.
*/
virtual void addEventCallback(OSEventType evtype, const EventCb& cb) = 0;
/**
@brief Remove listening event callback.
*/
virtual void removeEventCallback(OSEventType evtype) = 0;
using SchedulerPtr = std::shared_ptr<Scheduler>;
/**
@brief Get engine scheduler.
*/
virtual SchedulerPtr getScheduler() const = 0;
};
} // namespace cc