libmonochrome/man/man3/ML_bmp.3

92 lines
3.3 KiB
Groff

'\" t
.\" Title: ml_bmp
.\" Author: Thomas "Cakeisalie5" Touhey <thomas@touhey.fr>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 07/18/2016
.\" Manual: libmonochrome
.\" Source: libmonochrome
.\" Language: English
.\"
.TH "ML_BMP" "3" "07/18/2016" "libmonochrome" "libmonochrome"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ML_bmp \- BMP drawing functions from libmonochrome
.SH "SYNOPSIS"
.sp
.nf
#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);
void ML_bmp_8_or(const unsigned char *bmp,
int x, int y);
void ML_bmp_8_and(const unsigned char *bmp,
int x, int y);
void ML_bmp_8_xor(const unsigned char *bmp,
int x, int y);
void ML_bmp_8_or_cl(const unsigned char *bmp,
int x, int y);
void ML_bmp_8_and_cl(const unsigned char *bmp,
int x, int y);
void ML_bmp_8_xor_cl(const unsigned char *bmp,
int x, int y);
void ML_bmp_16_or(const unsigned short *bmp,
int x, int y);
void ML_bmp_16_and(const unsigned short *bmp,
int x, int y);
void ML_bmp_16_xor(const unsigned short *bmp,
int x, int y);
void ML_bmp_16_or_cl(const unsigned short *bmp,
int x, int y);
void ML_bmp_16_and_cl(const unsigned short *bmp,
int x, int y);
void ML_bmp_16_xor_cl(const unsigned short *bmp,
int x, int y);
.fi
.SH "DESCRIPTION"
.sp
Those functions are meant to draw monochrome with fill bits bitmaps \(em like game sprites \(em on the VRAM\&.
.sp
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\&.
.sp
Function with the _cl suffix are functions using clipping, which means they are able to draw sprites even if they aren\(cqt completely on screen\&. Other functions only draw the bitmap if it is in the screen \(em which makes them a little faster\&.
.SH "SEE ALSO"
.sp
libmonochrome(3), ML_VRAM(3)
.SH "AUTHOR"
.PP
\fBThomas "Cakeisalie5" Touhey\fR <\&thomas@touhey\&.fr\&>
.RS 4
Author.
.RE