%---------------- Functions ------------

\chapter{Bitmap.mui/Bitmap.mui}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf FUNCTION]
The Bitmap class allows including self-made image data in MUI
applications. Usually, image class was intended to be used for
this purpose but unfortunately, its design was not very useful.

In its most simple usage, Bitmap class just display a given
BitMap. However, you can also tell it to do automatic color
remapping to match the current display context and you can
define a transparent color to make the BitMap appear on any
background.
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_Bitmap}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_Bitmap]  -- (V8 ) [ISG], struct BitMap *
\end{description}

\item[\bf FUNCTION]
This attribute specifies a pointer to a struct BitMap. Note
that specifying only a BitMap isn't enough, you have to tell
MUI about the pixel width and height with MUIA\_Bitmap\_Width
and MUIA\_Bitmap\_Height too.

\item[\bf SEE ALSO]
MUIA\_Bitmap\_Width, MUIA\_Bitmap\_Height, MUIA\_Bitmap\_Transparent,
MUIA\_Bitmap\_SourceColors, MUIA\_Bitmap\_MappingTable
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_Height}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_Height]  -- (V8 ) [ISG], LONG
\end{description}

\item[\bf FUNCTION]
Define the pixel height of the BitMap.

Note: By default, the bitmap object has a minimum size of
1 pixel and an unlimited maxium size. If the space is
too small to hold your BitMap, it will be clipped.
Usually, you will use MUIA\_FixWidth and MUIA\_FixHeight
with BitMap objects to make them always exactly as big as
the bitmap.

\item[\bf SEE ALSO]
MUIA\_Bitmap\_Bitmap, MUIA\_Bitmap\_Width, MUIA\_Bitmap\_Transparent,
MUIA\_Bitmap\_SourceColors, MUIA\_Bitmap\_MappingTable
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_MappingTable}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_MappingTable]  -- (V8 ) [ISG], UBYTE *
\end{description}

\item[\bf FUNCTION]
Address of an array of UBYTEs, one for each color of the
source BitMap. MUI will remap the BitMap according to the
contents of the array.

Since MUI applications usually don't know about their
display environment, this tag is rarely used. Instead,
MUIA\_Bitmap\_SourceColors can be used to allow context
sensitive color remapping.

\item[\bf SEE ALSO]
MUIA\_Bitmap\_Bitmap, MUIA\_Bitmap\_Height, MUIA\_Bitmap\_Width,
MUIA\_Bitmap\_Transparent
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_Precision}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_Precision]  -- (V11) [ISG], LONG
\end{description}

\item[\bf FUNCTION]
Specify the precision value for remapping images. Use
the same predefined values as for ObtainBestPen() here,
e.g.

PRECISION\_EXACT
PRECISION\_IMAGE
PRECISION\_ICON
PRECISION\_GUI
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_RemappedBitmap}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_RemappedBitmap]  -- (V11) [..G], struct BitMap *
\end{description}

\item[\bf FUNCTION]
Between MUIM\_Setup and MUIM\_Cleanup, this attribute will
hold a pointer to the remapped bitmap.
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_SourceColors}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_SourceColors]  -- (V8 ) [ISG], ULONG *
\end{description}

\item[\bf FUNCTION]
This attribute defines the color palette of the source
BitMap. If specified, MUI will try to locate these colors
on the current screen and remap the BitMap accordingly.

You can e.g. specify some great looking 8-color images
for several buttons of your application and MUI will
ensure they look fine even on 4-color screens or on
screens with completely different colors.

When running Kickstart V39 or higher, MUI will use
ObtainBestPen() to find or create your colors.
Below V39, a simple color-map search is performed
to find the best matching entry, but no colors will
be changed.

The source palette is specified with an array of
ULONGs, three entries per color, 32bits per gun.

\item[\bf EXAMPLE]
\begin{flushleft}
\begin{verbatim}
/* MagicWB-like palette for an 8-color image */

const ULONG aboutlogo_colors[24] =
{
   0xaaaaaaaa,0xaaaaaaaa,0xa0a0a0a0,
   0x00000000,0x00000000,0x00000000,
   0xffffffff,0xffffffff,0xffffffff,
   0x66666666,0x88888888,0xbbbbbbbb,
   0x99999999,0x99999999,0x99999999,
   0xbbbbbbbb,0xbbbbbbbb,0xbbbbbbbb,
   0xbbbbbbbb,0xaaaaaaaa,0x99999999,
   0xffffffff,0xbbbbbbbb,0xaaaaaaaa
};

\end{verbatim}
\end{flushleft}
\item[\bf SEE ALSO]
MUIA\_Bitmap\_Bitmap, MUIA\_Bitmap\_Height, MUIA\_Bitmap\_Width,
MUIA\_Bitmap\_MappingTable, MUIA\_Bitmap\_MappingTable
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_Transparent}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_Transparent]  -- (V8 ) [ISG], LONG
\end{description}

\item[\bf FUNCTION]
If specified, MUI will consider this color of the BitMap
to be transparent. A mask plane will be generated and
used for blitting, the background will shine through.

\item[\bf SEE ALSO]
MUIA\_Bitmap\_Bitmap, MUIA\_Bitmap\_Height, MUIA\_Bitmap\_Width,
MUIA\_Bitmap\_SourceColors, MUIA\_Bitmap\_MappingTable
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_UseFriend}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_UseFriend]  -- (V11) [I..], BOOL
\end{description}

\item[\bf FUNCTION]
This attribute will make MUI to try to allocate the remapped
bitmap in a way that allows fastest displaying.
\end{deflist}


\subsection{Bitmap.mui/MUIA\_Bitmap\_Width}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Bitmap\_Width]  -- (V8 ) [ISG], LONG
\end{description}

\item[\bf FUNCTION]
Define the pixel width of the BitMap.

Note: By default, the bitmap object has a minimum size of
1 pixel and an unlimited maxium size. If the space is
too small to hold your BitMap, it will be clipped.
Usually, you will use MUIA\_FixWidth and MUIA\_FixHeight
with BitMap objects to make them always exactly as big as
the bitmap.

\item[\bf SEE ALSO]
MUIA\_Bitmap\_Bitmap, MUIA\_Bitmap\_Height, MUIA\_Bitmap\_Transparent,
MUIA\_Bitmap\_SourceColors, MUIA\_Bitmap\_MappingTable
\end{deflist}


%---------------- End of File ----------