> ## Documentation Index
> Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> These docs describe Speckle as it works today, including everything released in 2026.9. Treat page content as current unless the page or section says it applies only to versions published before 2026.9.
> Content scoped to versions published before 2026.9 (the object graph and root object, Proxies, Receive2, operations.receive, object.children) applies only to model versions in that earlier data format. For versions published in 2026.9, answer from the Object model pages and the SDK migration guides.
> The What's new pages summarise what changed in 2026.9 and link to the page that documents each change. Answer from the linked page rather than from the summary. Legacy (v2) connectors are retired; send questions about them to the community help forum.
> Match guidance to the customer's deployment, model data format, connector, plan and permissions. Self-hosted servers on a release before 2026.9 and compatibility-mode workflows follow the Compatibility mode page. If an unknown version or data format changes the answer, ask one focused question; do not infer the deployment version from the date alone.

# BaseGPass

> Abstract base class which contains most of the basic common implementation for most passes.

[GPass](https://docs.speckle.systems/developers/viewer/rendering-pipeline-api/g-pass-api.md) -> [BaseGPass](https://docs.speckle.systems/developers/viewer/rendering-pipeline-api/base-g-pass-api.md)

When developing a new pass, it's recommended to extend this class rather then implementing the `GPass` interface directly.

> [!WARNING]
>
> `BaseGPAss` implements almosts all [GPass](https://docs.speckle.systems/developers/viewer/rendering-pipeline-api/g-pass-api.md)
> members however the `render` function is declared as `abstract` so extending implementations will
> need to implement it themselves

## Methods

### applyLayer

```typescript theme={null}
protected applyLayers(camera: Camera | null)
```

Implementation for applying object layers. Provided for extending types.

**Returns**: `void`

### clear

```typescript theme={null}
protected clear(renderer: WebGLRenderer)
```

Implementation for clearing render targets. Provided for extending types.

**Parameters**:

* **renderer**: The hosting [`WebGLRenderer`](https://threejs.org/docs/index.html?q=webglrend#api/en/renderers/WebGLRenderer)

**Returns**: `void`

### enableLayer

```typescript theme={null}
enableLayer(layer: ObjectLayers, value: boolean): void
```

Enabled/disables specific object layers on the pass.

**Parameters**:

* **layer**: The [ObjectLayers](https://docs.speckle.systems/developers/viewer/viewer-api.md#objectlayers) to enable/disable
* **value**: The value to enable/disable the layer

**Returns**: `void`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.