libmonochrome/doc/ML_bmp.3.txt

48 lines
1.3 KiB
Plaintext

ML_BMP(3)
=========
Thomas "Cakeisalie5" Touhey
:Email: thomas@touhey.fr
:man source: libmonochrome
:man manual: libmonochrome manual
NAME
----
ML_bmp_or, ML_bmp_and, ML_bmp_xor,
ML_bmp_or_cl, ML_bmp_and_cl, ML_bmp_xor_cl
- BMP drawing functions from libmonochrome
SYNOPSIS
--------
[source,c]
----
#include <monochrome.h>
void ML_bmp_or(const unsigned char *bmp,
int x, int y, int width, int height);
void ML_bmp_and(const unsigned char *bmp,
int x, int y, int width, int height);
void ML_bmp_xor(const unsigned char *bmp,
int x, int y, int width, int height);
void ML_bmp_or_cl(const unsigned char *bmp,
int x, int y, int width, int height);
void ML_bmp_and_cl(const unsigned char *bmp,
int x, int y, int width, int height);
void ML_bmp_xor_cl(const unsigned char *bmp,
int x, int y, int width, int height);
----
DESCRIPTION
-----------
Those functions are meant to draw monochrome with fill bits bitmaps -- like game sprites -- on the VRAM.
Function with the _cl suffix are functions using clipping, which means they are able to draw sprites even if they aren't completely on screen. Other functions only draw the bitmap if it is in the screen -- which makes them a little faster.
For 8*8 and 16*16 bitmaps, see ML_bmp_8_or(3) and ML_bmp_16_or(3).
SEE ALSO
--------
ML_bmp_8_or(3),
ML_bmp_16_or(3),
libmonochrome(3),
ML_VRAM(3)