ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update title capitalization and styling.

Pringo 2016-11-13 20:26:26 -08:00
parent a9c1c8bb02
commit 6db4f9fabc
1 changed files with 4 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
FifoPlayer-Overview.md

@ -1,5 +1,4 @@
## Introduction ## Introduction
---
FifoPlayer is a powerful developer tool for debugging graphics related issues. It can be used to record an emulated scene during emulation and to playback it arbitrarily often later on. FifoPlayer is a powerful developer tool for debugging graphics related issues. It can be used to record an emulated scene during emulation and to playback it arbitrarily often later on.
Furthermore, it allows for close inspection of each FIFO command sent to the GPU during emulation. Furthermore, it allows for close inspection of each FIFO command sent to the GPU during emulation.
@ -8,9 +7,7 @@ Users can just record a FIFO log and give it to devs, who can analyze the render
Also, having an automatically formatted FIFO command list very much eases the task of figuring out how a specific game's graphics are rendered and where it goes wrong in Dolphin. Also, having an automatically formatted FIFO command list very much eases the task of figuring out how a specific game's graphics are rendered and where it goes wrong in Dolphin.
FifoPlayer can restrict the render output to the objects of interest, effectively cleaning up any irritating "unrelated" objects. FifoPlayer can restrict the render output to the objects of interest, effectively cleaning up any irritating "unrelated" objects.
## How to Record a FIFO Log
### How to record a FIFO log
---
All of the FifoPlayer functionality requires a FIFO log to be recorded. This basically intercepts all commands sent to the GPU during the recording and stores them in a `.dff` file to allow easy playback and inspection. All of the FifoPlayer functionality requires a FIFO log to be recorded. This basically intercepts all commands sent to the GPU during the recording and stores them in a `.dff` file to allow easy playback and inspection.
@ -23,9 +20,7 @@ All of the FifoPlayer functionality requires a FIFO log to be recorded. This bas
- Scenes involving texture preloading can only be recorded properly since revision 3.5-173 ([198d60c5](https://github.com/dolphin-emu/dolphin/commit/198d60c5)). - Scenes involving texture preloading can only be recorded properly since revision 3.5-173 ([198d60c5](https://github.com/dolphin-emu/dolphin/commit/198d60c5)).
- When sharing FIFO logs with others, you should always post a screenshot of the recorded scene since FIFO logs aren't guaranteed to play back equally on all systems. - When sharing FIFO logs with others, you should always post a screenshot of the recorded scene since FIFO logs aren't guaranteed to play back equally on all systems.
## How to Play Back a FIFO Log
### How to play back a FIFO log
---
Developers will want to use this to see if they can reproduce issues locally. But it's also useful for users to verify that their recorded FIFO log actually works. Developers will want to use this to see if they can reproduce issues locally. But it's also useful for users to verify that their recorded FIFO log actually works.
@ -38,9 +33,7 @@ Developers will want to use this to see if they can reproduce issues locally. Bu
- WARNING: Dual Core mode is currently broken when using FifoPlayer. As a workaround, disable DC and set framelimit to a fixed value, e.g. 30. - WARNING: Dual Core mode is currently broken when using FifoPlayer. As a workaround, disable DC and set framelimit to a fixed value, e.g. 30.
- tl;dr: Disable Dual Core, Disable XFBs, set framelimit to 30. - tl;dr: Disable Dual Core, Disable XFBs, set framelimit to 30.
## How to Analyze a FIFO Log
### How to analyze a FIFO log
---
This is purely a developer tool because it requires strong knowledge of what GPU registers are and how they are used in the GPU FIFO. This is purely a developer tool because it requires strong knowledge of what GPU registers are and how they are used in the GPU FIFO.