DEVNOTES.md 1.79 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
Also known as "Really Bad Technical Documentation"

These are mostly notes I create as I go along, marking potential gotchas for people who might try to extend my code.
Some day I'll try and add an overview of the code structure, what each class does, etc.

Development Environment
=======================

I personally launch ES in windowed mode with a smaller resolution than my monitor and with debug text enabled.

11
`emulationstation --windowed --debug --resolution 1280 720`
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35


Creating a new GuiComponent
===========================

You probably want to override:

	`bool input(InputConfig* config, Input input);`
		Check if some input is mapped to some action with `config->isMappedTo("a", input);`.
		Check if an input is "pressed" with `input.value != 0` (input.value *can* be negative in the case of axes).

	`void update(int deltaTime);`
		`deltaTime` is in milliseconds.

	`void render(const Eigen::Affine3f& parentTrans);`
		You probably want to do `Eigen::Affine3f trans = parentTrans * getTransform();` to get your final "modelview" matrix.
		Apply the modelview matrix with `Renderer::setMatrix(const Eigen::Affine3f&)`.
		Render any children the component may have with `renderChildren(parentTrans);`.


Creating a new GameListView Class
=================================

1. Don't allow the user to navigate to the root node's parent. If you use a stack of some sort to keep track of past cursor states this will be a natural side effect.
36 37 38 39 40 41 42 43 44 45



Creating a new Component
========================

If your component is not made up of other components, and you draw something to the screen with OpenGL, make sure:

* Your vertex positions are rounded before you render (you can use round(float) in Util.h to do this).
* Your transform matrix's translation is rounded (you can use roundMatrix(affine3f) in Util.h to do this).