Applied Magnet's Patch

[sdlgit/SDL_perl.git] / lib / docs / Palette.pod

diff --git a/lib/docs/Palette.pod b/lib/docs/Palette.pod
new file mode 100644 (file)
index 0000000..d6730dd
--- /dev/null
+++ b/lib/docs/Palette.pod
@@ -0,0 +1,35 @@
+=pod
+
+=head1 NAME
+
+SDL::Palette - a perl extension
+
+=head1 DESCRIPTION
+
+L<SDL::Palette> provides an interface to the C<SDL_Palette> structures,
+and can be used to set the color values of an existing palette's indexes.
+
+=head1 METHODS
+
+=head2 ncolors ( )
+
+Fetches the number of colors in palette
+
+=head2 colors ( index )
+
+Fetches an array of colors in palette
+
+=head2 color_index ( index )
+
+Fetches the SDL_Color at the provide index in palette
+
+=head2 size
+
+Returns the size of the palette.
+
+
+=head1 SEE ALSO
+
+L<SDL::Color> L<SDL::Surface>
+
+=cut