OpenUSD

https://openusd.org/docs/
Admin
OpenUSD (Universal Scene Description) is an open-source, extensible software platform developed by...
Tokens:5,330,560
Snippets:29,206
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### UsdRiPxrAovLight Schema Definition and Access (C++)

Source: https://openusd.org/docs/api/pxr_aov_light_8h_source

Defines the UsdRiPxrAovLight schema, a concrete typed schema for AOV lights. It includes static methods for getting or defining UsdRiPxrAovLight prims on a UsdStage, essential for scene setup. These methods facilitate the creation and retrieval of AOV light prims, ensuring proper schema instantiation.

```cpp
class UsdRiPxrAovLight : public UsdLuxLight
{
public:
static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;

explicit UsdRiPxrAovLight(const UsdPrim& prim=UsdPrim());
explicit UsdRiPxrAovLight(const UsdSchemaBase& schemaObj);

USDRI_API
virtual ~UsdRiPxrAovLight();

USDRI_API
static const TfTokenVector & 
GetSchemaAttributeNames(bool includeInherited=true);

USDRI_API
static UsdRiPxrAovLight
Get(const UsdStagePtr &stage, const SdfPath &path);

USDRI_API
static UsdRiPxrAovLight
Define(const UsdStagePtr &stage, const SdfPath &path);

protected:
USDRI_API
UsdSchemaKind _GetSchemaKind() const override;

private:
friend class UsdSchemaRegistry;
USDRI_API
static const TfType& _GetStaticTfType();

static bool _IsTypedSchema();

USDRI_API
const TfType &_GetTfType() const override;
};
```

--------------------------------

### Starts Asleep Attribute

Source: https://openusd.org/docs/api/class_usd_physics_rigid_body_a_p_i

API for getting and creating the 'startsAsleep' attribute, which determines if the body starts in a sleeping state.

```APIDOC
## Starts Asleep Attribute

### Description
Manages the 'startsAsleep' attribute, which controls whether the rigid body begins the simulation in a sleeping state.

### Method
- GetStartsAsleepAttr
- CreateStartsAsleepAttr

### Parameters
#### CreateStartsAsleepAttr
- **defaultValue** (VtValue) - Optional - The default value for the attribute.
- **writeSparsely** (bool) - Optional - Whether to write the attribute sparsely.

### Request Example
```json
{
  "function": "CreateStartsAsleepAttr",
  "arguments": {
    "defaultValue": null,
    "writeSparsely": false
  }
}
```

### Response
#### Success Response (200)
- **UsdAttribute** - The UsdAttribute object for 'startsAsleep'.

#### Response Example
```json
{
  "attributeName": "startsAsleep",
  "type": "token"
}
```
```

--------------------------------

### UsdImagingGLEngine Initialization and Configuration

Source: https://openusd.org/docs/api/usd_imaging_2usd_imaging_g_l_2engine_8h_source

Methods related to initializing and configuring the UsdImagingGLEngine.

```APIDOC
## UsdImagingGLEngine Constructor

### Description
Constructs a UsdImagingGLEngine, optionally taking a HdDriver.

### Method
`USDIMAGINGGL_API UsdImagingGLEngine(const HdDriver &driver=HdDriver())`

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "UsdImagingGLEngine engine(myHdDriver);"
}
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

```APIDOC
## UsdImagingGLEngine::SetRenderBufferSize

### Description
Sets the size of the render buffers used for baking AOVs.

### Method
`USDIMAGINGGL_API void SetRenderBufferSize(GfVec2i const &size)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "engine.SetRenderBufferSize(GfVec2i(1024, 768));"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## UsdImagingGLEngine::SetCameraState

### Description
Sets the camera framing state directly using view and projection matrices.

### Method
`USDIMAGINGGL_API void SetCameraState(const GfMatrix4d &viewMatrix, const GfMatrix4d &projectionMatrix)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "engine.SetCameraState(viewMatrix, projectionMatrix);"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## UsdImagingGLEngine::SetCameraStateFromOpenGL

### Description
Helper function to extract camera and viewport state from OpenGL and then call `SetCameraState` and `SetRenderBufferSize`.

### Method
`USDIMAGINGGL_API void SetCameraStateFromOpenGL()`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "engine.SetCameraStateFromOpenGL();"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## UsdImagingGLEngine::SetLightingStateFromOpenGL

### Description
Helper function to extract lighting state from OpenGL and then call `SetLights`.

### Method
`USDIMAGINGGL_API void SetLightingStateFromOpenGL()`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "engine.SetLightingStateFromOpenGL();"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## UsdImagingGLEngine::SetOverrideWindowPolicy

### Description
Specifies whether to force a window policy when conforming the frustum of the camera to match the display.

