HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
usdKarmaRendererSettingsAPI Class Reference

#include <rendererSettingsAPI.h>

+ Inheritance diagram for usdKarmaRendererSettingsAPI:

Public Member Functions

 usdKarmaRendererSettingsAPI (const UsdPrim &prim=UsdPrim())
 
 usdKarmaRendererSettingsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDKARMA_API ~usdKarmaRendererSettingsAPI () override
 Destructor. More...
 
USDKARMA_API UsdAttribute GetKarmaGlobalAbortmissingtextureAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalAbortmissingtextureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalBucketsizeAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalBucketsizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalCacheratioAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalCacheratioAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalCachesizeAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalCachesizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalColorlimitAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalColorlimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalConstrainmaxroughAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalConstrainmaxroughAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalConvergence_modeAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalConvergence_modeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalDicingcameraAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalDicingcameraAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalDicingqualityscaleAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalDicingqualityscaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalDiffusecomponentsAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalDiffusecomponentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalDisable_lightingAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalDisable_lightingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalEnable_dofAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalEnable_dofAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalExportcomponentsAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalExportcomponentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalHead_ao_distanceAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalHead_ao_distanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalHead_ao_samplesAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalHead_ao_samplesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalHead_depthcue_alphaAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalHead_depthcue_alphaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalHead_depthcue_colorAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalHead_depthcue_colorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalHead_depthcue_zAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalHead_depthcue_zAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalImagefilterAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalImagefilterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalLight_sampling_modeAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalLight_sampling_modeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalLight_sampling_qualityAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalLight_sampling_qualityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalOffscreenqualityAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalOffscreenqualityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalOverrideobjectAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalOverrideobjectAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalPixelfilterAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalPixelfilterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalPixelfiltersizeAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalPixelfiltersizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalPixeloracleAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalPixeloracleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalRandomseedAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalRandomseedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalRaybiasAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalRaybiasAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalRefractcomponentsAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalRefractcomponentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalRendercameraAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalRendercameraAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalRussianroulette_cutoffAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalRussianroulette_cutoffAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalSamplefilterAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalSamplefilterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalSamplesperpixelAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalSamplesperpixelAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalScreendoorlimitAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalScreendoorlimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalSsscomponentsAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalSsscomponentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalUsecacheratioAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalUsecacheratioAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaGlobalVolumecomponentsAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaGlobalVolumecomponentsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaType GetSchemaType () const
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDKARMA_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDKARMA_API
usdKarmaRendererSettingsAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDKARMA_API
usdKarmaRendererSettingsAPI 
Apply (const UsdPrim &prim)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDKARMA_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaType _GetSchemaType () const override
 
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 

Detailed Description

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in usdKarmaTokens. So to set an attribute to the value "rightHanded", use usdKarmaTokens->rightHanded as the value.

Definition at line 60 of file rendererSettingsAPI.h.

Constructor & Destructor Documentation

usdKarmaRendererSettingsAPI::usdKarmaRendererSettingsAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a usdKarmaRendererSettingsAPI on UsdPrim prim . Equivalent to usdKarmaRendererSettingsAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 72 of file rendererSettingsAPI.h.

usdKarmaRendererSettingsAPI::usdKarmaRendererSettingsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a usdKarmaRendererSettingsAPI on the prim held by schemaObj . Should be preferred over usdKarmaRendererSettingsAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 80 of file rendererSettingsAPI.h.

usdKarmaRendererSettingsAPI::~usdKarmaRendererSettingsAPI ( )
overridevirtual

Destructor.

Definition at line 43 of file rendererSettingsAPI.cpp.

Member Function Documentation

UsdSchemaType usdKarmaRendererSettingsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

Definition at line 60 of file rendererSettingsAPI.cpp.

usdKarmaRendererSettingsAPI usdKarmaRendererSettingsAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "KarmaRendererSettingsAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid usdKarmaRendererSettingsAPI object is returned upon success. An invalid (or empty) usdKarmaRendererSettingsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

Definition at line 66 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalAbortmissingtextureAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalAbortmissingtextureAttr(), 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.

Definition at line 104 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalBucketsizeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalBucketsizeAttr(), 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.

Definition at line 121 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalCacheratioAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalCacheratioAttr(), 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.

Definition at line 138 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalCachesizeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalCachesizeAttr(), 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.

Definition at line 155 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalColorlimitAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalColorlimitAttr(), 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.

Definition at line 172 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalConstrainmaxroughAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalConstrainmaxroughAttr(), 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.

