types.h File Reference

#include "pxr/pxr.h"
#include "pxr/usd/usdShade/api.h"
#include "pxr/usd/usd/attribute.h"
#include "pxr/base/tf/smallVector.h"

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
using	UsdShadeAttributeVector = TfSmallVector< UsdAttribute, 1 >
using	UsdShadeSourceInfoVector = TfSmallVector< UsdShadeConnectionSourceInfo, 1 >

Enumerations
enum	UsdShadeAttributeType { UsdShadeAttributeType::Invalid, UsdShadeAttributeType::Input, UsdShadeAttributeType::Output }
enum	UsdShadeConnectionModification { UsdShadeConnectionModification::Replace, UsdShadeConnectionModification::Prepend, UsdShadeConnectionModification::Append }

Typedef Documentation

UsdShadeAttributeVector

For performance reasons we want to be extra careful when reporting attributes. It is possible to have multiple connections for a shading attribute, but by far the more common cases are one or no connection. So we use a small vector that can be stack allocated that holds space for a single attributes, but that can "spill" to the heap in the case of multiple upstream attributes.

Definition at line 67 of file types.h.

UsdShadeSourceInfoVector

For performance reasons we want to be extra careful when reporting connections. It is possible to have multiple connections for a shading attribute, but by far the more common cases are one or no connection. So we use a small vector that can be stack allocated that holds space for a single source, but that can "spill" to the heap in the case of a multi-connection.

/sa UsdShadeConnectionSourceInfo in connectableAPI.h

Definition at line 80 of file types.h.

Enumeration Type Documentation

enum UsdShadeAttributeType

strong

Specifies the type of a shading attribute.

Enumerator
Invalid
Input
Output

Definition at line 39 of file types.h.

enum UsdShadeConnectionModification

strong

Choice when creating a single connection with the ConnectToSource method for a shading attribute. The new connection can replace any existing connections or be added to the list of existing connections. In which case there is a choice between prepending and appending to said list, which will be represented by Usd's list editing operations.

Enumerator
Replace
Prepend
Append

Definition at line 53 of file types.h.