font.h File Reference

Bitmap font renderer header file. More...

#include <l4/sys/compiler.h>
#include <l4/re/c/video/view.h>
#include <l4/libgfxbitmap/bitmap.h>

Include dependency graph for font.h:

Go to the source code of this file.

Macros
#define	GFXBITMAP_DEFAULT_FONT   (void *)0
	Constant to use for the default font.

Enumerations
enum
	Constant for length field. More...

Functions
int	gfxbitmap_font_init (void)
	Initialize the library.
gfxbitmap_font_t	gfxbitmap_font_get (const char *name)
	Get a font descriptor.
unsigned	gfxbitmap_font_width (gfxbitmap_font_t font)
	Get the font width.
unsigned	gfxbitmap_font_height (gfxbitmap_font_t font)
	Get the font height.
void *	gfxbitmap_font_data (gfxbitmap_font_t font, unsigned c)
	Get bitmap font data for a specific character.
void	gfxbitmap_font_text (void *fb, l4re_video_view_info_t *vi, gfxbitmap_font_t font, const char *text, unsigned len, unsigned x, unsigned y, gfxbitmap_color_pix_t fg, gfxbitmap_color_pix_t bg)
	Render a string to a framebuffer.
void	gfxbitmap_font_text_scale (void *fb, l4re_video_view_info_t *vi, gfxbitmap_font_t font, const char *text, unsigned len, unsigned x, unsigned y, gfxbitmap_color_pix_t fg, gfxbitmap_color_pix_t bg, int scale_x, int scale_y)
	Render a string to a framebuffer, including scaling.

Variables
L4_BEGIN_DECLS typedef void *	gfxbitmap_font_t
	Font.

Detailed Description

Bitmap font renderer header file.

Definition in file font.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Constant for length field.

Use this if the function should call strlen on the text argument itself.

Definition at line 38 of file font.h.

Function Documentation

gfxbitmap_font_data()

void * gfxbitmap_font_data	(	gfxbitmap_font_t	font,
		unsigned	c )

Get bitmap font data for a specific character.

Parameters

font	Font.
c	Character.

Returns

Pointer to bmap data, NULL on error.

References gfxbitmap_font_t, and L4_CV.

gfxbitmap_font_get()

gfxbitmap_font_t gfxbitmap_font_get

(

const char *

name

)

Get a font descriptor.

Parameters

name	Name of the font.

Returns

A (opaque) font descriptor, or NULL if font could not be found.

References gfxbitmap_font_t, and L4_CV.

gfxbitmap_font_height()

unsigned gfxbitmap_font_height

(

gfxbitmap_font_t

font

)

Get the font height.

Parameters

font

Font.

Returns

Font height, 0 if font height could not be retrieved.

References gfxbitmap_font_t, and L4_CV.

gfxbitmap_font_init()

int gfxbitmap_font_init

(

void

)

Initialize the library.

This function must be called before any other font function of this library.

Returns

0 on success, other on error

References L4_CV.

gfxbitmap_font_text()

void gfxbitmap_font_text	(	void *	fb,
		l4re_video_view_info_t *	vi,
		gfxbitmap_font_t	font,
		const char *	text,
		unsigned	len,
		unsigned	x,
		unsigned	y,
		gfxbitmap_color_pix_t	fg,
		gfxbitmap_color_pix_t	bg )

Render a string to a framebuffer.

Parameters

fb	Pointer to frame buffer.
vi	Frame buffer info structure.
font	Font.
text	Text string.
len	Length of the text string.
x	Horizontal position in the frame buffer.
y	Vertical position in the frame buffer.
fg	Foreground color.
bg	Background color.

References gfxbitmap_font_t, and L4_CV.

gfxbitmap_font_text_scale()

void gfxbitmap_font_text_scale	(	void *	fb,
		l4re_video_view_info_t *	vi,
		gfxbitmap_font_t	font,
		const char *	text,
		unsigned	len,
		unsigned	x,
		unsigned	y,
		gfxbitmap_color_pix_t	fg,
		gfxbitmap_color_pix_t	bg,
		int	scale_x,
		int	scale_y )

Render a string to a framebuffer, including scaling.

Parameters

fb	Pointer to frame buffer.
vi	Frame buffer info structure.
font	Font.
text	Text string.
len	Length of the text string.
x	Horizontal position in the frame buffer.
y	Vertical position in the frame buffer.
fg	Foreground color.
bg	Background color.
scale_x	Horizonal scale factor.
scale_y	Vertical scale factor.

References gfxbitmap_font_t, and L4_END_DECLS.

gfxbitmap_font_width()

unsigned gfxbitmap_font_width

(

gfxbitmap_font_t

font

)

Get the font width.

Parameters

font

Font.

Returns

Font width, 0 if font width could not be retrieved.

References gfxbitmap_font_t, and L4_CV.