SDL API Writers Guide

Just a rough guide to make all the function and structure pages look the same.

Please use FunctionTemplate or StructureTemplate templates when creating a new API page.

Most of the formatting is self-explanatory in the templates...

Otherwise here are some specifics:

'''Note:''' Here is the note.

`SDL_ThisFunction` rocks!.

Please use ["SDL_Init"] before calling this function.

The function may return `NULL`, unless called with `SDL_Function(foo)`.

== Structure Data ==
||<tablewidth="100%">'''flags'''||Surface flags||
||'''format'''||Pixel format||
||'''w, h'''||Width and height of the surface||

||<tablewidth="100%">`SDL_SWSURFACE`||Create the video surface in system memory||
||`SDL_HWSURFACE`||Create the video surface in video memory||
||`SDL_ASYNCBLIT`||Enables the use of asynchronous updates of the display surface. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems.||

== Comments ==

=== Reading one pixel from a video surface ===
''by John Doe - email at moo dot com''

Please lock your surface before calling this function.
{{{
int getpixel(int x, int y) {
   etc
}
}}.}

Comments

Reading one pixel from a video surface

by John Doe - email at moo dot com

Please lock your surface before calling this function.

int getpixel(int x, int y) {
   etc
}

SDL_API_Writers_Guide (last edited 2008-04-17 08:18:51 by localhost)