mirror of https://github.com/OpenTTD/OpenTTD.git
110 lines
3.2 KiB
C++
110 lines
3.2 KiB
C++
/* $Id$ */
|
|
|
|
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file video_driver.hpp Base of all video drivers. */
|
|
|
|
#ifndef VIDEO_VIDEO_DRIVER_HPP
|
|
#define VIDEO_VIDEO_DRIVER_HPP
|
|
|
|
#include "../driver.h"
|
|
#include "../core/geometry_type.hpp"
|
|
#include <vector>
|
|
|
|
/** The base of all video drivers. */
|
|
class VideoDriver : public Driver {
|
|
public:
|
|
/**
|
|
* Mark a particular area dirty.
|
|
* @param left The left most line of the dirty area.
|
|
* @param top The top most line of the dirty area.
|
|
* @param width The width of the dirty area.
|
|
* @param height The height of the dirty area.
|
|
*/
|
|
virtual void MakeDirty(int left, int top, int width, int height) = 0;
|
|
|
|
/**
|
|
* Perform the actual drawing.
|
|
*/
|
|
virtual void MainLoop() = 0;
|
|
|
|
/**
|
|
* Change the resolution of the window.
|
|
* @param w The new width.
|
|
* @param h The new height.
|
|
* @return True if the change succeeded.
|
|
*/
|
|
virtual bool ChangeResolution(int w, int h) = 0;
|
|
|
|
/**
|
|
* Change the full screen setting.
|
|
* @param fullscreen The new setting.
|
|
* @return True if the change succeeded.
|
|
*/
|
|
virtual bool ToggleFullscreen(bool fullscreen) = 0;
|
|
|
|
/**
|
|
* Callback invoked after the blitter was changed.
|
|
* This may only be called between AcquireBlitterLock and ReleaseBlitterLock.
|
|
* @return True if no error.
|
|
*/
|
|
virtual bool AfterBlitterChange()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Acquire any lock(s) required to be held when changing blitters.
|
|
* These lock(s) may not be acquired recursively.
|
|
*/
|
|
virtual void AcquireBlitterLock() { }
|
|
|
|
/**
|
|
* Release any lock(s) required to be held when changing blitters.
|
|
* These lock(s) may not be acquired recursively.
|
|
*/
|
|
virtual void ReleaseBlitterLock() { }
|
|
|
|
virtual bool ClaimMousePointer()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Whether the driver has a graphical user interface with the end user.
|
|
* Or in other words, whether we should spawn a thread for world generation
|
|
* and NewGRF scanning so the graphical updates can keep coming. Otherwise
|
|
* progress has to be shown on the console, which uses by definition another
|
|
* thread/process for display purposes.
|
|
* @return True for all drivers except null and dedicated.
|
|
*/
|
|
virtual bool HasGUI() const
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* An edit box lost the input focus. Abort character compositing if necessary.
|
|
*/
|
|
virtual void EditBoxLostFocus() {}
|
|
|
|
/**
|
|
* Get the currently active instance of the video driver.
|
|
*/
|
|
static VideoDriver *GetInstance() {
|
|
return static_cast<VideoDriver*>(*DriverFactoryBase::GetActiveDriver(Driver::DT_VIDEO));
|
|
}
|
|
};
|
|
|
|
extern char *_ini_videodriver;
|
|
extern std::vector<Dimension> _resolutions;
|
|
extern Dimension _cur_resolution;
|
|
extern bool _rightclick_emulate;
|
|
|
|
#endif /* VIDEO_VIDEO_DRIVER_HPP */
|