### Method
`USDIMAGINGGL_API void SetOverrideWindowPolicy(const std::pair< bool, CameraUtilConformWindowPolicy > &policy)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "engine.SetOverrideWindowPolicy({true, windowPolicy});"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get Python Module Path - C++

Source: https://openusd.org/docs/api/py_interpreter_8h

Retrieves the disk path of a specified Python module. This utility function is useful for locating Python modules at runtime. It ensures the Python interpreter is started if necessary and handles the necessary thread state setup. Returns the path as an NSString.

```cpp
TF_API std::string TfPyGetModulePath (const std::string &moduleName)
{
  // Implementation details for getting module path
  return ""; // Placeholder for actual return value
}
```

--------------------------------

### UsdRiPxrAovLight Constructor and Schema Info

Source: https://openusd.org/docs/api/pxr_aov_light_8h_source

Demonstrates the constructor for UsdRiPxrAovLight and methods to retrieve schema information. The constructor initializes the schema on a UsdPrim, and schema methods provide details about the schema's nature and attributes.

```cpp
UsdRiPxrAovLight::UsdRiPxrAovLight(const UsdPrim &prim=UsdPrim()) 
static const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true) 
USDRI_API UsdSchemaKind _GetSchemaKind() const override
```

--------------------------------

### UsdImagingInstanceAdapter Populate and Update Methods

Source: https://openusd.org/docs/api/instance_adapter_8h_source

Describes the `Populate` and `UpdateForTime` methods of UsdImagingInstanceAdapter. `Populate` is responsible for initially adding a prim to the render index, while `UpdateForTime` handles refreshing cached data for a given time, which is crucial for animation and dynamic scene updates.

```C++
virtual SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
// Called to populate the RenderIndex for this UsdPrim.

virtual void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
// Populates the cache for the given prim, time and requestedBits.
```

--------------------------------

### Clip Template Start Time

Source: https://openusd.org/docs/api/clips_a_p_i_8h_source

APIs to get and set the start time for clip templates.

```APIDOC
## GetClipTemplateStartTime

### Description
Retrieves the start time for the clip template. This defines the beginning of the time range for asset path lookups.

### Method
Method

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
- **clipSet** (string) - Optional - The name of the clip set. Defaults to the default clip set.

#### Request Body
None

### Request Example
```json
{
  "clipSet": "default"
}
```

### Response
#### Success Response (double)
- **clipTemplateStartTime** (double) - The start time of the clip template.

#### Response Example
```json
{
  "clipTemplateStartTime": 0.0
}
```
```

```APIDOC
## SetClipTemplateStartTime

### Description
Sets the start time for the clip template. This time marks the beginning of the range where USD searches for asset paths for the clip set.

### Method
Method

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
- **clipSet** (string) - Optional - The name of the clip set. Defaults to the default clip set.

#### Request Body
- **clipTemplateStartTime** (double) - Required - The start time value to set for the clip template.

### Request Example
```json
{
  "clipTemplateStartTime": 100.0,
  "clipSet": "default"
}
```

### Response
#### Success Response (bool)
Returns true if the setting was successful, false otherwise.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### C++ Start Time Code Management

Source: https://openusd.org/docs/api/layer_8h_source

Functions for managing the start time code of the scene. This includes getting, setting, checking for existence, and clearing the start time code value.

```cpp
SDF_API
double GetStartTimeCode() const;

SDF_API
void SetStartTimeCode(double startTimecode);

SDF_API
bool HasStartTimeCode() const;

SDF_API
void ClearStartTimeCode();
```

--------------------------------

### Parallel Setup and Resolve

Source: https://openusd.org/docs/api/class_usd_imaging_volume_adapter

Methods for parallel setup and resolution, including tracking variability and updating for time.

```APIDOC
## Parallel Setup and Resolve

### `TrackVariability`

#### Description
Tracks the variability of a prim for a given time.

#### Method
`virtual void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext = NULL) const override`

#### Thread Safety
Thread Safe.

### `UpdateForTime`

#### Description
Updates the prim's state for a specific time.

#### Method
`virtual void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext = NULL) const override`

#### Thread Safety
Thread Safe.

### `GetVolumeFieldDescriptors`

#### Description
Retrieves volume field descriptors for a given USD prim.

#### Method
`virtual HdVolumeFieldDescriptorVector GetVolumeFieldDescriptors(UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) const override`
```

--------------------------------

### UsdImagingGLEngine Lighting Configuration

Source: https://openusd.org/docs/api/usd_imaging_2usd_imaging_g_l_2engine_8h_source

Methods for setting up lighting for the scene, either from OpenGL state or by providing explicit light and material data.

