prtx::Annotations Namespace Reference

Description

Supported annotation types for encoder options or encoder-supported initial shape attributes.

Typically these annotations are used to programmatically construct a user interface from an EncoderInfo instance or to make certain initial shape attributes mandatory, for example.

The documentation uses "option", "option attribute", "initial shape attribute" synonymously.

See also

prt::EncoderInfo

prt::createEncoderInfo

Variables
const std::wstring	DESCRIPTION = L"@Description"
	Adds a description for the option (e.g. for tooltips) (one string parameter).
const std::wstring	GROUP = L"@Group"
	Defines a (UI) group for the option (one string parameter, one double parameter).
const std::wstring	HIDDEN = L"@Hidden"
	Hides the option in the UI.
const std::wstring	LABEL = L"@Label"
	Defines a (UI) label for the option (one string parameter).
const std::wstring	MANDATORY = L"@Mandatory"
	Makes the initial shape attribute mandatory.
const std::wstring	ORDER = L"@Order"
	Defines a semantic ordering of the option (one double parameter).
const std::wstring	PERLAYER = L"@PerLayer"
	Assigns each value of an array option to a layer. Only for array options.
const std::wstring	POINT2D = L"@Point2D"
	Declares an option to be interpreted as a 2D point. Only for array options.
const std::wstring	POINT3D = L"@Point3D"
	Declares an option to be interpreted as a 3D point. Only for array options.
const std::wstring	RANGE = L"@Range"
	Defines a value range for the option (two double parameters).