Top | ![]() |
![]() |
![]() |
![]() |
gboolean | (*MirageEnumFileFilterInfoCallback) () |
gboolean | (*MirageEnumParserInfoCallback) () |
gboolean | mirage_enumerate_file_filters () |
gboolean | mirage_enumerate_parsers () |
gboolean | mirage_get_file_filters_info () |
gboolean | mirage_get_file_filters_type () |
gboolean | mirage_get_parsers_info () |
gboolean | mirage_get_parsers_type () |
gboolean | mirage_get_supported_debug_masks () |
gboolean | mirage_initialize () |
gboolean | mirage_shutdown () |
These functions represent the core of the libMirage API. Before the
library can be used, it must be initialized using mirage_initialize()
,
which loads the plugins containing image parsers and file filters.
When library is no longer needed, it can be shut down using
mirage_shutdown()
, which unloads the plugins.
The core functions listed in this section enable enumeration of
supported parsers and file filters. Most of the core functionality
of libMirage, such as loading images, is encapsulated in MirageContext
object, which can be obtained using GLib's g_object_new()
.
gboolean (*MirageEnumFileFilterInfoCallback) (const MirageFileFilterInfo *info
,gpointer user_data
);
Callback function type used with mirage_enumerate_file_filters()
.
A pointer to file filter information structure is stored in info
; the
structure belongs to the file filter object and should not be modified.
user_data
is user data passed to enumeration function.
gboolean (*MirageEnumParserInfoCallback) (const MirageParserInfo *info
,gpointer user_data
);
Callback function type used with mirage_enumerate_parsers()
.
A pointer to parser information structure is stored in info
; the
structure belongs to the parser object and should not be modified.
user_data
is user data passed to enumeration function.
gboolean mirage_enumerate_file_filters (MirageEnumFileFilterInfoCallback func
,gpointer user_data
,GError **error
);
Iterates over list of supported file filters, calling func
for each file filter.
If func
returns FALSE
, the function immediately returns FALSE
.
gboolean mirage_enumerate_parsers (MirageEnumParserInfoCallback func
,gpointer user_data
,GError **error
);
Iterates over list of supported parsers, calling func
for each parser.
If func
returns FALSE
, the function immediately returns FALSE
.
gboolean mirage_get_file_filters_info (const MirageFileFilterInfo **info
,gint *num_file_filters
,GError **error
);
Retrieves information structures for supported file filters.
gboolean mirage_get_file_filters_type (const GType **types
,gint *num_file_filters
,GError **error
);
Retrieves GType values for supported file filters.
gboolean mirage_get_parsers_info (const MirageParserInfo **info
,gint *num_parsers
,GError **error
);
Retrieves information structures for supported parsers.
gboolean mirage_get_parsers_type (const GType **types
,gint *num_parsers
,GError **error
);
Retrieves GType values for supported parsers.
gboolean mirage_get_supported_debug_masks (const MirageDebugMask **masks
,gint *num_masks
,GError **error
);
Retrieves the pointer to array of supported debug masks and stores it in masks
.
The array consists of one or more structures of type MirageDebugMask. The
number of elements in the array is stored in num_masks
. The array belongs to
libMirage and should not be altered or freed.
gboolean
mirage_initialize (GError **error
);
Initializes libMirage library. It should be called before any other of libMirage functions.