Miroirs/mame
1
0
Fork 0
mirror of https://github.com/mamedev/mame.git synced 2024-11-16 07:48:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added a bunch of doxygen style comments in screen.h, regarding MCFG_SCREEN_* functions

Browse source
This commit is contained in:
angelosa 2015-07-07 18:10:36 +02:00
parent 75da7dd07f
commit 5942386e5e
1 changed files with 43 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
src/emu/screen.h
View file

@ -352,15 +352,58 @@ typedef device_type_iterator<&device_creator<screen_device>, screen_device> scre
#define MCFG_SCREEN_TYPE(_type) \
screen_device::static_set_type(*device, SCREEN_TYPE_##_type);
/*!
@brief Configures screen parameters for the given screen.
@param _pixclock Pixel Clock frequency value
@param _htotal Total number of horizontal pixels, including hblank period.
@param _hbend Horizontal pixel position for HBlank end event, also first pixel where screen rectangle is visible.
@param _hbstart Horizontal pixel position for HBlank start event, also last pixel where screen rectangle is visible.
@param _vtotal Total number of vertical pixels, including vblank period.
@param _vbend Vertical pixel position for VBlank end event, also first pixel where screen rectangle is visible.
@param _vbstart Vertical pixel position for VBlank start event, also last pixel where screen rectangle is visible.
*/
#define MCFG_SCREEN_RAW_PARAMS(_pixclock, _htotal, _hbend, _hbstart, _vtotal, _vbend, _vbstart) \
screen_device::static_set_raw(*device, _pixclock, _htotal, _hbend, _hbstart, _vtotal, _vbend, _vbstart);
/*!
@brief Sets the number of Frames Per Second for this screen
@param _rate FPS number
@deprecated Please use MCFG_SCREEN_RAW_PARAMS instead. Gives imprecise timings.
*/
#define MCFG_SCREEN_REFRESH_RATE(_rate) \
screen_device::static_set_refresh(*device, HZ_TO_ATTOSECONDS(_rate));
/*!
@brief Sets the vblank time of the given screen
@param _time Time parameter, in attotime value\
@deprecated Please use MCFG_SCREEN_RAW_PARAMS instead. Gives imprecise timings.
*/
#define MCFG_SCREEN_VBLANK_TIME(_time) \
screen_device::static_set_vblank_time(*device, _time);
/*!
@brief Sets total screen size, including H/V-Blanks
@param _width Screen horizontal size
@param _height Screen vertical size
@deprecated Please use MCFG_SCREEN_RAW_PARAMS instead. Gives imprecise timings.
*/
#define MCFG_SCREEN_SIZE(_width, _height) \
screen_device::static_set_size(*device, _width, _height);
/*!
@brief Sets screen visible area
@param _minx Screen left border
@param _maxx Screen right border, must be in N-1 format
@param _miny Screen top border
@param _maxx Screen bottom border, must be in N-1 format
@deprecated Please use MCFG_SCREEN_RAW_PARAMS instead. Gives imprecise timings.
*/
#define MCFG_SCREEN_VISIBLE_AREA(_minx, _maxx, _miny, _maxy) \
screen_device::static_set_visarea(*device, _minx, _maxx, _miny, _maxy);
#define MCFG_SCREEN_DEFAULT_POSITION(_xscale, _xoffs, _yscale, _yoffs) \