windows does't know shebang.
[sdlgit/SDL_perl.git] / lib / docs / Game / Palette.pod
1 =pod
2
3 =head1 NAME
4
5 SDL::Palette - a perl extension
6
7 =head1 DESCRIPTION
8
9 L<SDL::Palette> provides an interface to the SDL_Palette structures,
10 and can be used to set the color values of an existing palette's indexes.
11
12 =head1 METHODS
13
14 =head2 blue ( index, [value] )
15
16 Fetches and sets the blue component of the color at index.
17
18 =head2 green ( index, [value] )
19
20 Fetches and sets the green component of the color at index.
21
22 =head2 red ( index, [value] )
23
24 Fetches and sets the red component of the color at index.
25
26 =head2 color ( index, [ r, g, b ] )
27
28 Fetches and sets the RGB, returns an SDL_Color *.
29
30 =head2 size
31
32 Returns the size of the palette.
33
34 =head1 AUTHOR
35
36 David J. Goehrig
37
38 =head1 SEE ALSO
39
40 L<perl> L<SDL::Color> L<SDL::Surface>
41
42 =cut