MetadataOverlay

Formats metadata into a text overlay on top of the image. Provides control over formatting, font, layout and a drop shadow.

user

Container for user-defined plugs. Nodes should never make their own plugs here, so users are free to do as they wish.

out

The output image, with metadata overlayed as text.

enabled

Turns the overlay on and off.

marginLeft

Gap between the text area and the left of the input image, measured in pixels.

marginRight

Gap between the text area and the right of the input image, measured in pixels.

marginTop

Gap between the text area and the top of the input image, measured in pixels.

marginBottom

Gap between the text area and the bottom of the input image, measured in pixels.

horizontalAlignment

Determines whether the text is aligned to the left or right of the text area, or centered within it.

verticalAlignment

Determines whether the text is aligned to the bottom or top of the text area, or centered within it.

metadata

The metadata to include in the overlay when in Standard mode. Accepts a space-separated list of names, and supports Gaffer’s standard wildcards. Metadata is added to the image in the order defined here, with wildcard matches being sorted alphabetically.

fontColor

The colour of the text.

font

The font to render the metadata with. This should be a .ttf font file which is located on the paths specified by the IECORE_FONT_PATHS environment variable.

Supported file extensions : ttf

fontSize

The size of the font in pixels.

shadow

Enables the rendering of a drop shadow which can be coloured, offset and blurred.

shadowColor

The colour of the shadow.

shadowOffset

The offset of the shadow, measured in pixels.

shadowBlur

A blur applied to the shadow, measured in pixels.

itemFormat

The format of each line of metadata when in Standard mode. Use {name} to refer to the name of the metadata, and {value} to refer to its value.

mode

Determines the method used to format the metadata as text :

Standard : Formats one item of metadata per line, using the template specified by itemFormat. Only shows the items matched by the metadata plug.
Custom : Uses customFormat to define custom formatting, including custom labels and multiple items of metadata on a single line.

customFormat

Format of the entire metadata overlay in Custom mode. Use {<metadataName>} to include individual values. This allows arbitrary formatting, including multiple metadata values on a single line.