trunk/libfjme/Utils.h File Reference

Utilities to make life easier for users. These utilities. can be accessed from anywhere in the program. More...

#include <glib.h>
#include "video.h"

Include dependency graph for Utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	AnmVector2d
union	Vector2f
	A two-dimensional vector. More...
struct	AnmColor
	A color prepared to be animated. More...
Defines
#define	sq(x)   (x*x)
	Multiplies a variable by itself.
#define	vec_distf(a, b)   ( sqrt( sq(b.x - a.x) + sq(b.y - a.y) ) )
	This macro is replaced by the distance between two vectors.
#define	between_square(x, y, a, b, width, height)
	Checks if the points x, y, are in the square a, b​​, width, height.
#define	setn(x, y)   if(x == NULL) x = y
Typedefs
typedef struct AnmVector2d	AnmVector2d
Functions
AnmColor *	addAnmColor ()
	Returns a animated color.
AnmColor *	AnmColorFromColorD (Pixeld *c)
	Returns a static color which can be accessed in the same way that a animated color.
Vector2f *	vector2f (gfloat x, gfloat y)
	Allocates memory for a 2D vector.
gboolean	draw_plugin (iPlugin *p)
	Draw a graphic plugin, on the screen.
gboolean	draw_plugin_custom (GdkPixbuf *pixels, iPlugin *p)
	Draws the plugin in a GdkPixbuf specified by User.
gchar *	fjme_data_directory ()
	Returns the top data directory of FJME.
GtkWidget *	fjme_button_from_file (gchar *file)

---

Detailed Description

Utilities to make life easier for users. These utilities. can be accessed from anywhere in the program.

---

Define Documentation

#define between_square	(		x,
			y,
			a,
			b,
			width,
			height
	)

Value:

(x >= a && x < a+width && \
         y >= b && y < b+height)

Checks if the points x, y, are in the square a, b​​, width, height.

Author:

Fabio J. Gonzalez

#define setn	(		x,
			y
	)		if(x == NULL) x = y

#define sq

(

x

)

(x*x)

Multiplies a variable by itself.

Author:

Fabio J. Gonzalez

#define vec_distf	(		a,
			b
	)		( sqrt( sq(b.x - a.x) + sq(b.y - a.y) ) )

This macro is replaced by the distance between two vectors.

Author:

Fabio J. Gonzalez

---

Typedef Documentation

typedef struct AnmVector2d AnmVector2d

---

Function Documentation

AnmColor* addAnmColor

(

)

Returns a animated color.

Author:

Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

AnmColor* AnmColorFromColorD

(

Pixeld *

c

)

Returns a static color which can be accessed in the same way that a animated color.

Author:

Fabio J. Gonzalez

gboolean draw_plugin

(

iPlugin *

p

)

Draw a graphic plugin, on the screen.

Draw on the screen GdkPixbuf (pixels) contained in the structure iPlugin. This function considers the alpha channel of the GdkPixbuf (transparency), and adjusts the image size to the size specified in the structure iPlugin (width, height). If the variable "center", is set to true (default), the image is adjusted with the point (x, y) in the center. Otherwise, (x, y) is the place of the first pixel of the screen. Opacity is adjusted individually for each pixel.

Author:

Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

gboolean draw_plugin_custom	(	GdkPixbuf *	pixels,
		iPlugin *	p
	)

Draws the plugin in a GdkPixbuf specified by User.

Author:

Fabio J. Gonzalez

Here is the call graph for this function:

GtkWidget* fjme_button_from_file

(

gchar *

file

)

Here is the caller graph for this function:

gchar* fjme_data_directory

(

)

Returns the top data directory of FJME.

Author:

Fabio J. Gonzalez

Vector2f* vector2f	(	gfloat	x,
		gfloat	y
	)

Allocates memory for a 2D vector.

Warning:

The memory allocated by this function is not automatically freed.

Author:

Fabio J. Gonzalez