Line 26:
Line 26:
[[User:MetaFight|MetaFight]] 23:15, 30 March 2009 (UTC)
[[User:MetaFight|MetaFight]] 23:15, 30 March 2009 (UTC)
β
==The Preview==
+
==Installation and usage==
β
Since I'm too lazy to code a proper demo application I'm releasing the preview on top of [[Shiny Red Tank]].
+
===Installation===
+
Simply copy all the .c and .h files into your project (make sure the .c are accessible as ''source''s and .h accessible as ''include''s). Then, add <code>#include "HomeMenu.h"</code> where appropriate.
β
It's coming along well, but some of the stuff isn't implemented yet. An up-to-date "To Do" list can be found on the [http://code.google.com/p/libhomemenu/ SVN].
+
===Usage===
+
Call <code>HomeMenu_Init()</code> to set things up. Its parameters are:
+
* <code>int screenWidth</code> -- horizontal resolution of screen.
+
* <code>int screenHeight</code> -- vertical resolution of screen.
+
* <code>void* framebuffer0</code> -- pointer to the first framebuffer.
+
* <code>void* framebuffer1</code> -- pointer to the second framebuffer (Currently assumes double-buffering).
+
* <code>u8 framebufferIndex</code> -- index to last buffer drawn to [0, 1].
+
+
When you want to display the menu (when the user presses HOME), simply call <code>HomeMenu_Show()</code>.
+
+
Tip: If you have a callback setup for when the user holds down on the wiimote's powerbutton, add <code>HomeMenu_Hide()</code> to this callback to tell HomeMenu to relinquish execution control.
+
+
===Libwiisprite users===
+
Currently, the pointers to the framebuffers and the framebuffer index are stored in the <code>GameWindow</code> object as <code>private</code> members. [[Shiny Red Tank]] got around this problem by adding accessors to the <code>GameWindow</code> class. Hopefully, if there is enough demand, the accessors will be included in the next version of LWS (go ask!).
==Feedback==
==Feedback==