HdRendererCreateArgsSchema Class Reference

Arguments to HdRendererPlugin::IsSupported and CreateRenderer. More...

#include <rendererCreateArgsSchema.h>

Inheritance diagram for HdRendererCreateArgsSchema:

Classes
class	Builder
	Utility class for setting sparse sets of child data source fields to be filled as arguments into BuildRetained. More...

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

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
	Returns a token where the container representing this schema is found in a container by default.
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.
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.
static HD_API const HdDataSourceLocator &	GetDriversLocator ()
	Prim-level relative data source locator to locate drivers.
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)
	Retrieves a container data source with the schema's default name token "rendererCreateArgs" from the parent container and constructs a HdRendererCreateArgsSchema instance.

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
	Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc.
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

Definition at line 58 of file rendererCreateArgsSchema.h.

Member Function Documentation

BuildRetained()

static HD_API HdContainerDataSourceHandle 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.

GetDefaultLocator()

static HD_API const HdDataSourceLocator & GetDefaultLocator ( )

static

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

GetDrivers()

HD_API HdSampledDataSourceContainerSchema GetDrivers

(

)

const

Drivers such as Hgi that renderer can use.

GetDriversLocator()

static HD_API const HdDataSourceLocator & GetDriversLocator ( )

static

Prim-level relative data source locator to locate drivers.

GetFromParent()

static HD_API 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.

GetGpuEnabled()

HD_API HdBoolDataSourceHandle GetGpuEnabled

(

)

const

Is a GPU available.

GetGpuEnabledLocator()

static HD_API const HdDataSourceLocator & GetGpuEnabledLocator ( )

static

Prim-level relative data source locator to locate gpuEnabled.

GetSchemaToken()

static HD_API const TfToken & 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