mirror of
https://github.com/dolphin-emu/dolphin.git
synced 2025-01-18 20:11:16 +01:00
4288bfe0f9
Given this is actually a part of the Host interface, this should be placed with it. While we're at it, turn it into an enum class so that we don't dump its contained values into the surrounding scope. We can also make Host_Message take the enum type itself directly instead of taking a general int value. After this, it'll be trivial to divide out the rest of Common.h and remove the header from the repository entirely
109 lines
3.3 KiB
C++
109 lines
3.3 KiB
C++
// Copyright 2008 Dolphin Emulator Project
|
|
// Licensed under GPLv2+
|
|
// Refer to the license.txt file included.
|
|
|
|
// Core
|
|
|
|
// The external interface to the emulator core. Plus some extras.
|
|
// This is another part of the emu that needs cleaning - Core.cpp really has
|
|
// too much random junk inside.
|
|
|
|
#pragma once
|
|
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "Common/CommonTypes.h"
|
|
|
|
struct BootParameters;
|
|
|
|
namespace Core
|
|
{
|
|
bool GetIsThrottlerTempDisabled();
|
|
void SetIsThrottlerTempDisabled(bool disable);
|
|
|
|
void Callback_VideoCopiedToXFB(bool video_update);
|
|
|
|
enum class State
|
|
{
|
|
Uninitialized,
|
|
Paused,
|
|
Running,
|
|
Stopping,
|
|
Starting,
|
|
};
|
|
|
|
bool Init(std::unique_ptr<BootParameters> boot);
|
|
void Stop();
|
|
void Shutdown();
|
|
|
|
void DeclareAsCPUThread();
|
|
void UndeclareAsCPUThread();
|
|
|
|
std::string StopMessage(bool, const std::string&);
|
|
|
|
bool IsRunning();
|
|
bool IsRunningAndStarted(); // is running and the CPU loop has been entered
|
|
bool IsRunningInCurrentThread(); // this tells us whether we are running in the CPU thread.
|
|
bool IsCPUThread(); // this tells us whether we are the CPU thread.
|
|
bool IsGPUThread();
|
|
|
|
bool WantsDeterminism();
|
|
|
|
// [NOT THREADSAFE] For use by Host only
|
|
void SetState(State state);
|
|
State GetState();
|
|
|
|
void SaveScreenShot(bool wait_for_completion = false);
|
|
void SaveScreenShot(const std::string& name, bool wait_for_completion = false);
|
|
|
|
void Callback_WiimoteInterruptChannel(int _number, u16 _channelID, const void* _pData, u32 _Size);
|
|
|
|
// This displays messages in a user-visible way.
|
|
void DisplayMessage(const std::string& message, int time_in_ms);
|
|
|
|
void FrameUpdateOnCPUThread();
|
|
|
|
bool ShouldSkipFrame(int skipped);
|
|
void VideoThrottle();
|
|
void RequestRefreshInfo();
|
|
|
|
void UpdateTitle();
|
|
|
|
// Run a function as the CPU thread.
|
|
//
|
|
// If called from the Host thread, the CPU thread is paused and the current thread temporarily
|
|
// becomes the CPU thread while running the function.
|
|
// If called from the CPU thread, the function will be run directly.
|
|
//
|
|
// This should only be called from the CPU thread or the host thread.
|
|
void RunAsCPUThread(std::function<void()> function);
|
|
|
|
// for calling back into UI code without introducing a dependency on it in core
|
|
using StateChangedCallbackFunc = std::function<void(Core::State)>;
|
|
void SetOnStateChangedCallback(StateChangedCallbackFunc callback);
|
|
|
|
// Run on the Host thread when the factors change. [NOT THREADSAFE]
|
|
void UpdateWantDeterminism(bool initial = false);
|
|
|
|
// Queue an arbitrary function to asynchronously run once on the Host thread later.
|
|
// Threadsafe. Can be called by any thread, including the Host itself.
|
|
// Jobs will be executed in RELATIVE order. If you queue 2 jobs from the same thread
|
|
// then they will be executed in the order they were queued; however, there is no
|
|
// global order guarantee across threads - jobs from other threads may execute in
|
|
// between.
|
|
// NOTE: Make sure the jobs check the global state instead of assuming everything is
|
|
// still the same as when the job was queued.
|
|
// NOTE: Jobs that are not set to run during stop will be discarded instead.
|
|
void QueueHostJob(std::function<void()> job, bool run_during_stop = false);
|
|
|
|
// Should be called periodically by the Host to run pending jobs.
|
|
// WMUserJobDispatch will be sent when something is added to the queue.
|
|
void HostDispatchJobs();
|
|
|
|
void DoFrameStep();
|
|
|
|
} // namespace
|