This structure is a generic way to handle plugins. More...

#include <plug-ins.h>

Collaboration diagram for iPlugin:

Data Fields
gchar *	name
	An arbitrary name for the plugin (the name will be shown in menu).
gchar *	iname
	The name used internally only. This name is useful for plugins or other functions, to find this plugin.
gchar *	path
	The place of the menu in the plugin will be shown.
gchar *	type
	The type of plugin. A name to identify the plugin, as belonging to a group of similar plugins.
gchar *	description
	A human-readable description of the plugin does.
union {
gboolean call_me
	This function should be called every frame of video that need to render?
gboolean active
	This is an alternate name for IPlugin::call_me therefore graphics plugins, need not be drawn on the screen when not active. This prevents plugins show icons, not the User is using (which contributes to the program run faster).
};
GModule *	module
	This module is used to pinpoint the plugin when loaded from a file. render?
gboolean	selected
	If this is a graphic plugin, this variable indicates that the User is with him in the selection.
gboolean	central
	The center of the plugin when drawn on the screen, are the x and y axes (TRUE)? Or this is the position of the first pixel of the image (FALSE).
Main *	m
	So all plugins can access any part of the program. It all begins this structure.
GdkPixbuf *	pixels
	If this plugin is graphic, the image is drawn on the screen (representing this plugin). See Utils.c draw_plugin function.
gdouble *	x
	The position in which the plugin (GdkPixbuf) is drawn on the screen. These values can be animated (with keyframes), but also externally modified.
gdouble *	y
	The position in which the plugin (GdkPixbuf) is drawn on the screen. These values can be animated (with keyframes), but also externally modified.
gdouble *	width
	The image, correspondent to this plugin (pixels) is set to have this size.
gdouble *	height
	The image, correspondent to this plugin (pixels) is set to have this size.
gdouble *	opacity
	You can combine the opacity of GdkPixbuf with this. If this value is set to 0, so the opaque and transparent areas of the image are transparent. If this value is 1, transparency image, will be specified by the GdkPixbuf. If you set as 0.5, the maximum opacity of the image will be 0.5. All figures are adjusted for the opacity limit. Will remain, among them, the same proportion.
GtkWidget *	widget
	The image, correspondent to this plugin (pixels) is set to have this size.
Layer *	layer
	The plugins are applied to layers and called every frame to process. With this variable. set properly, the plugins know, which layer should edit video.
PluginCallFunc	Init
	The plugins are applied to layers and called every frame to process. With this variable. set properly, the plugins know, which layer should edit video.
PluginCallFunc	Frame
	This function is called every time you need to render a frame (to process the video, for example).
PluginCallFunc	End
	This function is called when the plugin is deleted.
PluginCallFunc	Config
	This function is called before the previous one (if this function is not NULL). The plugins can adjust its parameters so as to be called. For example, as are shown in the menu (name, path).
gpointer	data
	Pointers to be freely used by plugins. These pointers are also shared (since they are next to the plugin).
gpointer	data2
	Pointers to be freely used by plugins. These pointers are also shared (since they are next to the plugin).
gpointer	data3
	Pointers to be freely used by plugins. These pointers are also shared (since they are next to the plugin).
gpointer	data4
	Pointers to be freely used by plugins. These pointers are also shared (since they are next to the plugin).
gpointer	data5
	Pointers to be freely used by plugins. These pointers are also shared (since they are next to the plugin).
gpointer	data6
	Pointers to be freely used by plugins. These pointers are also shared (since they are next to the plugin).
iPlugin *	parent
GList *	child

Detailed Description

This structure is a generic way to handle plugins.

This structure represents a plugin. All functions called by the program, which are in plugins. Must contain a pointer to this structure. This structure contains all the information necessary to manage any plugin (including graphics). In addition, it provides, empty pointers, for the plugin, use freely. The advantage of these plugins are in pointers, is to be shared throughout the program. As also for all plugins. But if yout only task is to share data, you can use the "SharedDatasystem".

Author:: Fabio J. Gonzalez

Field Documentation

union { ... }

gboolean active

This is an alternate name for IPlugin::call_me therefore graphics plugins, need not be drawn on the screen when not active. This prevents plugins show icons, not the User is using (which contributes to the program run faster).

Author:: Fabio J. Gonzalez

gboolean call_me

This function should be called every frame of video that need to render?

Author:: Fabio J. Gonzalez

gboolean central

The center of the plugin when drawn on the screen, are the x and y axes (TRUE)? Or this is the position of the first pixel of the image (FALSE).

Author:: Fabio J. Gonzalez

GList* child

PluginCallFunc Config

This function is called before the previous one (if this function is not NULL). The plugins can adjust its parameters so as to be called. For example, as are shown in the menu (name, path).

Author:: Fabio J. Gonzalez

gpointer data