# Class: RenderSystem

渲染系统，负责整个场景渲染的管理。

## Hierarchy

- [`Component`](Component)

  ↳ **`RenderSystem`**

## Table of contents

### Constructors

- constructor

### Events

- onAdd
- onRelease
- onRemove
- onTick
- onUpdate

### Properties

- priority
- schema
- EVENTS

### Accessors

- el
- renderGraph
- scene
- shadowColor
- version

### Methods

- changeFeatures
- changeMacros
- disableInstance
- enableInstance
- getData
- getFeature
- getMacro
- setData
- setDataOne
- useRenderGraph

## Constructors

### constructor

• **new RenderSystem**()

#### Inherited from

[Component](Component).[constructor](Component#constructor)

## Events

### onAdd

▸ **onAdd**(`parent`, `data`): `void`

所挂载的`element`被挂载到场景时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onAdd](Component#onAdd)

___

### onRelease

▸ **onRelease**(`data`): `void`

从被挂载的`element`上被移除，或是`element`被销毁时，触发的回调。
一般用于释放持有的资源。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRelease](Component#onRelease)

___

### onRemove

▸ **onRemove**(`parent`, `data`): `void`

所挂载的`element`从父节点`parent`被移除时，或者自己从`element`上被移除时，触发的回调。
一般用于消除功能的运作。
**如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。**

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRemove](Component#onRemove)

___

### onTick

▸ **onTick**(): `void`

渲染每帧触发的回调。

#### Returns

`void`

#### Inherited from

[Component](Component).[onTick](Component#onTick)

___

### onUpdate

▸ **onUpdate**(`data`, `preData`): `void`

数据更新时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |
| `preData` | [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onUpdate](Component#onUpdate)

## Properties

### priority

• `Readonly` **priority**: `number` = `400`

自定义组件的更新优先级。

#### Overrides

[Component](Component).[priority](Component#priority)

___

### schema

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

详见[RenderSystemSchema](../modules#RenderSystemSchema)。

#### Overrides

[Component](Component).[schema](Component#schema)

___

### EVENTS

▪ `Static` **EVENTS**: `string`[] = `[]`

#### Inherited from

[Component](Component).[EVENTS](Component#EVENTS)

## Accessors

### el

• `get` **el**(): [`Element`](Element)

挂载的元素。

#### Returns

[`Element`](Element)

___

### renderGraph

• `get` **renderGraph**(): `default`

当前正在使用的RenderGraph。

#### Returns

`default`

___

### scene

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

当前场景。

#### Returns

[`Scene`](Scene)

___

### shadowColor

• `get` **shadowColor**(): `number`[]

#### Returns

`number`[]

___

### version

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

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

#### Returns

`number`

## Methods

### changeFeatures

▸ **changeFeatures**(`features`): `void`

修改全局渲染特性。

#### Parameters

| Name | Type |
| :------ | :------ |
| `features` | `Object` |

#### Returns

`void`

___

### changeMacros

▸ **changeMacros**(`macros`): `void`

修改全局宏信息。

#### Parameters

| Name | Type |
| :------ | :------ |
| `macros` | `Object` |

#### Returns

`void`

___

### disableInstance

▸ **disableInstance**(): `void`

关闭全局GPU实例化。

#### Returns

`void`

___

### enableInstance

▸ **enableInstance**(): `void`

开启全局GPU实例化。

#### Returns

`void`

___

### getData

▸ **getData**(`key`): [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData)[`T`]

获取一个当前值。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends keyof [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |

#### Returns

[`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData)[`T`]

#### Inherited from

[Component](Component).[getData](Component#getData)

___

### getFeature

▸ **getFeature**(`key`): `string` \| `number` \| `boolean`

获取全局渲染特性。

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `string` |

#### Returns

`string` \| `number` \| `boolean`

___

### getMacro

▸ **getMacro**(`key`): `string` \| `number` \| `boolean`

获取全局宏信息。

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `string` |

#### Returns

`string` \| `number` \| `boolean`

___

### setData

▸ **setData**(`data`): `void`

不通过`xml`而是直接设置`data`，注意值的类型需要和`schema`中一致。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `Partial` |

#### Returns

`void`

#### Inherited from

[Component](Component).[setData](Component#setData)

___

### setDataOne

▸ **setDataOne**(`key`, `value`): `void`

设置一个数据。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends keyof [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |
| `value` | [`IRenderSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IRenderSystemData)[`T`] |

#### Returns

`void`

#### Inherited from

[Component](Component).[setDataOne](Component#setDataOne)

___

### useRenderGraph

▸ **useRenderGraph**(`rg`): `void`

使用某个RenderGraph，默认会使用内置的`ForwardBaseRG`。

#### Parameters

| Name | Type |
| :------ | :------ |
| `rg` | `default` |

#### Returns

`void`