Definition at line 189 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalConvergence_modeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalConvergence_modeAttr(), 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.

Definition at line 206 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalDicingcameraAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalDicingcameraAttr(), 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.

Definition at line 223 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalDicingqualityscaleAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalDicingqualityscaleAttr(), 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.

Definition at line 240 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalDiffusecomponentsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalDiffusecomponentsAttr(), 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.

Definition at line 257 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalDisable_lightingAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalDisable_lightingAttr(), 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.

Definition at line 274 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalEnable_dofAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalEnable_dofAttr(), 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.

Definition at line 291 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalExportcomponentsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalExportcomponentsAttr(), 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.

Definition at line 308 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalHead_ao_distanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalHead_ao_distanceAttr(), 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.

Definition at line 325 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalHead_ao_samplesAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalHead_ao_samplesAttr(), 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.

Definition at line 342 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalHead_depthcue_alphaAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalHead_depthcue_alphaAttr(), 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.

Definition at line 359 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalHead_depthcue_colorAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalHead_depthcue_colorAttr(), 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.

Definition at line 376 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalHead_depthcue_zAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalHead_depthcue_zAttr(), 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.

Definition at line 393 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalImagefilterAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalImagefilterAttr(), 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.

Definition at line 410 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalLight_sampling_modeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalLight_sampling_modeAttr(), 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.

Definition at line 427 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalLight_sampling_qualityAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalLight_sampling_qualityAttr(), 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.

Definition at line 444 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalOffscreenqualityAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalOffscreenqualityAttr(), 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.

Definition at line 461 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalOverrideobjectAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalOverrideobjectAttr(), 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.

Definition at line 478 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalPixelfilterAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalPixelfilterAttr(), 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.

Definition at line 495 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalPixelfiltersizeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalPixelfiltersizeAttr(), 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.

Definition at line 512 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalPixeloracleAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalPixeloracleAttr(), 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.

Definition at line 529 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalRandomseedAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalRandomseedAttr(), 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.

Definition at line 546 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalRaybiasAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalRaybiasAttr(), 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.

Definition at line 563 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalRefractcomponentsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalRefractcomponentsAttr(), 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.

Definition at line 580 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalRendercameraAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalRendercameraAttr(), 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.

Definition at line 597 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalRussianroulette_cutoffAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalRussianroulette_cutoffAttr(), 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.

Definition at line 614 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalSamplefilterAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalSamplefilterAttr(), 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.

Definition at line 631 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalSamplesperpixelAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalSamplesperpixelAttr(), 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.

Definition at line 648 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalScreendoorlimitAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalScreendoorlimitAttr(), 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.

Definition at line 665 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalSsscomponentsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalSsscomponentsAttr(), 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.

Definition at line 682 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalUsecacheratioAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalUsecacheratioAttr(), 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.

Definition at line 699 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::CreateKarmaGlobalVolumecomponentsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaGlobalVolumecomponentsAttr(), 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.

Definition at line 716 of file rendererSettingsAPI.cpp.

usdKarmaRendererSettingsAPI usdKarmaRendererSettingsAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a usdKarmaRendererSettingsAPI 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:

usdKarmaRendererSettingsAPI(stage->GetPrimAtPath(path));

Definition at line 49 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalAbortmissingtextureAttr ( ) const

Enabling this option will cause karma to abort the render with an error if it encounters a missing texture map.

Declaration bool karma:global:abortmissingtexture = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 98 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalBucketsizeAttr ( ) const

Karma breaks down an image into multiple buckets for rendering. This specifies the size of these buckets.

Declaration int karma:global:bucketsize = 32
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 115 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalCacheratioAttr ( ) const

The proportion of physical memory Karma will use for its unified cache. For example, with the default vm_cacheratio of 0.25 and 16 Gb of physical memory, Karma will use 4 Gb for its unified cache. The unified cache stores dynamic, unloadable data used by the render including the following: 2D .rat texture tiles3D .i3d texture tiles3D .pc point cloud pages (when not preloaded into memory) Note: This value is only used for off-line rendering, not IPR.

Declaration float karma:global:cacheratio = 0.25
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 132 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalCachesizeAttr ( ) const

An explicit memory limit for the unified shading cache. This is deprecated in favor of using the Cache Memory Ratio. Note: This value is only used for off-line rendering, not IPR.

Declaration int karma:global:cachesize = 1000
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 149 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalColorlimitAttr ( ) const

The maximum value a shading sample is allowed to contribute to an LPE image plane to reduce appearance of "fireflies" caused by undersampling of extremely bright light sources. Note that reducing this value can result in an overall reduction in the amount of light in your scene

