.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::Palette 3pm"
.TH pods::SDL::Palette 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::Palette \-\- Color palette for 8\-bit pixel formats
.SH CATEGORY
.IX Header "CATEGORY"
Core, Video, Structure
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Each pixel in an 8\-bit surface is an index into the colors field of the \f(CW\*(C`SDL::Palette\*(C'\fR object stored in its \f(CW\*(C`SDL::PixelFormat\*(C'\fR.
A \f(CW\*(C`SDL::Palette\*(C'\fR is created automatically when SDL allocates a \f(CW\*(C`SDL::PixelFormat\*(C'\fR for a surface.
This class has methods for returning the colors in a palette object.
The colors can be set with SDL::Video::set_colors and SDL::Video::set_palette.
.SH METHODS
.IX Header "METHODS"
.SS ncolors
.IX Subsection "ncolors"
.Vb 1
\&  $ncolors = $palette\->ncolors();
.Ve
.PP
Returns the number of colors in palette.
.SS colors
.IX Subsection "colors"
.Vb 1
\&  @colors = @{ $palette\->colors() };
.Ve
.PP
Returns an array, \f(CW\*(C`ncolors\*(C'\fR in length, of the SDL::Colors in the palette.
.SS color_index
.IX Subsection "color_index"
.Vb 1
\&  $color = $palette\->color_index( $index );
.Ve
.PP
Returns the SDL::Color at the provided index of the palette.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SDL::Video SDL::PixelFormat SDL::Color SDL::Surface
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.