Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
HdCommandDescriptor Class Reference

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 61 of file command.h.

Constructor & Destructor Documentation

◆ HdCommandDescriptor()

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

Definition at line 65 of file command.h.

Member Data Documentation

◆ commandArgs

const HdCommandArgDescriptors commandArgs

List of arguments this command supports, may be empty.

Definition at line 87 of file command.h.

◆ commandDescription

const std::string commandDescription

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

Definition at line 82 of file command.h.

◆ commandName

const TfToken commandName

A token representing a command that can be invoked.

Definition at line 77 of file command.h.

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