This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
clipsAPI.h File Reference
+ Include dependency graph for clipsAPI.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  UsdClipsAPI
 UsdClipsAPI is an API schema that provides an interface to a prim's clip metadata. More...
 

Macros

#define USDCLIPS_INFO_KEYS
 
#define USDCLIPS_SET_NAMES
 

Functions

 TF_DECLARE_PUBLIC_TOKENS (UsdClipsAPIInfoKeys, USD_API, USDCLIPS_INFO_KEYS)
 
 
 TF_DECLARE_PUBLIC_TOKENS (UsdClipsAPISetNames, USD_API, USDCLIPS_SET_NAMES)
 
 

Macro Definition Documentation

◆ USDCLIPS_INFO_KEYS

#define USDCLIPS_INFO_KEYS

Definition at line 588 of file clipsAPI.h.

◆ USDCLIPS_SET_NAMES

#define USDCLIPS_SET_NAMES

Definition at line 624 of file clipsAPI.h.

Function Documentation

◆ TF_DECLARE_PUBLIC_TOKENS() [1/2]

TF_DECLARE_PUBLIC_TOKENS ( UsdClipsAPIInfoKeys  ,
USD_API  ,
USDCLIPS_INFO_KEYS   
)

UsdClipsAPIInfoKeys provides tokens for the various entries in the clips dictionary. UsdClipsAPI provides named API corresponding to each of these entries; see documentation on API for expected values.

See also
UsdClipsAPI::GetClips

The keys provided here are:

◆ TF_DECLARE_PUBLIC_TOKENS() [2/2]

TF_DECLARE_PUBLIC_TOKENS ( UsdClipsAPISetNames  ,
USD_API  ,
USDCLIPS_SET_NAMES   
)

UsdClipsAPISetNames provides tokens for pre-defined clip set names that may be used with the value clip info functions on UsdClipsAPI.

The tokens are:

  • default_ - The default clip set used for API where no clip set is specified.