Icon Widget

From C4 Engine Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The Icon Widget displays a vector-based icon stored in an album resource. An icon widget is drawn using the Slug Library.

The widget color controls the color of a monochrome icon but is not used for a multicolor icon.

Settings

The following settings are available specifically for Icon Widgets.

Setting

Description

Icon Settings

Album

Specifies the album resource containing the icon.

Icon index

Specifies the index of the icon within the album.

Scale to fit

If enabled, scales the icon to the largest size that fits within the widget's bounding box without changing the icon's aspect ratio.

Icon Rendering Settings

Render multicolor icon

Determines whether the icon is monochrome or multicolor.

Render with optical weight

Specifies that the coverage values calculated on the boundaries of an icon are to be increased for heavier appearance. As with text, this is used to improve visibility of small details.

Render symmetric band splits

Specifies whether the band-split optimization is applied to the icon. This setting reduces rendering time by using curve lists sorted in opposite orders for the negative and positive halves of each band in an icon. This has no effect on the visual appearance of an icon, but it can increase performance for icons rendered at large sizes. This can have a negative effect on performance when icons are rendered at small sizes, so it should not be enabled in those cases.

Render adaptive supersampling

Specifies whether icons are rendered with adaptive supersampling for high quality at very small sizes.

Use bounding polygons

Specifies whether the bounding polygon optimization is enabled for the icon. This setting reduces the number of pixels covered by the icon by using a tight polygon with 3–6 sides instead of a quad. This has no effect on the visual appearance of an icon, but it can increase performance for icons rendered at large sizes. This can have a negative effect on performance when icons are rendered at small sizes, so it should not be enabled in those cases.

Use rectangle optimization

Specifies that the icon is to be rendered as a rectangle primitive, if supported by the hardware. This optimization should be enabled only for an icon that is known to always be rendered aligned to the screen axes.

See Also