mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-13 04:28:37 +00:00
f04056519a
This is a doxygen review for 4 header files that have been identified as high priority for GSoD: - advancedDetector.h - metaengine.h - engine.h - util.h It also adds doxy groups to other headers from this folder to make them appear properly in the structure.
84 lines
2.6 KiB
C
84 lines
2.6 KiB
C
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* This program 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; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program 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 this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef ENGINES_UTIL_H
|
|
#define ENGINES_UTIL_H
|
|
|
|
#include "common/array.h"
|
|
#include "common/scummsys.h"
|
|
#include "common/list.h"
|
|
#include "graphics/pixelformat.h"
|
|
#include "graphics/mode.h"
|
|
|
|
/**
|
|
* @defgroup engines_util Util
|
|
* @ingroup engines
|
|
*
|
|
* @brief Various utility functions related to engines.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Set up the graphics mode of the backend.
|
|
*/
|
|
void initCommonGFX();
|
|
|
|
/**
|
|
* Send a list of graphics modes to the backend so it can make a decision
|
|
* about the best way to set up the display hardware.
|
|
*
|
|
* Engines that switch between different virtual screen sizes during the game
|
|
* should call this function prior to any call to initGraphics. Engines that use
|
|
* only a single screen size do not need to call this function.
|
|
*/
|
|
void initGraphicsModes(const Graphics::ModeList &modes);
|
|
|
|
/**
|
|
* Set up the screen size and graphics mode of the backend.
|
|
*
|
|
* Shows various warnings on certain backend graphics
|
|
* transaction failures (aspect switch, fullscreen switch, etc.).
|
|
*
|
|
* Errors are returned when the backend is not able to switch to the specified
|
|
* mode.
|
|
*
|
|
* Defaults to 256 color palette mode if no graphics format is provided.
|
|
* Uses the preferred format of the backend if graphics format pointer is NULL.
|
|
* Finds the best compatible format if a list of graphics formats is provided.
|
|
*/
|
|
void initGraphics(int width, int height);
|
|
/**
|
|
* @overload
|
|
*/
|
|
void initGraphics(int width, int height, const Graphics::PixelFormat *format);
|
|
/**
|
|
* @overload
|
|
*/
|
|
void initGraphics(int width, int height, const Common::List<Graphics::PixelFormat> &formatList);
|
|
/**
|
|
* @overload
|
|
*/
|
|
void initGraphics3d(int width, int height);
|
|
/** @} */
|
|
#endif
|