```APIDOC
## UsdImagingGLEngine Lighting Configuration

### Description
These methods allow you to configure the lighting for the scene. You can either load the lighting state from the current OpenGL state or provide explicit lighting data, including lights, materials, and ambient light.

### Method
- `SetLightingStateFromOpenGL`
- `SetLightingState` (with GlfSimpleLightingContextPtr)
- `SetLightingState` (with GlfSimpleLightVector, GlfSimpleMaterial, GfVec4f)

### Parameters
#### SetLightingStateFromOpenGL
None

#### SetLightingState (Context)
- **src** (GlfSimpleLightingContextPtr const&) - A pointer to a lighting context.

#### SetLightingState (Manual)
- **lights** (GlfSimpleLightVector const&) - A vector of simple lights.
- **material** (GlfSimpleMaterial const&) - The scene material.
- **sceneAmbient** (GfVec4f const&) - The scene's ambient light color.

### Request Example
```cpp
UsdImagingGLEngine engine;

// Set lighting from OpenGL state
engine.SetLightingStateFromOpenGL();

// Set lighting using a context pointer
GlfSimpleLightingContextPtr lightingContext;
engine.SetLightingState(lightingContext);

// Set lighting manually
GlfSimpleLightVector lights;
GlfSimpleMaterial material;
GfVec4f sceneAmbient;
engine.SetLightingState(lights, material, sceneAmbient);
```

### Response
#### Success Response
The lighting state of the renderer is updated.

#### Response Example
(N/A - Methods modify internal state)
```

--------------------------------

### Get Ray Starting Point (C++)

Source: https://openusd.org/docs/api/class_gf_ray

Returns the starting point of the ray. This function is inline and defined in ray.h.

```C++
const GfVec3d& GetStartPoint() const inline
```

--------------------------------

### Get Instance Indices (C++)

Source: https://openusd.org/docs/api/class_usd_imaging_delegate

Gets the extracted indices array of the prototype ID used in the instancer. Example: GetInstanceIndices(A) : [0, 2, 3]. Reimplemented from HdSceneDelegate.

```cpp
virtual USDIMAGING_API VtIntArray GetInstanceIndices(SdfPath const & _instancerId_, SdfPath const & _prototypeId_)
{
    // implementation details
}
```

--------------------------------

### Populate Scene in OpenUSD

Source: https://openusd.org/docs/api/instance_adapter_8h_source

Private method to populate the scene index with prim data. It handles instancers and recursively adds prototype prims.

```cpp
private:
    SdfPath _Populate(UsdPrim const& prim,
        UsdImagingIndexProxy* index,
        UsdImagingInstancerContext const* instancerContext,
        SdfPath const& parentProxyPath);
```

--------------------------------

### Hgi Platform Defaults and Creation

Source: https://openusd.org/docs/api/hgi_8h_source

Static methods to retrieve the platform's default Hgi instance and to create a new default Hgi instance. These are essential for initializing the rendering system and obtaining a handle to the underlying graphics API implementation.

```cpp
#include "pxr/imaging/hgi/types.h"
#include <memory>

PXR_NAMESPACE_OPEN_SCOPE

using HgiUniquePtr = std::unique_ptr<class Hgi>;

class Hgi {
 public:
  // ... other Hgi methods ...

  HGI_API
  static Hgi* GetPlatformDefaultHgi();

  HGI_API
  static HgiUniquePtr CreatePlatformDefaultHgi();

  // ... other Hgi methods ...
};

PXR_NAMESPACE_CLOSE_SCOPE
```

--------------------------------

### Clip Template Start Time API

Source: https://openusd.org/docs/api/class_usd_clips_a_p_i

Functions to get and set the start time for clip templates for a given clip set or the default clip set.

```APIDOC
## GET /clip/template/startTime

### Description
Retrieves the start time of the range USD uses to search for asset paths for a specified clip set.

### Method
GET

### Endpoint
/clip/template/startTime

### Parameters
#### Query Parameters
- **clipSet** (string) - Optional - The name of the clip set to retrieve the start time for. If not provided, the default clip set is used.

### Response
#### Success Response (200)
- **clipTemplateStartTime** (double) - The start time of the clip template range.

#### Response Example
```json
{
  "clipTemplateStartTime": 1.0
}
```

## POST /clip/template/startTime

### Description
Sets the template start time for a specified clip set.

### Method
POST

### Endpoint
/clip/template/startTime

### Parameters
#### Request Body
- **clipTemplateStartTime** (double) - Required - The desired start time for the clip template.
- **clipSet** (string) - Optional - The name of the clip set to set the start time for. If not provided, the default clip set is used.

### Request Example
```json
{
  "clipTemplateStartTime": 1.5,
  "clipSet": "myClipSet"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### GfRange1d Constructor and Initialization

Source: https://openusd.org/docs/api/range1d_8h_source

Details on how to create and initialize GfRange1d objects.

```APIDOC
## GfRange1d Constructors

### Description
Provides methods for creating and initializing GfRange1d objects.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "// Default constructor\nGfRange1d range1;\n// Constructor with min and max values\nGfRange1d range2(0.0, 10.0);"
}
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Get Angle Attribute

Source: https://openusd.org/docs/api/class_usd_lux_distant_light

Gets the 'angle' attribute for a UsdLuxDistantLight. This attribute represents the angular size of the light in degrees. The documentation provides an example where the Sun is approximately 0.53 degrees.

```cpp
USDLUX_API UsdAttribute GetAngleAttr() const
```

--------------------------------

### Get Starts Asleep Attribute (C++)

Source: https://openusd.org/docs/api/class_usd_physics_rigid_body_a_p_i

Retrieves the UsdAttribute for the 'physics:startsAsleep' property. This boolean attribute determines whether a rigid body should start in a 'sleeping' state when the simulation begins. Defaults to false (0).

```c++
USDPHYSICS_API UsdAttribute GetStartsAsleepAttr() const

```

--------------------------------

### C++ Instancer Data Map and Instance-to-Instancer Mapping

Source: https://openusd.org/docs/api/instance_adapter_8h_source

Describes the _InstancerDataMap and _InstanceToInstancerMap typedefs. _InstancerDataMap maps hydra instancer cache paths to their state, while _InstanceToInstancerMap maps USD instance prim paths to their assigned hydra instancer's cache path.

```cpp
// Map from hydra instancer cache path to the various instancer state we
// need to answer adapter queries.
// Note: this map is modified in multithreaded code paths and must be
// locked.
typedef std::unordered_map<SdfPath, _InstancerData, SdfPath::Hash>
    _InstancerDataMap;
_InstancerDataMap _instancerData;

// Map from USD instance prim paths to the cache path of the hydra instancer
// they are assigned to (which will typically be the path to the first
// instance of this instance group we run across).
// XXX: consider to move this forwarding map into HdRenderIndex.
typedef TfHashMap<SdfPath, SdfPath, SdfPath::Hash>
    _InstanceToInstancerMap;
_InstanceToInstancerMap _instanceToInstancerMap;

```

--------------------------------

### C++ Usage Example: Adding Variants

Source: https://openusd.org/docs/api/class_usd_variant_set

Shows a C++ example of creating and selecting variants using UsdVariantSet. This demonstrates the typical workflow of getting a VariantSet, adding a variant, and setting its selection.

```cpp
UsdVariantSet vs = prim.GetVariantSet("myVariantSet");
vs.AddVariant("myFirstVariation");
vs.SetVariantSelection("myFirstVariation");
```

--------------------------------

### UsdImagingGLEngine Constructor

Source: https://openusd.org/docs/api/usd_imaging_2usd_imaging_g_l_2engine_8h_source

This snippet shows the constructor for the UsdImagingGLEngine class. It demonstrates how to initialize the engine, optionally providing a HdDriver which contains the Hgi for rendering.

```cpp
USDIMAGINGGL_API UsdImagingGLEngine(const HdDriver &driver=HdDriver())
```

--------------------------------

### Get Clip Template Start Time (C++)

Source: https://openusd.org/docs/api/class_usd_clips_a_p_i

Retrieves the start time for a given clip set. Overloaded versions handle default clip sets. Returns true on success, false otherwise.

```cpp
USD_API bool GetClipTemplateStartTime(double *clipTemplateStartTime, const std::string &clipSet) const
USD_API bool GetClipTemplateStartTime(double *clipTemplateStartTime) const
```

--------------------------------

### Initiate Rendering (C++)

Source: https://openusd.org/docs/api/class_usd_imaging_g_l_engine

The primary entry point for starting a rendering process. It takes a root prim and render parameters to define the scene and rendering configuration.

```cpp
USDIMAGINGGL_API void Render(const UsdPrim & _root_, const UsdImagingGLRenderParams & _params_)
```

--------------------------------

### UsdRenderSettings Class Methods

Source: https://openusd.org/docs/api/settings_8h_source

Provides documentation for various methods within the UsdRenderSettings class, including schema attribute retrieval, instance creation, and purpose attribute handling.

```APIDOC
## UsdRenderSettings::GetSchemaAttributeNames

### Description
Returns a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

### Method
`static const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)`

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **TfTokenVector** - A vector of schema attribute names.

#### Response Example
```json
{
  "example": "['includedPurposes', 'materialBindingPurposes', 'products']"
}
```

## UsdRenderSettings::GetMaterialBindingPurposesAttr

### Description
Ordered list of material purposes to consider when resolving material bindings in the scene.

### Method
`UsdAttribute GetMaterialBindingPurposesAttr() const`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdAttribute** - The attribute representing material binding purposes.

#### Response Example
```json
{
  "example": "UsdAttribute(Prim, 'materialBindingPurposes')"
}
```

## UsdRenderSettings::Get

### Description
Return a UsdRenderSettings holding the prim adhering to this schema at path on stage.

### Method
`static UsdRenderSettings Get(const UsdStagePtr &stage, const SdfPath &path)`

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdRenderSettings** - The UsdRenderSettings object.

#### Response Example
```json
{
  "example": "UsdRenderSettings(prim)"
}
```

## UsdRenderSettings::_GetSchemaKind

### Description
Returns the kind of schema this class belongs to.

### Method
`UsdSchemaKind _GetSchemaKind() const override`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdSchemaKind** - The schema kind.

#### Response Example
```json
{
  "example": "UsdSchemaKind::ConcreteTyped"
}
```

## UsdRenderSettings::GetProductsRel

### Description
The set of RenderProducts the render should produce.

### Method
`UsdRelationship GetProductsRel() const`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdRelationship** - The relationship representing render products.

#### Response Example
```json
{
  "example": "UsdRelationship(Prim, 'products')"
}
```

## UsdRenderSettings::CreateMaterialBindingPurposesAttr

### Description
See GetMaterialBindingPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

### Method
`UsdAttribute CreateMaterialBindingPurposesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **defaultValue** (VtValue) - Optional - The default value for the attribute.
- **writeSparsely** (bool) - Optional - Whether to write the attribute sparsely.

### Request Example
```json
{
  "defaultValue": { "type": "VtValue", "value": [] },
  "writeSparsely": false
}
```

### Response
#### Success Response (200)
- **UsdAttribute** - The created attribute representing material binding purposes.

#### Response Example
```json
{
  "example": "UsdAttribute(Prim, 'materialBindingPurposes')"
}
```

## UsdRenderSettings::GetStageRenderSettings

### Description
Fetch and return stage 's render settings, as indicated by root layer metadata.

### Method
`static UsdRenderSettings GetStageRenderSettings(const UsdStageWeakPtr &stage)`

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdRenderSettings** - The UsdRenderSettings object from the stage's root layer metadata.

#### Response Example
```json
{
  "example": "UsdRenderSettings(prim)"
}
```

## UsdRenderSettings::GetIncludedPurposesAttr

### Description
Attribute for specifying purposes that should be included when processing render settings.

### Method
`UsdAttribute GetIncludedPurposesAttr() const`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdAttribute** - The attribute representing included purposes.

#### Response Example
```json
{
  "example": "UsdAttribute(Prim, 'includedPurposes')"
}
```

## UsdRenderSettings::CreateProductsRel

### Description
Creates a relationship to the 'products' relationship.

### Method
`UsdRelationship CreateProductsRel() const`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdRelationship** - The created relationship for products.

#### Response Example
```json
{
  "example": "UsdRelationship(Prim, 'products')"
}
```

## UsdRenderSettings::Define

### Description
Attempt to 'define' the schema by giving the prim that embodies this schema the appropriate kind.

### Method
`static UsdRenderSettings Define(const UsdStagePtr &stage, const SdfPath &path)`

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this method."
}
```

### Response
#### Success Response (200)
- **UsdRenderSettings** - The UsdRenderSettings object.

#### Response Example
```json
{
  "example": "UsdRenderSettings(prim)"
}
```
```

--------------------------------

### Get Number of Elements (C++)

Source: https://openusd.org/docs/api/class_hd_ext_comp_cpu_computation

Returns the total number of elements contained within the source array for this computation. This is analogous to getting the length of an array, for example, VtVec3dArray().GetLength(). It overrides a function from HdNullBufferSource.

```C++
virtual HD_API size_t GetNumElements() const
```

--------------------------------

### Get and Create BeginDistance Attribute

Source: https://openusd.org/docs/api/pxr_ramp_light_filter_8h_source

Provides methods to get the UsdAttribute for 'beginDistance' and to create it if it doesn't exist. The 'beginDistance' attribute defines the start of the distance for the ramp effect. Creating the attribute allows setting a default value.

```cpp
USDRI_API
UsdAttribute GetBeginDistanceAttr() const;
USDRI_API
UsdAttribute CreateBeginDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
```

--------------------------------

### Instancer and Ext Computation

Source: https://openusd.org/docs/api/class_usd_imaging_mesh_adapter

APIs related to instancer prototypes and Hydra Ext Computation.

```APIDOC
## GetPerPrototypeIndices

### Description
Computes the per-prototype instance indices for a UsdGeomPointInstancer.

### Method
`USDIMAGING_API VtArray<VtIntArray>`

### Endpoint
N/A (Function Call)

### Parameters
- **prim** (UsdPrim) - The instancer prim.
- **time** (UsdTimeCode) - The time to compute indices at.

### Response
- **VtArray<VtIntArray>**: An array of instance indices per prototype.

## GetExtComputationSceneInputNames

### Description
Retrieves the scene input names for an Ext Computation.

### Method
`virtual USDIMAGING_API const TfTokenVector &`

### Endpoint
N/A (Function Call)

### Parameters
- **cachePath** (SdfPath) - The cache path.

### Response
- **const TfTokenVector &**: A constant reference to a vector of scene input names.

## GetExtComputationInputs

### Description
Retrieves the input descriptors for an Ext Computation.

### Method
`virtual USDIMAGING_API HdExtComputationInputDescriptorVector`

### Endpoint
N/A (Function Call)

### Parameters
- **prim** (UsdPrim) - The prim associated with the Ext Computation.
- **cachePath** (SdfPath) - The cache path.
- **instancerContext** (const UsdImagingInstancerContext *) - Context for instancer operations.

### Response
- **HdExtComputationInputDescriptorVector**: A vector of input descriptors.

## GetExtComputationOutputs

### Description
Retrieves the output descriptors for an Ext Computation.

### Method
`virtual USDIMAGING_API HdExtComputationOutputDescriptorVector`

### Endpoint
N/A (Function Call)

### Parameters
- **prim** (UsdPrim) - The prim associated with the Ext Computation.
- **cachePath** (SdfPath) - The cache path.
- **instancerContext** (const UsdImagingInstancerContext *) - Context for instancer operations.

### Response
- **HdExtComputationOutputDescriptorVector**: A vector of output descriptors.

## GetExtComputationPrimvars

### Description
Retrieves the primvar descriptors for an Ext Computation.

### Method
`virtual USDIMAGING_API HdExtComputationPrimvarDescriptorVector`

### Endpoint
N/A (Function Call)

### Parameters
- **prim** (UsdPrim) - The prim associated with the Ext Computation.
- **cachePath** (SdfPath) - The cache path.
- **interpolation** (HdInterpolation) - The interpolation type.
- **instancerContext** (const UsdImagingInstancerContext *) - Context for instancer operations.

### Response
- **HdExtComputationPrimvarDescriptorVector**: A vector of primvar descriptors.

```

--------------------------------

### C++ _ProtoPrim Structure for Instancer Prototypes

Source: https://openusd.org/docs/api/instance_adapter_8h_source

Defines the _ProtoPrim structure, which holds information about a prototype prim used by an instancer. It includes the SdfPath to the prim on the Usd Stage and the UsdImagingPrimAdapter for rendering.

```cpp
struct _ProtoPrim {
    _ProtoPrim() {}
    // Each prim will become a prototype "child" under the instancer.
    // This path is the path to the prim on the Usd Stage (the path to a single
    // mesh, for example).
    SdfPath path;
    // The prim adapter for the actual prototype prim.
    UsdImagingPrimAdapterSharedPtr adapter;
};

// Indexed by prototype cachePath (each prim has one entry)
typedef TfHashMap<SdfPath, _ProtoPrim, SdfPath::Hash> _PrimMap;

```

--------------------------------

### C++ Class Definitions for Doxygen Graph Example

Source: https://openusd.org/docs/api/graph_legend

Illustrates various C++ class definitions including public, protected, and private inheritance, template classes, and usage relationships. These examples are used to demonstrate Doxygen's graph generation capabilities.

```C++
/*! Invisible class because of truncation */
class Invisible { };
/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };
/* Class not documented with doxygen comments */
class Undocumented { };
/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };
/*! A template class */
template<class T> class Templ { };
/*! Class that is inherited using protected inheritance */
class ProtectedBase { };
/*! Class that is inherited using private inheritance */
class PrivateBase { };
/*! Class that is used by the Inherited class */
class Used { };
/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ<int>
{
private:
Used *m_usedClass;
};
```

--------------------------------

### UsdImagingGLEngine Camera and Viewport Setup

Source: https://openusd.org/docs/api/usd_imaging_2usd_imaging_g_l_2engine_8h_source

Methods for configuring the camera and rendering viewport. This includes setting the root transform, visibility, camera path, framing, window policy, render buffer size, and viewport dimensions. It also supports updating camera state directly from OpenGL matrices or automatically.

```cpp
USDIMAGINGGL_API
void SetRootTransform(GfMatrix4d const& xf);
USDIMAGINGGL_API
void SetRootVisibility(bool isVisible);
USDIMAGINGGL_API
void SetCameraPath(SdfPath const& id);
USDIMAGINGGL_API
void SetFraming(CameraUtilFraming const& framing);
USDIMAGINGGL_API
void SetOverrideWindowPolicy(
 const std::pair<bool, CameraUtilConformWindowPolicy> &policy);
USDIMAGINGGL_API
void SetRenderBufferSize(GfVec2i const& size);
USDIMAGINGGL_API
void SetRenderViewport(GfVec4d const& viewport);
USDIMAGINGGL_API
void SetWindowPolicy(CameraUtilConformWindowPolicy policy);
USDIMAGINGGL_API
void SetCameraState(const GfMatrix4d& viewMatrix,
 const GfMatrix4d& projectionMatrix);
USDIMAGINGGL_API
void SetCameraStateFromOpenGL();
```

--------------------------------

### Get Purpose for Prim

Source: https://openusd.org/docs/api/point_instancer_adapter_8h_source

Returns the purpose token for a given UsdPrim. The purpose token defines how the prim should be interpreted for rendering, such as for geometry, proxy, or guides.

```cpp
TfToken GetPurpose(UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &instanceInheritablePurpose) const override
```

--------------------------------

### UsdMediaSpatialAudio: Get (Static Method)

Source: https://openusd.org/docs/api/spatial_audio_8h_source

Static method to get an instance of UsdMediaSpatialAudio from a UsdStagePtr and SdfPath.

```cpp
static UsdMediaSpatialAudio
Get(const UsdStagePtr &stage, const SdfPath &path);
```

--------------------------------

### Get Input Render Type

Source: https://openusd.org/docs/api/class_usd_shade_input

Returns the specialized renderType for this input, or an empty token if none has been authored. This metadata can guide rendering systems on how to interpret or process the input.

```c++
USDSHADE_API TfToken GetRenderType() const;
// See Also
// SetRenderType()
```

--------------------------------

### Get TraceEventNode Begin Time

Source: https://openusd.org/docs/api/event_node_8h_source

Returns the start time of the trace event node. The time is represented as a uint64_t in 'ticks'.

```cpp
TimeStamp GetBeginTime() { return _beginTime; }
```

--------------------------------

### GfLine Constructors

Source: https://openusd.org/docs/api/class_gf_line

Documentation for the default constructor and the constructor that takes a starting point and direction.

```APIDOC
## GfLine Constructors

