PCSX2 Documentation: Difference between revisions

From PCSX2 Wiki
Jump to navigation Jump to search
mNo edit summary
(Add a link to the ipc protocol)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page is an attempt to clearly document the PCSX2 code, to make life easier for those who wish to join the project.
==Building and Compiling PCSX2==
*[[PCSX2 Documentation/Compiling on Windows|Compiling on Windows]]
*[[PCSX2 Documentation/Compiling on Linux|Compiling on Linux]]
*[[PCSX2 Documentation/PCSX2 Build Scripts|PCSX2 Build Scripts]]
*[[PCSX2 Documentation/Chroot and 64-bit Linux|Chroot and 64-bit Linux]]
*[[PCSX2 Documentation/GNU Debugger Tips|GNU Debugger Tips]]
*[[PCSX2 Documentation/Git Survival Guide|Git Survival Guide]]
*[[PCSX2 Documentation/How to Create Useful and Valid Issues|How to Create Useful and Valid Issues]]
*[[PCSX2 Documentation/Commenting Etiquette|Commenting Etiquette]]
*[[PCSX2 Documentation/Code Formatting Guidelines|Code Formatting Guidelines]]
*[[PCSX2 Documentation/Contributing To-Do List|Contributing To-Do List]]
*[[PCSX2 Documentation/Google Code svn repository comments archive|Google Code svn repository comments archive]]


==Contributing to PCSX2 Documentation on the wiki==
==WxWidgets Framework==
*[[PCSX2 Documentation/Measuring the Benefits of wxWidgets|Measuring the Benefits of wxWidgets]]
*[[PCSX2 Documentation/WxWidgets Coding Strategies|WxWidgets Coding Strategies]]
*[[PCSX2 Documentation/The PCSX2 Program Flow|The PCSX2 Program Flow]]


To separate documentation pages from the ordinary wiki pages all new pages should be created with '''PCSX2 Documentation/''' prefix (example [[PCSX2 Documentation/Git Survival Guide]]). All pages should be linked to this page using navigation infobox (see below) or at least linked to a page that is in turn linked to this page. This will help in keeping a robust and easy to use structure. Similar pages may also be included in a number of categories (especially if there are a number of such pages).
==Threading==
*[[PCSX2 Documentation/Passing Settings Between Threads|Passing Settings Between Threads]]
*[[PCSX2 Documentation/Threading Basics|Threading Basics]]
*[[PCSX2 Documentation/Threading Advanced|Threading Advanced]]
*[[PCSX2 Documentation/Thread Synchronization|Thread Synchronization]]
*[[PCSX2 Documentation/Thread Counting|Thread Counting]]
*[[PCSX2 Documentation/Benchmarking Multithreaded PCSX2|Benchmarking Multithreaded PCSX2]]
*[[PCSX2 Documentation/Threading VU1|Threading VU1]]


NOTE TO DEVELOPERS: Please feel free to rearrange the articles in a way that makes more sense, or matches the structure of the PCSX2 code.
==PCSX2 Core==
*[[PCSX2 Documentation/PCSX2 Optimization|PCSX2 Optimization]]
*[[PCSX2 Documentation/So maybe it's about time we explained VTLB|So maybe it's about time we explained VTLB]]
*[[PCSX2 Documentation/Events o' Plenty|Events o' Plenty]]
*[[PCSX2 Documentation/Recompilers: All 'dems buzzwords?|Recompilers: All 'dems buzzwords?]]
*[[PCSX2 Documentation/C++ exceptions can be an optimization|C++ exceptions can be an optimization]]
*[[PCSX2 Documentation/What's clamping? And why do we need it?|What's clamping? And why do we need it?]]
*[[PCSX2 Documentation/PS2 VU (Vector Unit) Documentation Part 1|PS2 VU (Vector Unit) Documentation Part 1]]
*[[PCSX2 Documentation/A new kind of fullscreen!|A new kind of fullscreen!]]
*[[PCSX2 Documentation/Introduction to Dynamic Recompilation|Introduction to Dynamic Recompilation]]
*[[PCSX2 Documentation/The return of the Commandline!|The return of the Commandline!]]
*[[PCSX2 Documentation/Advanced memory management|Advanced memory management]]
*[[PCSX2 Documentation/VirtualAlloc on Linux|VirtualAlloc on Linux]]
*[[PCSX2 Documentation/PS2's Programmable DMA|PS2's Programmable DMA]]
*[[PCSX2 Documentation/MSVC 2008 optimizer fail|MSVC 2008 optimizer fail]]
*[[PCSX2 Documentation/Path 3 Masking / Geometry Syncing|Path 3 Masking / Geometry Syncing]]
*[[PCSX2 Documentation/MMU mini-series|MMU mini-series]]
*[[PCSX2 Documentation/Virtual Memory|Virtual Memory]]
*[[PCSX2 Documentation/Nightmare on Floating-Point Street|Nightmare on Floating-Point Street]]
*[[PCSX2 Documentation/64-bit Recompilation|64-bit Recompilation]]
*[[PCSX2_Documentation/PCSX2_EE_Recompiler|EE Recompiler Internal]]
*[[PCSX2_Documentation/IPC_Protocol|IPC Protocol]]


==PCSX2 Plugins==
*[[PCSX2 Documentation/PCSX2 Plugin Interface|PCSX2 Plugin Interface]]


<!--"Work safe, work smart. Your future depends on it. Now arriving at Sector C Test Labs and Control Facilities"-->
===Graphics Synthesizer===
*[[PCSX2 Documentation/Graphics Synthesizer, GPUs and Dual Cores|Graphics Synthesizer, GPUs and Dual Cores]]
*[[PCSX2 Documentation/GSdx Demystified|GSdx Demystified]]
*[[PCSX2 Documentation/GSdx Debug|GSdx Debug]]


{{PCSX2 Documentation Navbox| state=plain}}
===Sound===
*[[PCSX2 Documentation/SPU2 is more than just sound!|SPU2 is more than just sound!]]
*[[PCSX2 Documentation/Reverb Engine|Reverb Engine]]
 
==Translation Info==
*[[PCSX2 Documentation/Supported Languages|Supported Languages]]
*[[PCSX2 Documentation/Translation Guide|Translation Guide]]
*[[PCSX2 Documentation/Using Poedit|Using Poedit]]
 
 
{{PCSX2 Documentation Navbox}}

Latest revision as of 09:04, 1 September 2020

Building and Compiling PCSX2

WxWidgets Framework

Threading

PCSX2 Core

PCSX2 Plugins

Graphics Synthesizer

Sound

Translation Info