libmonochrome/man/man3/ml_bmp.3

59 lines
2.0 KiB
Groff

.TH ML_bmp 3
.SH NAME
ML_bmp - BMP drawing functions from libmonochrome
.SH SYNOPSIS
.B #include <monochrome.h>
.B void ML_bmp_or(const unsigned char *bmp, int x, int y, int width, int height);
.B void ML_bmp_and(const unsigned char *bmp, int x, int y, int width, int height);
.B void ML_bmp_xor(const unsigned char *bmp, int x, int y, int width, int height);
.B void ML_bmp_or_cl(const unsigned char *bmp, int x, int y, int width, int height);
.B void ML_bmp_and_cl(const unsigned char *bmp, int x, int y, int width, int height);
.B void ML_bmp_xor_cl(const unsigned char *bmp, int x, int y, int width, int height);
.B void ML_bmp_8_or(const unsigned char *bmp, int x, int y);
.B void ML_bmp_8_and(const unsigned char *bmp, int x, int y);
.B void ML_bmp_8_xor(const unsigned char *bmp, int x, int y);
.B void ML_bmp_8_or_cl(const unsigned char *bmp, int x, int y);
.B void ML_bmp_8_and_cl(const unsigned char *bmp, int x, int y);
.B void ML_bmp_8_xor_cl(const unsigned char *bmp, int x, int y);
.B void ML_bmp_16_or(const unsigned short *bmp, int x, int y);
.B void ML_bmp_16_and(const unsigned short *bmp, int x, int y);
.B void ML_bmp_16_xor(const unsigned short *bmp, int x, int y);
.B void ML_bmp_16_or_cl(const unsigned short *bmp, int x, int y);
.B void ML_bmp_16_and_cl(const unsigned short *bmp, int x, int y);
.B void ML_bmp_16_xor_cl(const unsigned short *bmp, int x, int y);
.SH DESCRIPTION
Those functions are meant to draw monochrome with fill bits bitmaps -- like game sprites -- on the VRAM.
Functions starting with the ML_bmp_8 draw 8*8 bitmaps. Functions starting with ML_bmp_16 draw 16*16 bitmaps. All other images must be drawn with the the other functions.
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.
.SH SEE ALSO
.BR libmonochrome(3),
.BR ML_VRAM(3)
.SH AUTHOR
Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey.