# Class: Effect

特效资源，定义了渲染所需的大部分参数，被[Material](Material)所引用。

## Table of contents

### Constructors

- constructor

### Properties

- description

### Accessors

- name
- passCount
- scene

### Methods

- warmUp

## Constructors

### constructor

• **new Effect**(`_scene`, `description`)

根据特效配置生成特效资源。
**注意，不建议自己创建，请使用`scene.createEffect`。**

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `_scene` | [`Scene`](Scene) | - |
| `description` | [`IEffectAsset`](/miniprogram/dev/reference/xr-frame/api/interfaces/IEffectAsset) | 配置。 |

## Properties

### description

• `Readonly` **description**: [`IEffectAsset`](/miniprogram/dev/reference/xr-frame/api/interfaces/IEffectAsset)

## Accessors

### name

• `get` **name**(): `string`

获取名称。

#### Returns

`string`

___

### passCount

• `get` **passCount**(): `number`

有几个Pass。

#### Returns

`number`

___

### scene

• `get` **scene**(): [`Scene`](Scene)

获取场景实例。

#### Returns

[`Scene`](Scene)

## Methods

### warmUp

▸ **warmUp**(): `boolean`

预编译

#### Returns

`boolean`