Abstract interface for image plugins. More...
Public Member Functions | |
| virtual const char * | get_name () const =0 |
| Returns the name of the plugin. More... |
|
| virtual bool | init (IPlugin_api *plugin_api)=0 |
| Initializes the plugin. More... |
|
| virtual bool | exit (IPlugin_api *plugin_api)=0 |
| De-initializes the plugin. More... |
|
| virtual const char * | get_file_extension (Uint32 index) const =0 |
Returns the index -th supported file extension. More... |
|
| virtual const char * | get_supported_type (Uint32 index) const =0 |
Returns the index -th supported pixel type for exporting. More... |
|
| virtual bool | test (const Uint8 *buffer, Uint32 file_size) const =0 |
| Indicates whether the image plugin can handle a given file header. More... |
|
| virtual Impexp_priority | get_priority () const =0 |
| Returns the priority of the image plugin. More... |
|
| virtual IImage_file * | open_for_writing (IWriter *writer, const char *pixel_type, Uint32 resolution_x, Uint32 resolution_y, Uint32 nr_of_layers, Uint32 miplevels, bool is_cubemap, Float32 gamma, Uint32 quality) const =0 |
| Creates an object that writes an image to a file. More... |
|
| virtual IImage_file * | open_for_reading (IReader *reader) const =0 |
| Creates an object that reads an image to file. More... |
|
 Public Member Functions inherited from mi::base::Plugin
| |
| virtual Sint32 | get_plugin_system_version () const |
| Returns the version of the plugin system used to compile this. More... |
|
| virtual const char * | get_type () const =0 |
| Returns the type of the plugin. More... |
|
| virtual Sint32 | get_version () const |
| Returns the version number of the plugin. More... |
|
| virtual const char * | get_compiler () const |
| Returns the compiler used to compile the plugin. More... |
|
| virtual void | release ()=0 |
| Destroys the plugin instance. More... |
|
| virtual const char * | get_string_property (Sint32 index, const char **value) |
| Returns a plugin property. More... |
|
Abstract interface for image plugins.
The image plugin API allows to add support for third-party image formats. Such an image format will then be supported in import, export, and streaming operations. The image plugin API comprises the interfaces mi::neuraylib::IImage_plugin and mi::neuraylib::IImage_file. It also uses the interfaces mi::neuraylib::IReader, mi::neuraylib::IWriter, and mi::neuraylib::ITile.
Image plugins need to return MI_NEURAY_IMAGE_PLUGIN_TYPE in mi::base::Plugin::get_type().
A plugin to support a certain image format is selected as follows. For import operations the file header is presented to each plugin for testing. Each plugin indicates whether it recognizes the header format and whether it can handle the image format. For export operations a matching plugin is selected according to the file name extension (see mi::neuraylib::IImage_plugin::get_file_extension()).
|
pure virtual |
De-initializes the plugin.
| plugin_api | Provides access to API components available for plugins. |
true in case of success, and false otherwise.
|
pure virtual |
Returns the index -th supported file extension.
| index | The index of the file extensions to be returned. |
index -th supported file extension, NULL if index is out of bounds.
|
pure virtual |
Returns the name of the plugin.
For image plugins, typically the name of the image format is used, for example, "jpeg".
Implements mi::base::Plugin.
|
pure virtual |
Returns the priority of the image plugin.
The priority expresses the confidence of the plugin that its test() method can identify the file and that the file format is fully supported.
|
pure virtual |
Returns the index -th supported pixel type for exporting.
The pixel types should be ordered, from index 0 for the most common to the least useful type. See Types for a list of supported pixel types.
| index | The index of the pixel type to be returned. |
index -th supported pixel type, NULL if index is out of bounds.
|
pure virtual |
Initializes the plugin.
| plugin_api | Provides access to API components available for plugins. |
true in case of success, and false otherwise.
|
pure virtual |
Creates an object that reads an image to file.
This method is called to start an image import operation.
| reader | A reader representing the file to read from. |
|
pure virtual |
Creates an object that writes an image to a file.
This method is called to start an image export operation.
| writer | A writer representing the file to write to. |
| pixel_type | The pixel type of the image tiles. This is one of the pixel types returned by get_supported_type(). |
| resolution_x | The resolution of the image in x direction. |
| resolution_y | The resolution of the image in y direction. |
| nr_of_layers | The number of layers in the image. |
| miplevels | The number of mipmap levels in the image. |
| is_cubemap |
true if the image is supposed to be cubemap, false otherwise. |
| gamma | The gamma value of the image. |
| quality | The desired compression quality. The compression quality is an integer in the range from 0 to 100, where 0 is the lowest quality, and 100 is the highest quality. Support for compression quality is optional. |
|
pure virtual |
Indicates whether the image plugin can handle a given file header.
| buffer | A buffer containing the first 512 bytes of the file. For very short files the buffer might be even smaller (as indicated by file_size). |
| file_size | The total size of the file. |
true if the plugin can handle the file, false otherwise.