nvneural::ParamDesc Struct Reference

ParamDesc describes a parameter for the plugin, giving it a name, default value, type, and, if needed, a pointer to greater detail. More...

#include <nvneural/CoreTypes.h>

Public Attributes
ParamType	paramType
	This is a enum that describes this parameter. More...
const char *	pDefault
	This is the default value of the parameter. More...
const char *	pDocumentation
	An optional human-readable descriptive text. More...
const char *	pName
	This is the name of the parameter, usually a friendly name. More...
const BaseParamTypeDesc *	pParamTypeDetails
	This is an optional struct that give greater detail to the paramType if needed, for instance, an enum type would need it's members. More...
std::size_t	structSize
	This is the sizeof() this struct. It is used for versioning.

Detailed Description

ParamDesc describes a parameter for the plugin, giving it a name, default value, type, and, if needed, a pointer to greater detail.

The host will handle situations where the string of a pDefault value is actually a string, number, enumeration, or other value.

Member Data Documentation

paramType

ParamType nvneural::ParamDesc::paramType

This is a enum that describes this parameter.

Examples: "ParamType::Dimension2D", "ParamType::Enumeration"

pDefault

const char* nvneural::ParamDesc::pDefault

This is the default value of the parameter.

String should be treated as UTF-8.

Examples: "3x3", "same"

pDocumentation

const char* nvneural::ParamDesc::pDocumentation

An optional human-readable descriptive text.

Generally used in host editor. String should be treated as UTF-8. May use Qt's "rich text" subset of HTML, but please be discreet and do not apply significant style changes–these may not render as expected in future releases of the editor.

pName

const char* nvneural::ParamDesc::pName

This is the name of the parameter, usually a friendly name.

String should be treated as UTF-8.

Examples: "kernel", "padding"

pParamTypeDetails

const BaseParamTypeDesc* nvneural::ParamDesc::pParamTypeDetails

This is an optional struct that give greater detail to the paramType if needed, for instance, an enum type would need it's members.

Each optional struct will have a BaseLayerParamTypeDesc as its first entry, followed by other entries that are needed to describe the parameter.

---

The documentation for this struct was generated from the following file:

• Core/Inc/nvneural/CoreTypes.h