A bundle of state describing a "command". More...

#include <command.h>

Public Member Functions
	HdCommandDescriptor (const TfToken &name_, const std::string &description_="", const HdCommandArgDescriptors &args_=HdCommandArgDescriptors())

Public Attributes
const TfToken	commandName
	A token representing a command that can be invoked.

const std::string	commandDescription
	A description of the command suitable for display in a UI for example.

const HdCommandArgDescriptors	commandArgs
	List of arguments this command supports, may be empty.

Detailed Description

A bundle of state describing a "command".

A command is simply a token that can be invoked and delivered to the render delegate.

Definition at line 78 of file command.h.

Constructor & Destructor Documentation

HdCommandDescriptor	(	const TfToken &	name_,
		const std::string &	description_ = `""`,
		const HdCommandArgDescriptors &	args_ = `HdCommandArgDescriptors()`
	)

inlineexplicit

Definition at line 82 of file command.h.

const HdCommandArgDescriptors commandArgs

List of arguments this command supports, may be empty.

Definition at line 104 of file command.h.

const std::string commandDescription

A description of the command suitable for display in a UI for example.

Definition at line 99 of file command.h.

const TfToken commandName

A token representing a command that can be invoked.

Definition at line 94 of file command.h.

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