Declaration float karma:global:colorlimit = 10
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 166 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalConstrainmaxroughAttr ( ) const

Roughness parameter in GGX BSDFs are clamped by the maximum roughness value propagated down the ray chain in pathtracing. Enabling this option can cut out a lot of noise in indirect specular (in particular, cases where glossy surface is reflected by a rough specular surface) at the cost of a bit of accuracy.

Declaration bool karma:global:constrainmaxrough = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 183 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalConvergence_modeAttr ( ) const

When set to Path Traced, maximum of 1 indirect ray is generated per bounce. When set to Distributed, per-component sampling is enabled and the number of indirect rays generated per BSDF component type is user-controlled. When set to Variance, the number of indirect rays is calculated based on initial noise estimate, target noise threshold, and the maximum number of camera rays. Also note that under Variance mode, number of samples for direct lighting is adjusted based on noise estimate as well.

Declaration token karma:global:convergence_mode = "Path Traced"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values Path Traced, Distributed, Variance

Definition at line 200 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalDicingcameraAttr ( ) const

Specifies a camera that is used for dicing complicated surfaces. This can provide consistent dicing of surfaces when the viewing camera is moving.

Declaration string karma:global:dicingcamera = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 217 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalDicingqualityscaleAttr ( ) const

This parameter is a global multiplier for dicing quality of all objects.

Declaration float karma:global:dicingqualityscale = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 234 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalDiffusecomponentsAttr ( ) const

A space-separated list of component types that will behave like diffuse bounces. This will affect which reflection scope is used based on the ray type and also which bounce limit to use. Uncategorized component types are assumed to be reflections.

Declaration string karma:global:diffusecomponents = "diffuse"
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 251 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalDisable_lightingAttr ( ) const

Disable all lighting and material evaluation, using only the display color to shade primitives.

Declaration bool karma:global:disable_lighting = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 268 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalEnable_dofAttr ( ) const

Enable depth of field rendering.

Declaration bool karma:global:enable_dof = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 285 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalExportcomponentsAttr ( ) const

A whitespace-separated list of shading component names that will be computed for export. If you have defined new component labels in your materials, these can be added to the list so that they are exported for per-component export planes. If you are not using some components, remove them from the list to improve render efficiency. PBR light exports assume that this list is complete - that is, all components created by shaders are listed. If there are unlisted components, light exports may be missing illumination from these components.

Declaration string karma:global:exportcomponents = "diffuse reflect coat refract volume sss"
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 302 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalHead_ao_distanceAttr ( ) const

When rendering in headlight mode with ambient occlusion shading, this distance is used for occlusion testing. Smaller values will result in faster, but less accurate shading.

Declaration float karma:global:head_ao_distance = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 319 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalHead_ao_samplesAttr ( ) const

When rendering in headlight mode, perform this many ambient occlusion samples per shade.

Declaration int karma:global:head_ao_samples = 1
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 336 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalHead_depthcue_alphaAttr ( ) const

The alpha for depthcue fog when lighting is disabled.

Declaration float karma:global:head_depthcue_alpha = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 353 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalHead_depthcue_colorAttr ( ) const

The color of the depthcue fog for disabled lighting.

Declaration float3 karma:global:head_depthcue_color = (0, 0, 0)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Float3

Definition at line 370 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalHead_depthcue_zAttr ( ) const

The near/far distance for depth cue fog when lighting is disabled. If the far distance is less than the near distance, fog will be disabled.

Declaration float2 karma:global:head_depthcue_z = (0, 0)
C++ Type GfVec2f
Usd Type SdfValueTypeNames->Float2

Definition at line 387 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalImagefilterAttr ( ) const

Image filters post-process the filtered pixels to produce the final image. This parameter specifies a list of filters. These filters are specified as a JSON list.

Declaration string karma:global:imagefilter = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 404 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalLight_sampling_modeAttr ( ) const

Whether Karma should perform uniform sampling of lights or whether rendering should use the light tree. The light tree can be significantly faster for scenes that have large numbers of lights.

Declaration token karma:global:light_sampling_mode = "Light Tree"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values Uniform, Light Tree

Definition at line 421 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalLight_sampling_qualityAttr ( ) const

This is a global control to improve sampling quality for all lights. This acts as a multiplier on the individual light quality controls. Increasing the quality will improve direct light sampling as well as shadows/occlusion.

Declaration float karma:global:light_sampling_quality = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 438 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalOffscreenqualityAttr ( ) const

