summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source
Commit message (Collapse)AuthorAgeFilesLines
* emumem: A little more speedup. cache and specific change syntax, and are ↵ Olivier Galibert2020-05-251-12/+9
| | | | | | | | | | | | | | | | not pointers anymore [O. Galibert] The last(?) two changes are: - Add a template parameter to everything (theoretically the address space width, in practice a level derived from it to keep as much compatibility between widths as possible) so that the shift size becomes a constant. - Change the syntax of declaring and initializing the caches and specifics so that they're embedded in the owner device. Solves lifetime issues and also removes one indirection (looking up the base dispatch pointer through the cache/specific pointer).
* Fix smartquotes by disabling them: While smartquotes are somewhat ↵ Firehawke2020-04-211-0/+4
| | | | configurable, it's better if we don't use them at all. Makes sure there are no hidden pit traps for the users. (#6576)
* Add a tip on how to enter the debugger. R. Belmont2020-02-061-1/+1
|
* dialong -> dialog (nw) Angelo Salese2020-01-301-1/+1
|
* Happy New Year 2020 (nw) (#6128) Stiletto2020-01-044-7/+7
| | | Happy New Year 2020 (nw) (#6128)
* Update documentation (nw) Firehawke2019-11-254-3/+47
| | | | | | | | * Update MAME docs revision to 0.216 * Add FAQ question about autofire with walkthrough of setup process. * Add VSCode .gitignore for RST compilation temporary folder (/docs/source/_build) * Add a caveat about autofire+normal fire mapping * Add -lowlatency to the docs.
* doc: document vulkan and d3d12 as possible bgfx rendering backends (nw) algestam2019-11-061-1/+3
|
* (nw) fix MPU4 video crash, clean up a little Vas Crabb2019-10-271-1/+1
|
* Make devdelegate more like devcb for configuration. This is a Vas Crabb2019-10-261-15/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | fundamental change to show device delegates are configured. Device delegates are now aware of the current device during configuration and will resolve string tags relative to it. This means that device delegates need a device to be supplied on construction so they can find the machine configuration object. There's a one-dimensional array helper to make it easier to construct arrays of device delegates with the same owner. (I didn't make an n-dimensional one because I didn't hit a use case, but it would be a simple addition.) There's no more bind_relative_to member - just call resolve() like you would for a devcb. There's also no need to cast nullptr when creating a late bind device delegate. The flip side is that for an overloaded or non-capturing lambda you'll need to cast to the desired type. There is one less conditional branch in the hot path for calls for delegates bound to a function pointer of member function pointer. This comes at the cost of one additional unconditional branch in the hot path for calls to delegates bound to functoids (lambdas, functions that don't take an object reference, other callable objects). This applies to all delegates, not just device delegates. Address spaces will now print an error message if a late bind error is encountered while installing a handler. This will give the range and address range, hopefully making it easier to guess which memory map is faulty. For the simple case of allowing a device_delegate member to be configured, use a member like this: template <typename... T> void set_foo(T &&...args) { m_foo_cb.set(std::forward<T>(args)...); } For a case where different delegates need to be used depending on the function signature, see src/emu/screen.h (the screen update function setters). Device delegates now take a target specification and function pointer. The target may be: * Target omitted, implying the current device being configured. This can only be used during configuration. It will work as long as the current device is not removed/replaced. * A tag string relative to the current device being configured. This can only be used during configuration. It will not be callable until .resolve() is called. It will work as long as the current device is not removed/replaced. * A device finder (required_device/optional_device). The delegate will late bind to the current target of the device finder. It will not be callable until .resolve() is called. It will work properly if the target device is replaced, as long as the device finder's base object isn't removed/replaced. * A reference to an object. It will be callable immediately. It will work as long as the target object is not removed/replaced. The target types and restrictions are pretty similar to what you already have on object finders and devcb, so it shouldn't cause any surprises. Note that dereferencing a device finder will changes the effect. To illustrate this: ... required_device<some_device> m_dev; ... m_dev(*this, "dev") ... // will late bind to "dev" relative to *this // will work if "dev" hasn't been created yet or is replaced later // won't work if *this is removed/replaced // won't be callable until resolve() is called cb1.set(m_dev, FUNC(some_device::w)); ... // will bind to current target of m_dev // will not work if m_dev is not resolved // will not work if "dev" is replaced later // will be callable immediately cb2.set(*m_dev, FUNC(some_device::w)); ... The order of the target and name has been reversed for functoids (lambdas and other callable objects). This allows the NAME macro to be used on lambdas and functoids. For example: foo.set_something(NAME([this] (u8 data) { m_something = data; })); I realise the diagnostic messages get ugly if you use NAME on a large lambda. You can still give a literal name, you just have to place it after the lambda rather than before. This is uglier, but it's intentional. I'm trying to drive developers away from a certain style. While it's nice that you can put half the driver code in the memory map, it detracts from readability. It's hard to visualise the memory range mappings if the memory map functions are punctuated by large lambdas. There's also slightly higher overhead for calling a delegate bound to a functoid. If the code is prettier for trivial lambdas but uglier for non-trivial lambdas in address maps, it will hopefully steer people away from putting non-trivial lambdas in memory maps. There were some devices that were converted from using plain delegates without adding bind_relative_to calls. I fixed some of them (e.g. LaserDisc) but I probably missed some. These will likely crash on unresolved delegate calls. There are some devices that reset delegates at configuration complete or start time, preventing them from being set up during configuration (e.g. src/devices/video/ppu2c0x.cpp and src/devices/machine/68307.cpp). This goes against the design principles of how device delegates should be used, but I didn't change them because I don't trust myself to find all the places they're used. I've definitely broken some stuff with this (I know about asterix), so report issues and bear with me until I get it all fixed.
* New working software list additions (#5772) Firehawke2019-10-231-0/+21
| | | | | | | | | * New working software list additions ----------------------------------- apple2_flop_orig: Gauntlet, Go (Hayden), Ghostbusters, Galactic Wars, Guderian [4am, Firehawke] * Add details on compiling MAME documentation. (nw)
* Allow per-layer blend modes supplied by driver for screens, as required Vas Crabb2019-07-271-3/+3
| | | | | | | | | for Laserdisc overlays. This is a change in behaviour, and it means that games like Golly! Ghost! will need an explicit blend mode specified in the XML. I'm not entirely happy with the situation, but a better, more general solution than this would require some serious refactoring to MAME's renderer.
* Make layout format more flexible: Vas Crabb2019-07-063-190/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * There is no longer a concept of "layers" - there are only screens and elements. * Elements are now instantiated with <element ref="..."> * Screens and elements can have explicit blending mode specified with blend="..." * Default blending mode for screens is "add" and default for other elements is "alpha" * Other supported modes are "none" and "multiply" * This removes the options to enable/disable layers individually - use views instead * Legacy layouts can still be loaded, and support won't be removed for at least a year The current artwork model is over-stretched. It's based on a Space Invaders cabinet model, and isn't applicable to a lot of the systems MAME emulates now. The fact that MAME has to switch to an "alternate" mode to deal with games like Golly! Ghost! without requiring pre-matted bitmaps shows that the Space Invaders model wasn't even adequate for general arcade use. It shows in that for a lot of the systems that heavily depend on artwork, people just seem to randomly choose layers for elements until they get something that works. Also, the fact that MAME will switch to an alternate (Golly! Ghost!) mode depending on the combination of elements is a trap for people learning to make artwork. There are cases that the current approach of implying the blending mode from the layer doesn't work with. Examples include LEDs behind diffusers (requires additive blending for layout elements), and mutliple stacked LCD panels (requires RGB multiplication for screens). For configurability, it's now a lot easier to make multiple views using groups. For example, if you want to make it possible to hide the control panel section of your layout, you can put the control panel elements in a group and create views with and without it. I will gradually migrate the internal artwork to use the new approach. I have an XSLT stylesheet that helps with this, but I'm not comfortable adding it because it isn't a complete solution and it still requires manul steps. I wanted to get the re-worked pointer handling done sooner so I could push them both at the same time, but unfortunately various things have prevented me from progressing as quickly as I wanted to. Sorry guys, that stuff's going to have to wait.
* Overhaul to advanced gun instructions (nw) Firehawke2019-05-281-18/+24
| | | | | | This cleans up spelling and other issues in the original text. This work is still prototype and will probably require fine-tuning between Vas and myself.
* (nw) Fedora users need this now that X11 XInput is enabled by default - no ↵ Vas Crabb2019-04-261-1/+1
| | | | clue about other Linuxes
* Merge pull request #4914 from kiall/docs-linux-lightguns R. Belmont2019-04-252-0/+58
|\ | | | | WIP: Document Linux Lightguns with Xinput
| * Document Linux Lightguns with Xinput Kiall Mac Innes2019-04-212-0/+58
| | | | | | | | | | | | Add a new doc page within the 'Advanced Configuration' section which describes how to enable Lighuns on Linux using the XInput lightgun provider.
* | doc: add python to list of required ubuntu packages (nw) Henrik Algestam2019-04-231-1/+1
|/
* (nw) Clean up the mess on master Vas Crabb2019-03-2611-490/+1661
| | | | | | | | | | | | | This effectively reverts b380514764cf857469bae61c11143a19f79a74c5 and c24473ddff715ecec2e258a6eb38960cf8c8e98e, restoring the state at 598cd5227223c3b04ca31f0dbc1981256d9ea3ff. Before pushing, please check that what you're about to push is sane. Check your local commit log and ensure there isn't anything out-of-place before pushing to mainline. When things like this happen, it wastes everyone's time. I really don't need this in a week when real work™ is busting my balls and I'm behind where I want to be with preparing for MAME release.
* Revert "conflict resolution (nw)" andreasnaive2019-03-2511-1661/+490
| | | | | This reverts commit c24473ddff715ecec2e258a6eb38960cf8c8e98e, reversing changes made to 009cba4fb8102102168ef32870892438327f3705.
* layout doc: reword (nw) hap2019-03-251-5/+4
|
* layout doc: correction and add inputraw (this one actually does work the way ↵ hap2019-03-241-6/+9
| | | | inputmask was documented before) (nw)
* Make -nonvram_save also inhibit saving of "battery" NVRAM for image devices AJR2019-02-191-1/+2
|
* (nw) omission, formatting Vas Crabb2019-02-181-2/+2
|
* (nw) misc stuff: Vas Crabb2019-02-181-3/+32
| | | | | | * Document cross-compilation options * Use lowercase for some libraries that are lowercase in system32 on Windows anyway * Make USE_BUNDLED_LIB_SDL2=0 not use the bundled SDL
* device_memory_interface.rst : Correct docs cam9002019-02-181-1/+1
|
* Add svg->pdf conversion support Olivier Galibert2019-01-281-0/+1
|
* slight logo update (nw) Vas Crabb2019-01-281-23/+64
|
* Initial implementation of new logo for docs (nw) (#4566) Firehawke2019-01-282-3/+34
| | | | | | | | * Initial implementation of new logo for docs (nw) Behold the power of SVG! * 100% gives the same results (nw)
* update docs (nw) Vas Crabb2019-01-282-6/+7
|
* Doc: Minor fix (nw) (#4547) algestam2019-01-221-2/+2
|
* Correct compilation packages (for #4507) and finish cleanup on previous docs ↵ Firehawke2019-01-132-9/+11
| | | | | | | | updates. (nw) (#4509) * Correct the compilation packages [partial for #4507] (nw) * Minor corrections, joymap adjustments (nw)
* make INI file loading examples match current behaviour at least (nw) Vas Crabb2019-01-121-28/+99
|
* better documentation for compiling on Windows (nw) Vas Crabb2019-01-121-9/+73
|
* 2018 -> 2019 changes (nw) Stiletto2019-01-103-4/+4
| | | * 2018 -> 2019 changes (nw)
* more command line doc cleanup (nw) Vas Crabb2019-01-111-30/+46
|
* Major formatting update for command line options, copyright/version update ↵ Firehawke2019-01-112-413/+1118
| | | | | | | | | | | | | | | | | | | | | (#4470) * Update copyrights and docs revision (nw) Updates copyright on existing 2018 entries to 2019 (and one 2016) Updates the docs compilation script to MAME 0.205 and 2019 copyright. * Further formatting overhauling (nw) Clamp to 80 column where possible; it makes it easier to track errant line breaks, etc. Also begin standardizing tab formatting and two spaces after period. * Further corrections to command line materials (nw) * More adjustments for Cuavas (nw) Getting closer to acceptable.
* Make informational verbs a bit more consistent, reduce copy/pasted code, a ↵ Vas Crabb2019-01-042-107/+314
| | | | slight performance improvement for reading localisation files, and more documentation clean-up/correction/clarification
* Case sensitivity training for INI (nw) (#4455) Firehawke2019-01-0311-285/+284
| | | | | | | | | | | | | | | | | | | | * Case sensitivity training for INI (nw) The world is not 100% Windows, so case sensitvity is needed. * Further standardization of the formatting (nw) More to go... * Pass 2 of new formatting wave (nw) More to go, though. * wave 3 of formatting cleanup (nw) Further adjustments and cleanups, including unwanted tabs. * Correct filtering instructions (nw)
* additional documentation on compiling MAME (nw) Vas Crabb2019-01-011-1/+268
|
* (nw) update some documentation and get the MAME and legacy MESS pages more ↵ Vas Crabb2018-12-251-3/+6
| | | | in sync. sorry if I've busted formatting, I can't currently build sphinx or man on this Windows notebook.
* srcclean and cleanup (nw) Vas Crabb2018-10-281-0/+6
|
* Clean up phrasing a bit on input from MG (nw) Firehawke2018-10-191-2/+2
|
* Update FAQ (nw) with HLSL/BGFX update info, old external OPL2 support ↵ Firehawke2018-10-191-3/+13
| | | | information
* Fixed broken document structure Wellington Uemura2018-10-041-18/+22
| | | | | | | * Those chapter numbers are auto generated by sphinx * Fix the chapters not been bold like the rest of the documentation * Fix chapter numbers not in sync with the rest of the documentation * Change the last two chapters to keep up with the document consistency * Fix bold for nscsi_full_device
* Misc. document fixes (nw) Scott Stone2018-09-262-4/+4
|
* Some more documentation structure fixes (nw) Scott Stone2018-09-241-4/+4
|
* Misc documentation fixes as brought up by other developers (nw) Scott Stone2018-09-241-4/+4
|
* reference fix (nw) Scott Stone2018-09-241-2/+2
|
* Started commandline documents update to dismiss items no longer in source ↵ Scott Stone2018-09-242-22/+145
| | | | and start listing recently added commands. More work to come. [Tafoid]
* Add missing short commands Wellington Uemura2018-09-131-6/+6
| | | I've noticed this while I was translating the manual.