Top | ![]() |
![]() |
![]() |
![]() |
gboolean | (*MirageEnumFilterStreamInfoCallback) () |
gboolean | (*MirageEnumParserInfoCallback) () |
gboolean | (*MirageEnumWriterInfoCallback) () |
MirageWriter * | mirage_create_writer () |
gboolean | mirage_enumerate_filter_streams () |
gboolean | mirage_enumerate_parsers () |
gboolean | mirage_enumerate_writers () |
gboolean | mirage_get_filter_streams_info () |
gboolean | mirage_get_filter_streams_type () |
gboolean | mirage_get_parsers_info () |
gboolean | mirage_get_parsers_type () |
gboolean | mirage_get_supported_debug_masks () |
gboolean | mirage_get_writers_info () |
gboolean | mirage_get_writers_type () |
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, writers and filter
streams. 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, writers and filter streams. 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 (*MirageEnumFilterStreamInfoCallback) (const MirageFilterStreamInfo *info
,gpointer user_data
);
Callback function type used with mirage_enumerate_filter_streams()
.
A pointer to filter stream information structure is stored in info
; the
structure belongs to the filter stream 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 (*MirageEnumWriterInfoCallback) (const MirageWriterInfo *info
,gpointer user_data
);
Callback function type used with mirage_enumerate_writers()
.
A pointer to writer information structure is stored in info
; the
structure belongs to the writer object and should not be modified.
user_data
is user data passed to enumeration function.
MirageWriter * mirage_create_writer (const gchar *writer_id
,GError **error
);
Attempts to create an instance of image writer whose ID is writer_id
.
gboolean mirage_enumerate_filter_streams (MirageEnumFilterStreamInfoCallback func
,gpointer user_data
,GError **error
);
Iterates over list of supported filter streams, calling func
for each filter stream.
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_enumerate_writers (MirageEnumWriterInfoCallback func
,gpointer user_data
,GError **error
);
Iterates over list of supported writers, calling func
for each writers.
If func
returns FALSE
, the function immediately returns FALSE
.
gboolean mirage_get_filter_streams_info (const MirageFilterStreamInfo **info
,gint *num_filter_streams
,GError **error
);
Retrieves information structures for supported filter streams.
gboolean mirage_get_filter_streams_type (const GType **types
,gint *num_filter_streams
,GError **error
);
Retrieves GType values for supported filter streams.
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 MirageDebugMaskInfo **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 MirageDebugMaskInfo. 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_get_writers_info (const MirageWriterInfo **info
,gint *num_writers
,GError **error
);
Retrieves information structures for supported parsers.
gboolean mirage_get_writers_type (const GType **types
,gint *num_writers
,GError **error
);
Retrieves GType values for supported writers.
gboolean
mirage_initialize (GError **error
);
Initializes libMirage library. It should be called before any other of libMirage functions.