This parameter controls the shading quality scale factor for geometry that is not directly visible to the camera. For geometry that is outside the field of view (ie. visible only to secondary rays), karma will smoothly reduce the shading quality based on the angle between the geometry and the edge of the viewing frustum. Smaller values can increase performance particularly in scenes where the camera is within the displacement bound of nearby geometry, where it permits the hidden primitives to be diced more coarsely than those that are directly visible.

Declaration float karma:global:offscreenquality = 0.1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 455 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalOverrideobjectAttr ( ) const

Normally, geometry settings specified in the render settings LOP provide default values for objects. Each object can override the value of the default. This parameter specifies a pattern of object property names whose values will taken from the render settings, overriding any per-object settings. For example, setting the pattern to "diffuselimit" will override the diffuse limit for all objects with the value specified on the render settings LOP.

Declaration string karma:global:overrideobject = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 472 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalPixelfilterAttr ( ) const

Specifies the distribution of samples over pixels. A box filter will distribute samples randomly over the interior of each individual pixel. A Gaussian filter will distribute samples in a disk around the pixel center, but with a Gaussian distribution (instead of a uniform distribution).

Declaration string karma:global:pixelfilter = "gauss"
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 489 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalPixelfiltersizeAttr ( ) const

This is the size of the Pixel Filter. A Guassian filter with a filter size of 1.8 will be slightly less blurry than a Gaussian filter with a filter size of 2.0.

Declaration float karma:global:pixelfiltersize = 2
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 506 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalPixeloracleAttr ( ) const

When rendering, a Pixel Oracle tells karma which pixels need additional sampling and which pixels are converged. This parameter tells karma which oracle to use.

Declaration `string karma:global:pixeloracle = '"variance"'`
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 523 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalRandomseedAttr ( ) const

This is the random seed to use for the render.

Declaration int karma:global:randomseed = 0
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 540 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalRaybiasAttr ( ) const

The ray-bias used for secondary rays.

Declaration float karma:global:raybias = 0.001
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 557 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalRefractcomponentsAttr ( ) const

A space-separated list of component types that will behave like refract bounces. This will affect which reflection scope is used based on the ray type and also which bounce limit to use. Uncategorized component types are assumed to be reflections.

Declaration string karma:global:refractcomponents = "refract"
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 574 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalRendercameraAttr ( ) const

The rendering camera.

Declaration string karma:global:rendercamera = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 591 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalRussianroulette_cutoffAttr ( ) const

Depth at which indirect rays start to get stochastically pruned based on ray throughput.

Declaration int karma:global:russianroulette_cutoff = 2
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 608 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalSamplefilterAttr ( ) const

Sample filters are used to modify samples before they are sent to pixel filters. This parameter specifies a list of filters. These filters are specified as a JSON list.

Declaration string karma:global:samplefilter = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 625 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalSamplesperpixelAttr ( ) const

The number of ray-samples sent through each pixel. More samples will result in a less noisy image.

Declaration int karma:global:samplesperpixel = 128
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 642 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalScreendoorlimitAttr ( ) const
Declaration int karma:global:screendoorlimit = 4
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 659 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalSsscomponentsAttr ( ) const

A space-separated list of component types that will behave like subsurface scatter bounces. This will affect which reflection scope is used based on the ray type and also which bounce limit to use. Uncategorized component types are assumed to be reflections.

Declaration string karma:global:ssscomponents = "sss"
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 676 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalUsecacheratioAttr ( ) const

Whether to use a fixed size cache (karma:global:cachesize) or whether to use a proportion of physical memory (karma:global:cacheratio)

Declaration bool karma:global:usecacheratio = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 693 of file rendererSettingsAPI.cpp.

UsdAttribute usdKarmaRendererSettingsAPI::GetKarmaGlobalVolumecomponentsAttr ( ) const

A space-separated list of component types that will behave like volume bounces. This will affect which reflection scope is used based on the ray type and also which bounce limit to use. Uncategorized component types are assumed to be reflections.

Declaration string karma:global:volumecomponents = "volume"
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 710 of file rendererSettingsAPI.cpp.

const TfTokenVector & usdKarmaRendererSettingsAPI::GetSchemaAttributeNames ( bool  includeInherited = true)
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.

Definition at line 740 of file rendererSettingsAPI.cpp.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 137 of file rendererSettingsAPI.h.

Member Data Documentation

const UsdSchemaType usdKarmaRendererSettingsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaType

Definition at line 66 of file rendererSettingsAPI.h.


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