comparison src/video/ps3/SDL_ps3spe_c.h @ 3157:cce01ba54174 gsoc2009_ps3

Added comments, clean up.
author Martin Lowinski <martin@goldtopf.org>
date Thu, 27 Aug 2009 11:33:56 +0000
parents 0cf7bff804ad
children
comparison
equal deleted inserted replaced
3156:4ead4cef6b7b 3157:cce01ba54174
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 18
19 Sam Lantinga 19 Sam Lantinga
20 slouken@libsdl.org 20 slouken@libsdl.org
21 */ 21 */
22
23 /* This SPE API basically provides 3 ways to run and control a program
24 * on the SPE:
25 * - Start and stop the program (keepalive=0).
26 * SPE_Start() will implicitly boot up the program, create a thread and run
27 * the context.
28 * SPE_Stop() will join the (terminated) thread (may block) and return.
29 * - Boot the program and run it (keepalive=0).
30 * SPE_Boot() will create a context and load the program and finally start
31 * the context with SPE_Start().
32 * SPE_Stop() will savely end the program.
33 * - Boot, Run and send messages to the program (keepalive=1).
34 * Start the program by using one of the methods described above. When
35 * received the READY-message the program is in its infinite loop waiting
36 * for new messages.
37 * Every time you run the program, send SPU_START and the address of the
38 * according struct using SPE_SendMsg().
39 * SPE_WaitForMsg() will than wait for SPU_FIN and is blocking.
40 * SPE_Shutdown() sends SPU_EXIT and finally stops the program.
41 *
42 * Therefor the SPE program
43 * - either runs once and returns
44 * - or runs in an infinite loop and is controlled by messages.
45 */
46
22 #include "SDL_config.h" 47 #include "SDL_config.h"
23 48
24 #include "spulibs/spu_common.h" 49 #include "spulibs/spu_common.h"
25 50
26 #include <libspe2.h> 51 #include <libspe2.h>