136 lines
3.0 KiB
Groff
136 lines
3.0 KiB
Groff
.TH "include/render/bitmap.h" 3 "Fri Aug 30 2019" "Version 0.0.1" "FxEngine" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
include/render/bitmap.h
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <stdint\&.h>\fP
|
|
.br
|
|
\fC#include <stdbool\&.h>\fP
|
|
.br
|
|
|
|
.SS "Data Structures"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBbitmap_rich\fP"
|
|
.br
|
|
.RI "bitmap rich type transparency is in the layout "
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "typedef struct \fBbitmap_rich\fP \fBbitmap_rich\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBbitmap_rich\fP * \fBbitmap_new_rich\fP (uint32_t size_px_x, uint32_t size_px_y, uint32_t *color, bool copy_color, uint32_t *layout, bool copy_layout)"
|
|
.br
|
|
.RI "{ function_description } "
|
|
.ti -1c
|
|
.RI "void \fBbitmap_delete_rich\fP (\fBbitmap_rich\fP *bmp)"
|
|
.br
|
|
.RI "delete a rich bitmap created with \fBbitmap_new_rich()\fP "
|
|
.ti -1c
|
|
.RI "uint8_t \fBbitmap_get_pixel_r\fP (const \fBbitmap_rich\fP *bmp, uint32_t x, uint32_t y)"
|
|
.br
|
|
.RI "get the color of pixel from rich bitmap "
|
|
.ti -1c
|
|
.RI "void \fBbitmap_display_pixel_r\fP (const \fBbitmap_rich\fP *bmp, uint32_t bmp_x, uint32_t bmp_y, uint32_t x, uint32_t y)"
|
|
.br
|
|
.RI "display a specific rich bitmap pixel on the screen "
|
|
.in -1c
|
|
.SH "Typedef Documentation"
|
|
.PP
|
|
.SS "typedef struct \fBbitmap_rich\fP \fBbitmap_rich\fP"
|
|
|
|
.PP
|
|
Definition at line 20 of file bitmap\&.h\&.
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "void bitmap_delete_rich (\fBbitmap_rich\fP * bmp)"
|
|
|
|
.PP
|
|
delete a rich bitmap created with \fBbitmap_new_rich()\fP
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIbmp\fP The bitmap to delete
|
|
.RE
|
|
.PP
|
|
|
|
.SS "void bitmap_display_pixel_r (const \fBbitmap_rich\fP * bmp, uint32_t bmp_x, uint32_t bmp_y, uint32_t x, uint32_t y)"
|
|
|
|
.PP
|
|
display a specific rich bitmap pixel on the screen
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIbmp\fP The bitmap
|
|
.br
|
|
\fIbmp_x\fP The bitmap x coordinate (in pixels)
|
|
.br
|
|
\fIbmp_y\fP The bitmap y coordinate (in pixels)
|
|
.br
|
|
\fIx\fP screen : x coordinate
|
|
.br
|
|
\fIy\fP screen : y coordinate
|
|
.RE
|
|
.PP
|
|
|
|
.SS "uint8_t bitmap_get_pixel_r (const \fBbitmap_rich\fP * bmp, uint32_t x, uint32_t y)\fC [inline]\fP"
|
|
|
|
.PP
|
|
get the color of pixel from rich bitmap
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIbmp\fP The bitmap
|
|
.br
|
|
\fIx\fP The bitmap x coordinate (in pixels)
|
|
.br
|
|
\fIy\fP The bitmap y coordinate (in pixels)
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
the color coded in a unsigned char : if (color >> 1) switch (color%2) { case 0: // WHITE break; case 1: // BLACK } else
|
|
.RE
|
|
.PP
|
|
|
|
.SS "\fBbitmap_rich\fP* bitmap_new_rich (uint32_t size_px_x, uint32_t size_px_y, uint32_t * color, bool copy_color, uint32_t * layout, bool copy_layout)"
|
|
|
|
.PP
|
|
{ function_description }
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIsize_px_x\fP The width in px
|
|
.br
|
|
\fIsize_px_y\fP The height in px
|
|
.br
|
|
\fIcolor\fP color origin
|
|
.br
|
|
\fIcopy_color\fP if you want to make a copy, or only to make a link
|
|
.br
|
|
\fIlayout\fP layout origin -> can be set as 0 if it isn't needed
|
|
.br
|
|
\fIcopy_layout\fP if you want to make a copy, or to make a link
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
a rich bitmap, ready to use !
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for FxEngine from the source code\&.
|