view gui/util/bitmap.h @ 35730:330325df88ed

Relocate #defines and make them functions. Additionally, add doxygen comments.

/*
 * This file is part of MPlayer.
 *
 * MPlayer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * MPlayer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPLAYER_GUI_BITMAP_H
#define MPLAYER_GUI_BITMAP_H

/// Transparent color (opaque fuchsia/magenta)
#define GUI_TRANSPARENT 0xffff00ff
#define ALPHA_OPAQUE    0xff000000

/* for legacy reasons, we must treat all kind of fuchsia/magenta as transparent */
#define IS_TRANSPARENT(c) ((ALPHA_OPAQUE | (c)) == GUI_TRANSPARENT)

typedef struct {
    unsigned long Width;
    unsigned long Height;
    unsigned int Bpp;
    unsigned long ImageSize;
    char *Image;
} guiImage;

void bpFree(guiImage *img);
int bpRead(const char *fname, guiImage *img);
int bpRenderMask(const guiImage *in, guiImage *out);

#endif /* MPLAYER_GUI_BITMAP_H */