15.1 Overview

Plugins that have the capability flag HWPLUG_CAPS_ICON set will be called whenever Hollywood has to load an icon. The plugin can check then whether the icon is in a format that the plugin recognizes and if it is, it can open the icon and return the icon's images to Hollywood. This makes it possible to load custom icon formats with Hollywood.

By default, icon plugins are automatically activated when Hollywood loads them. This behaviour can be changed by setting the HWEXT_ICON_NOAUTOINIT extension bit. If this bit is set, Hollywood will not automatically activate your plugin at load time. Instead, you will have to manually call hw_AddLoaderAdapter() to activate your plugin. For example, you could call hw_AddLoaderAdapter() from your RequirePlugin() implementation. In that case, the icon plugin would only be activated if the user called @REQUIRE on it. If you do not call hw_AddLoaderAdapter() on a plugin that has auto-initialization disabled, it will only be available if the user addresses it directly through the Loader tag. See Extension plugins to learn how to use plugin extension bits.

Note that icon plugins need not implement all functions offered by the icon plugin API. Some functions are optional and need only be implemented in specific cases. Here's a list of optional functions:

GetIconFormat()

Only used if you set the HWEXT_ICON_FORMAT extension flag. See Extension plugins to learn how to use plugin extension bits.

This plugin type is supported since Hollywood 9.0.