### Description
Constructs a 3D line.

### Constructor Documentation

#### Default Constructor
```
inline GfLine()
```

The default constructor leaves line parameters undefined.

#### Constructor with Point and Direction
```
inline GfLine(const GfVec3d& _p0_, const GfVec3d& _dir_)
```

Construct a line from a point and a direction. The direction is normalized in the constructor.

### Details
- The line is represented parametrically as `p = p0 + t * dir`.
- Definition in `pxr/base/gf/line.h`.
```

--------------------------------

### Get Layer Color Configuration

Source: https://openusd.org/docs/api/layer_8h_source

Returns the color configuration asset-path for this layer as an SdfAssetPath object. This path points to the asset defining the color setup.

```cpp
SDF_API SdfAssetPath GetColorConfiguration() const 
Returns the color configuration asset-path for this layer.
```

--------------------------------

### UsdMediaSpatialAudio: GetStartTimeAttr

Source: https://openusd.org/docs/api/spatial_audio_8h_source

Gets the startTime attribute for UsdMediaSpatialAudio.

```cpp
USDMEDIA_API UsdAttribute GetStartTimeAttr() const;
```

--------------------------------

### Get Relative Instancer Transform - C++

Source: https://openusd.org/docs/api/class_usd_imaging_cylinder_adapter

Calculates the transform of one instancer relative to another. This is useful for hierarchical instancing setups.

```cpp
virtual USDIMAGING_API GfMatrix4d | GetRelativeInstancerTransform (SdfPath const &instancerPath, SdfPath const &protoInstancerPath, UsdTimeCode time) const
| Returns the transform of `protoInstancerPath` relative to `instancerPath`. More...
```

--------------------------------

### UsdAppUtilsFrameRecorder Class

Source: https://openusd.org/docs/api/frame_recorder_8h_source

Documentation for the UsdAppUtilsFrameRecorder class, including its constructor and methods for configuring rendering and recording.

```APIDOC
## UsdAppUtilsFrameRecorder

