All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdCommandDescriptor Class Reference

#include <command.h>

Public Member Functions

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

Public Attributes

const TfToken commandName
const std::string commandDescription
const HdCommandArgDescriptors commandArgs

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::HdCommandDescriptor ( )
HdCommandDescriptor::HdCommandDescriptor ( const TfToken name_,
const std::string description_ = "",
const HdCommandArgDescriptors args_ = HdCommandArgDescriptors() 

Definition at line 82 of file command.h.

Member Data Documentation

const HdCommandArgDescriptors HdCommandDescriptor::commandArgs

List of arguments this command supports, may be empty.

Definition at line 104 of file command.h.

const std::string HdCommandDescriptor::commandDescription

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

Definition at line 99 of file command.h.

const TfToken HdCommandDescriptor::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: