|
HDK
|
#include <settings.h>
Inheritance diagram for UsdRenderSettings:Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
| Static Public Attributes inherited from UsdRenderSettingsBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdTyped | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
| USDRENDER_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdRenderSettingsBase | |
| USDRENDER_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdTyped | |
| USD_API bool | _IsCompatible () const override |
| Protected Member Functions inherited from UsdSchemaBase | |
| virtual UsdSchemaKind | _GetSchemaType () const |
| const TfType & | _GetType () const |
| USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
| class | UsdSchemaRegistry |
A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of the RenderProducts that should result, and the UsdGeomImageable purposes that should be rendered. UsdRenderHowSettingsAffectRendering
For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdRenderTokens. So to set an attribute to the value "rightHanded", use UsdRenderTokens->rightHanded as the value.
Definition at line 65 of file settings.h.
Construct a UsdRenderSettings on UsdPrim prim . Equivalent to UsdRenderSettings::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
Definition at line 77 of file settings.h.
|
inlineexplicit |
Construct a UsdRenderSettings on the prim held by schemaObj . Should be preferred over UsdRenderSettings(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 85 of file settings.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdTyped.
| USDRENDER_API UsdAttribute UsdRenderSettings::CreateIncludedPurposesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetIncludedPurposesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.
| USDRENDER_API UsdAttribute UsdRenderSettings::CreateMaterialBindingPurposesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetMaterialBindingPurposesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.
| USDRENDER_API UsdRelationship UsdRenderSettings::CreateProductsRel | ( | ) | const |
See GetProductsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create
| USDRENDER_API UsdAttribute UsdRenderSettings::CreateRenderingColorSpaceAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetRenderingColorSpaceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a UsdRenderSettings holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
| USDRENDER_API UsdAttribute UsdRenderSettings::GetIncludedPurposesAttr | ( | ) | const |
The list of UsdGeomImageable purpose values that should be included in the render. Note this cannot be specified per-RenderProduct because it is a statement of which geometry is present.
| Declaration | uniform token[] includedPurposes = ["default", "render"] |
| C++ Type | VtArray<TfToken> |
| Usd Type | SdfValueTypeNames->TokenArray |
| Variability | SdfVariabilityUniform |
| USDRENDER_API UsdAttribute UsdRenderSettings::GetMaterialBindingPurposesAttr | ( | ) | const |
Ordered list of material purposes to consider when resolving material bindings in the scene. The empty string indicates the "allPurpose" binding.
| Declaration | uniform token[] materialBindingPurposes = ["full", ""] |
| C++ Type | VtArray<TfToken> |
| Usd Type | SdfValueTypeNames->TokenArray |
| Variability | SdfVariabilityUniform |
| Allowed Values | full, preview, "" |
| USDRENDER_API UsdRelationship UsdRenderSettings::GetProductsRel | ( | ) | const |
The set of RenderProducts the render should produce. This relationship should target UsdRenderProduct prims. If no products are specified, an application should produce an rgb image according to the RenderSettings configuration, to a default display or image name.
| USDRENDER_API UsdAttribute UsdRenderSettings::GetRenderingColorSpaceAttr | ( | ) | const |
Describes a renderer's working (linear) colorSpace where all the renderer/shader math is expected to happen. When no renderingColorSpace is provided, renderer should use its own default.
| Declaration | uniform token renderingColorSpace |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Variability | SdfVariabilityUniform |
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.
|
static |
Fetch and return stage 's render settings, as indicated by root layer metadata. If unauthored, or the metadata does not refer to a valid UsdRenderSettings prim, this will return an invalid UsdRenderSettings prim.
|
friend |
Definition at line 149 of file settings.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 71 of file settings.h.
1.8.6 