### Description
Manages the process of recording frames from a USD stage using a specified camera and time code. It allows configuration of renderer plugins, image dimensions, complexity, color correction, and included purposes.

### Methods

#### Constructor

##### `UsdAppUtilsFrameRecorder()`
* **Description**: Constructs a new `UsdAppUtilsFrameRecorder` object.
* **Signature**: `UsdAppUtilsFrameRecorder()`

#### Renderer Configuration

##### `GetCurrentRendererId()`
* **Description**: Gets the ID of the current renderer plugin.
* **Signature**: `TfToken GetCurrentRendererId() const`

##### `SetRendererPlugin(const TfToken& id)`
* **Description**: Sets the renderer plugin to use. Returns true if successful.
* **Parameters**:
  - **id** (TfToken) - The ID of the renderer plugin.
* **Signature**: `bool SetRendererPlugin(const TfToken& id)`

##### `SetImageWidth(const size_t imageWidth)`
* **Description**: Sets the width of the output image. Throws a coding error if `imageWidth` is zero.
* **Parameters**:
  - **imageWidth** (size_t) - The desired image width.
* **Signature**: `void SetImageWidth(const size_t imageWidth)`

##### `SetComplexity(const float complexity)`
* **Description**: Sets the complexity level for rendering.
* **Parameters**:
  - **complexity** (float) - The complexity value.
