Edited doc -- final form ?
This commit is contained in:
parent
39e8aee5c6
commit
341f9e060b
2
Makefile
2
Makefile
|
|
@ -80,7 +80,7 @@ all-doc: $(foreach section,$(MAN_SECTS),$(MAN_$(section):%=$(MANDIR)/man$(sectio
|
|||
|
||||
## - Clean all manpages
|
||||
clean-doc:
|
||||
$(RM) $(foreach section,$(MAN_SECTS),$(MAN_$(section):%=$(MANDIR)/man$(section)/%.$(section)))
|
||||
$(RM) -R $(MAN_SECTS:%=$(MANDIR)/man%)
|
||||
|
||||
## Install doc
|
||||
install-doc:
|
||||
|
|
|
|||
|
|
@ -49,10 +49,25 @@ INCINT = monochrome/internals
|
|||
MAN_SECTS = 3
|
||||
## SECTIONS CONTENT
|
||||
## - Third
|
||||
MAN_3 = libmonochrome ML_bmp ML_circle ML_color \
|
||||
ML_contrast ML_ellipse ML_line ML_pixel \
|
||||
ML_point ML_polygon ML_rectangle ML_scroll \
|
||||
ML_VRAM
|
||||
MAN_3 = libmonochrome \
|
||||
ML_bmp_or ML_bmp_and ML_bmp_xor \
|
||||
ML_bmp_or_cl ML_bmp_and_cl ML_bmp_xor_cl \
|
||||
ML_bmp_8_or ML_bmp_8_and ML_bmp_8_xor \
|
||||
ML_bmp_8_or_cl ML_bmp_8_and_cl ML_bmp_8_xor_cl \
|
||||
ML_bmp_16_or ML_bmp_16_and ML_bmp_16_xor \
|
||||
ML_bmp_16_or_cl ML_bmp_16_and_cl ML_bmp_16_xor_cl \
|
||||
ML_circle ML_filled_circle \
|
||||
ML_color \
|
||||
ML_get_contrast ML_set_contrast \
|
||||
ML_ellipse ML_filled_ellipse \
|
||||
ML_ellipse_in_rect ML_filled_ellipse_in_rect \
|
||||
ML_line ML_horizontal_line ML_vertical_line \
|
||||
ML_pixel ML_pixel_test \
|
||||
ML_point \
|
||||
ML_polygon ML_filled_polygon \
|
||||
ML_rectangle \
|
||||
ML_horizontal_scroll ML_vertical_scroll \
|
||||
ML_vram_address ML_clear_vram ML_clear_screen ML_display_vram
|
||||
|
||||
# BIN UTILITIES
|
||||
## Platform
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_VRAM - Video RAM and Display Driver management functions from libmonochrome
|
||||
ML_vram_address, ML_clear_vram, ML_clear_screen, ML_display_vram - Video RAM and Display Driver management functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -7,7 +7,9 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_bmp - BMP drawing functions from libmonochrome
|
||||
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
|
||||
--------
|
||||
|
|
@ -27,43 +29,19 @@ 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);
|
||||
----
|
||||
|
||||
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.
|
||||
|
||||
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)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,47 @@
|
|||
ML_BMP_16(3)
|
||||
============
|
||||
Thomas "Cakeisalie5" Touhey
|
||||
:Email: thomas@touhey.fr
|
||||
:man source: libmonochrome
|
||||
:man manual: libmonochrome manual
|
||||
|
||||
NAME
|
||||
----
|
||||
ML_bmp_16_or, ML_bmp_16_and, ML_bmp_16_xor,
|
||||
ML_bmp_16_or_cl, ML_bmp_16_and_cl, ML_bmp_16_xor_cl
|
||||
- 16*16 BMP drawing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
[source,c]
|
||||
----
|
||||
#include <monochrome.h>
|
||||
|
||||
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);
|
||||
----
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Those functions are meant to draw 16*16 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 bitmaps with other dimensions, please see ML_bmp_or(3) and ML_bmp_8_or(3).
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
ML_bmp_or(3),
|
||||
ML_bmp_8_or(3),
|
||||
libmonochrome(3),
|
||||
ML_VRAM(3)
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_16.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_16.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_16.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_16.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_16.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_16.3.txt
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
ML_BMP_8(3)
|
||||
===========
|
||||
Thomas "Cakeisalie5" Touhey
|
||||
:Email: thomas@touhey.fr
|
||||
:man source: libmonochrome
|
||||
:man manual: libmonochrome manual
|
||||
|
||||
NAME
|
||||
----
|
||||
ML_bmp_8_or, ML_bmp_8_and, ML_bmp_8_xor,
|
||||
ML_bmp_8_or_cl, ML_bmp_8_and_cl, ML_bmp_8_xor_cl
|
||||
- 8*8 BMP drawing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
[source,c]
|
||||
----
|
||||
#include <monochrome.h>
|
||||
|
||||
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);
|
||||
----
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Those functions are meant to draw 8*8 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 bitmaps with other dimensions, please see ML_bmp_or(3) and ML_bmp_16_or(3).
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
ML_bmp_or(3),
|
||||
ML_bmp_16_or(3),
|
||||
libmonochrome(3),
|
||||
ML_VRAM(3)
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_8.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_8.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_8.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_8.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_8.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp_8.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_bmp.3.txt
|
||||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_circle - Circles drawing functions from libmonochrome
|
||||
ML_circle, ML_filled_circle - Circles drawing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
ML_VRAM.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_VRAM.3.txt
|
||||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_contrast - Screen contrast setting functions from libmonochrome
|
||||
ML_set_contrast, ML_get_contrast - Screen contrast setting and getting functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
ML_VRAM.3.txt
|
||||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_ellipse - Ellipses drawing functions from libmonochrome
|
||||
ML_ellipse, ML_filled_ellipse, ML_ellipse_in_rect, ML_filled_ellipse_in_rect - Ellipses drawing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
ML_ellipse.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_circle.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_ellipse.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_ellipse.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_polygon.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_contrast.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_line.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_scroll.3.txt
|
||||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_line - Line drawing functions from libmonochrome
|
||||
ML_line, ML_horizontal_line, ML_vertical_line - Line drawing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_pixel - Pixel setting and testing functions from libmonochrome
|
||||
ML_pixel, ML_pixel_test - Pixel setting and testing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
ML_pixel.3.txt
|
||||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_polygon - Polygon drawing functions from libmonochrome
|
||||
ML_polygon, ML_filled_polygon - Polygon drawing functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Thomas "Cakeisalie5" Touhey
|
|||
|
||||
NAME
|
||||
----
|
||||
ML_scroll - VRAM scrolling functions from libmonochrome
|
||||
ML_horizontal_scroll, ML_vertical_scroll - VRAM scrolling functions from libmonochrome
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
ML_contrast.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_line.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_scroll.3.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
ML_VRAM.3.txt
|
||||
|
|
@ -29,8 +29,8 @@ libmonochrome provides tools to work with the VRAM and the Display Driver.
|
|||
SEE ALSO
|
||||
--------
|
||||
ML_vram(3),
|
||||
ML_contrast(3),
|
||||
ML_Color(3),
|
||||
ML_get_contrast(3),
|
||||
ML_color(3),
|
||||
ML_pixel(3),
|
||||
ML_point(3),
|
||||
ML_line(3),
|
||||
|
|
@ -38,5 +38,5 @@ ML_rectangle(3),
|
|||
ML_polygon(3),
|
||||
ML_circle(3),
|
||||
ML_ellipse(3),
|
||||
ML_scroll(3),
|
||||
ML_bmp(3)
|
||||
ML_horizontal_scroll(3),
|
||||
ML_bmp_or(3)
|
||||
|
|
|
|||
Loading…
Reference in New Issue