HdRendererCreateArgsSchema Class Reference

#include <rendererCreateArgsSchema.h>

Inheritance diagram for HdRendererCreateArgsSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdBoolDataSourceHandle	GetGpuEnabled () const
	Is a GPU available. More...
HD_API HdSampledDataSourceContainerSchema	GetDrivers () const
	Drivers such as Hgi that renderer can use. More...
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static HD_API const HdDataSourceLocator &	GetGpuEnabledLocator ()
	Prim-level relative data source locator to locate gpuEnabled. More...
static HD_API const HdDataSourceLocator &	GetDriversLocator ()
	Prim-level relative data source locator to locate drivers. More...
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdBoolDataSourceHandle &gpuEnabled, const HdContainerDataSourceHandle &drivers)

Schema retrieval
	HdRendererCreateArgsSchema (HdContainerDataSourceHandle container)
static HD_API HdRendererCreateArgsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Arguments to HdRendererPlugin::IsSupported and CreateRenderer.

Definition at line 52 of file rendererCreateArgsSchema.h.

Constructor & Destructor Documentation

HdRendererCreateArgsSchema::HdRendererCreateArgsSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "rendererCreateArgs" from the parent container and constructs a HdRendererCreateArgsSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 58 of file rendererCreateArgsSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdRendererCreateArgsSchema::BuildRetained ( const HdBoolDataSourceHandle &  gpuEnabled, const HdContainerDataSourceHandle &  drivers  )

static

Deprecated:

Use Builder instead.

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

static HD_API const HdDataSourceLocator& HdRendererCreateArgsSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

HD_API HdSampledDataSourceContainerSchema HdRendererCreateArgsSchema::GetDrivers

(

)

const

Drivers such as Hgi that renderer can use.

static HD_API const HdDataSourceLocator& HdRendererCreateArgsSchema::GetDriversLocator ( )

static

Prim-level relative data source locator to locate drivers.

static HD_API HdRendererCreateArgsSchema HdRendererCreateArgsSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "rendererCreateArgs" from the parent container and constructs a HdRendererCreateArgsSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

HD_API HdBoolDataSourceHandle HdRendererCreateArgsSchema::GetGpuEnabled

(

)

const

Is a GPU available.

static HD_API const HdDataSourceLocator& HdRendererCreateArgsSchema::GetGpuEnabledLocator ( )

static

Prim-level relative data source locator to locate gpuEnabled.

static HD_API const TfToken& HdRendererCreateArgsSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

---

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

• pxr/imaging/hd/rendererCreateArgsSchema.h