* **Signature**: `void SetComplexity(const float complexity)`

##### `SetColorCorrectionMode(const TfToken& colorCorrectionMode)`
* **Description**: Sets the color correction mode for rendering.
* **Parameters**:
  - **colorCorrectionMode** (TfToken) - The color correction mode.
* **Signature**: `void SetColorCorrectionMode(const TfToken& colorCorrectionMode)`

##### `SetIncludedPurposes(const TfTokenVector& purposes)`
* **Description**: Sets the purposes to be included when rendering.
* **Parameters**:
  - **purposes** (TfTokenVector) - A vector of purposes to include.
* **Signature**: `void SetIncludedPurposes(const TfTokenVector& purposes)`

#### Frame Recording

##### `Record(const UsdStagePtr& stage, const UsdGeomCamera& usdCamera, const UsdTimeCode timeCode, const std::string& outputImagePath)`
* **Description**: Records a single frame from the given USD stage using the specified camera and time code, saving it to the output image path.
* **Parameters**:
  - **stage** (UsdStagePtr) - The USD stage to record from.
  - **usdCamera** (UsdGeomCamera) - The USD camera to use for rendering.
  - **timeCode** (UsdTimeCode) - The time code for the frame to record.
  - **outputImagePath** (std::string) - The path where the output image will be saved.
* **Return**: `bool` - Returns true if the recording was successful, false otherwise.
* **Signature**: `bool Record(const UsdStagePtr& stage, const UsdGeomCamera& usdCamera, const UsdTimeCode timeCode, const std::string& outputImagePath)`
```

--------------------------------

### OSL Shader Example with Sdr Metadata

Source: https://openusd.org/docs/api/sdr_page_front

Illustrates an Open Shading Language (OSL) shader with metadata, specifically 'renderType', used to define property types and their translations within the Sdr system. This example shows how custom metadata can guide the interpretation of shader properties.

```OSL
shader TestOSLShader
(
color foo = color(1.0, 1.0 1.0),
token bar = "baz",
token surface = ""
[[
string renderType = "terminal surface"
]]
)
```

--------------------------------

### UsdImagingGLEngine Rendering Methods

Source: https://openusd.org/docs/api/usd_imaging_2usd_imaging_g_l_2engine_8h_source

Methods for preparing and executing render batches or individual renders of USD prims.

```APIDOC
## UsdImagingGLEngine Rendering

### Description
These methods are used to prepare and render USD prims. `PrepareBatch` prepares for rendering a batch of prims, while `RenderBatch` and `Render` execute the actual rendering.

### Method
- `PrepareBatch`
- `RenderBatch`
- `Render`

### Parameters
#### PrepareBatch
- **root** (UsdPrim) - The root prim to prepare for rendering.
- **params** (UsdImagingGLRenderParams) - Rendering parameters.

#### RenderBatch
- **paths** (SdfPathVector) - A vector of SdfPaths to render.
- **params** (UsdImagingGLRenderParams) - Rendering parameters.

#### Render
- **root** (UsdPrim) - The root prim to render.
- **params** (UsdImagingGLRenderParams) - Rendering parameters.

### Request Example
```cpp
UsdImagingGLEngine engine;
UsdPrim root;
UsdImagingGLRenderParams params;

// Prepare for rendering a batch
engine.PrepareBatch(root, params);

// Render a batch of paths
SdfPathVector paths;
engine.RenderBatch(paths, params);

// Render a single prim
engine.Render(root, params);
```

### Response
#### Success Response
Rendering is executed according to the provided parameters.

#### Response Example
(N/A - Methods perform rendering operations)
```

--------------------------------

### UsdImagingVolumeAdapter::Populate Method

Source: https://openusd.org/docs/api/volume_adapter_8h_source

Populates the render index for the given UsdPrim. This is the main entry point for adapters to register their capabilities and data with the render index. It takes the prim, an index proxy, and an optional instancer context.

```cpp
virtual SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
```

--------------------------------

### Get Clip Template Start Time (C++)

Source: https://openusd.org/docs/api/clips_a_p_i_8h_source

Retrieves the start time for the clip template within a given clip set. This value indicates the beginning of the range USD uses to search for asset paths for the clip set. It's crucial for defining the temporal scope of clips.

```cpp
USD_API bool GetClipTemplateStartTime(double* clipTemplateStartTime, const std::string& clipSet) const;
```
Tokens:
Raw