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
SdfLayerHints Class Reference

Contains hints about layer contents that may be used to accelerate certain composition operations. More...

#include <layerHints.h>

Public Member Functions

 SdfLayerHints ()=default
 Default constructed hints provide the most conservative set of values such that consumers of the hints will act correctly if not optimally.
 
 SdfLayerHints (bool mightHaveRelocates)
 Construct hints with specific values.
 

Public Attributes

bool mightHaveRelocates = true
 If this field is false, the layer does not contain relocates.
 

Detailed Description

Contains hints about layer contents that may be used to accelerate certain composition operations.

Definition at line 16 of file layerHints.h.

Constructor & Destructor Documentation

◆ SdfLayerHints() [1/2]

SdfLayerHints ( )
default

Default constructed hints provide the most conservative set of values such that consumers of the hints will act correctly if not optimally.

◆ SdfLayerHints() [2/2]

SdfLayerHints ( bool  mightHaveRelocates)
inlineexplicit

Construct hints with specific values.

Using this constructor requires that all hint fields be specified.

Definition at line 25 of file layerHints.h.

Member Data Documentation

◆ mightHaveRelocates

bool mightHaveRelocates = true

If this field is false, the layer does not contain relocates.

If true, relocates may be present but are not guaranteed to exist.

Definition at line 31 of file layerHints.h.


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