Skip to content

Commit

Permalink
docs: update to 0.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
lslzl3000 committed May 7, 2023
1 parent dee94ef commit 08708eb
Show file tree
Hide file tree
Showing 29 changed files with 227 additions and 238 deletions.
3 changes: 2 additions & 1 deletion docs/.vitepress/components/Demo.vue
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ export default {
this.loading = false
}
})
if(!location.hostname.match(/orillusion/) && !window.esbuild){
if(!location.hostname.match(/orillusion/) && !window.esbuild && !window._esbuild){
window._esbuild = true
const esbuild = await import('https://cdn.orillusion.com/esbuild.js')
await esbuild.initialize({
wasmURL: 'https://cdn.orillusion.com/esbuild.wasm'
Expand Down
4 changes: 2 additions & 2 deletions docs/api/classes/AtmosphericComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -1191,7 +1191,7 @@ ___

#### Defined in

[src/components/renderer/RenderNode.ts:245](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L245)
[src/components/renderer/RenderNode.ts:243](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L243)

___

Expand Down Expand Up @@ -1220,7 +1220,7 @@ ___

#### Defined in

[src/components/renderer/RenderNode.ts:334](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L334)
[src/components/renderer/RenderNode.ts:328](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L328)

___

Expand Down
33 changes: 19 additions & 14 deletions docs/api/classes/DirectLight.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ The light of this light source is parallel, for example, sunlight. This light so
- [radius](DirectLight.md#radius)
- [indirect](DirectLight.md#indirect)
- [castShadow](DirectLight.md#castshadow)
- [iesPofile](DirectLight.md#iespofile)
- [iesProfiles](DirectLight.md#iesprofiles)
- [iesProfile](DirectLight.md#iesprofile)
- [r](DirectLight.md#r)
- [g](DirectLight.md#g)
- [b](DirectLight.md#b)
Expand Down Expand Up @@ -379,41 +380,45 @@ LightBase.castShadow

___

### iesPofile
### iesProfiles

`get` **iesPofile**(): [`IESProfiles`](IESProfiles.md)
`set` **iesProfiles**(`iesProfiles`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `iesProfiles` | [`IESProfiles`](IESProfiles.md) |

#### Returns

[`IESProfiles`](IESProfiles.md)
`void`

#### Inherited from

LightBase.iesPofile
LightBase.iesProfiles

#### Defined in

[src/components/lights/LightBase.ts:116](https://github.com/Orillusion/orillusion/blob/main/src/components/lights/LightBase.ts#L116)
[src/components/lights/LightBase.ts:109](https://github.com/Orillusion/orillusion/blob/main/src/components/lights/LightBase.ts#L109)

`set` **iesPofile**(`iesPofiles`): `void`
___

#### Parameters
### iesProfile

| Name | Type |
| :------ | :------ |
| `iesPofiles` | [`IESProfiles`](IESProfiles.md) |
`get` **iesProfile**(): [`IESProfiles`](IESProfiles.md)

#### Returns

`void`
[`IESProfiles`](IESProfiles.md)

#### Inherited from

LightBase.iesPofile
LightBase.iesProfile

#### Defined in

[src/components/lights/LightBase.ts:109](https://github.com/Orillusion/orillusion/blob/main/src/components/lights/LightBase.ts#L109)
[src/components/lights/LightBase.ts:116](https://github.com/Orillusion/orillusion/blob/main/src/components/lights/LightBase.ts#L116)

___

Expand Down
12 changes: 6 additions & 6 deletions docs/api/classes/Engine3D.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ create webgpu 3d engine

#### Defined in

[src/Engine3D.ts:256](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L256)
[src/Engine3D.ts:257](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L257)

___

Expand All @@ -228,7 +228,7 @@ set render view and start renderer

#### Defined in

[src/Engine3D.ts:290](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L290)
[src/Engine3D.ts:291](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L291)

___

Expand All @@ -250,7 +250,7 @@ set render views and start renderer

#### Defined in

[src/Engine3D.ts:307](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L307)
[src/Engine3D.ts:308](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L308)

___

Expand All @@ -272,7 +272,7 @@ get view render job instance

#### Defined in

[src/Engine3D.ts:325](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L325)
[src/Engine3D.ts:326](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L326)

___

Expand All @@ -288,7 +288,7 @@ Pause the engine render

#### Defined in

[src/Engine3D.ts:332](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L332)
[src/Engine3D.ts:333](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L333)

___

Expand All @@ -304,7 +304,7 @@ Resume the engine render

#### Defined in

[src/Engine3D.ts:342](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L342)
[src/Engine3D.ts:343](https://github.com/Orillusion/orillusion/blob/main/src/Engine3D.ts#L343)

## Constructors

Expand Down
34 changes: 17 additions & 17 deletions docs/api/classes/HDRBloomPost.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ HDR Bloom effect
### Accessors
- [bloomStrength](HDRBloomPost.md#bloomstrength)
- [bloomRadius](HDRBloomPost.md#bloomradius)
- [strength](HDRBloomPost.md#strength)
- [radius](HDRBloomPost.md#radius)
- [luminosityThreshold](HDRBloomPost.md#luminositythreshold)
### Properties
Expand Down Expand Up @@ -69,7 +69,7 @@ PostBase.onAttach
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:87](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L87)
[src/gfx/renderJob/post/HDRBloomPost.ts:89](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L89)
___
Expand All @@ -93,7 +93,7 @@ PostBase.onDetach
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:91](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L91)
[src/gfx/renderJob/post/HDRBloomPost.ts:93](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L93)
___
Expand All @@ -107,7 +107,7 @@ ___
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:94](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L94)
[src/gfx/renderJob/post/HDRBloomPost.ts:96](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L96)
___
Expand All @@ -129,19 +129,19 @@ PostBase.destroy
## Accessors
### bloomStrength
### strength
• `get` **bloomStrength**(): `number`
• `get` **strength**(): `number`
#### Returns
`number`
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:97](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L97)
[src/gfx/renderJob/post/HDRBloomPost.ts:99](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L99)
• `set` **bloomStrength**(`value`): `void`
• `set` **strength**(`value`): `void`
#### Parameters
Expand All @@ -155,23 +155,23 @@ PostBase.destroy
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:101](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L101)
[src/gfx/renderJob/post/HDRBloomPost.ts:103](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L103)
___
### bloomRadius
### radius
• `get` **bloomRadius**(): `number`
• `get` **radius**(): `number`
#### Returns
`number`
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:105](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L105)
[src/gfx/renderJob/post/HDRBloomPost.ts:107](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L107)
• `set` **bloomRadius**(`value`): `void`
• `set` **radius**(`value`): `void`
#### Parameters
Expand All @@ -185,7 +185,7 @@ ___
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:109](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L109)
[src/gfx/renderJob/post/HDRBloomPost.ts:111](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L111)
___
Expand All @@ -199,7 +199,7 @@ ___
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:113](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L113)
[src/gfx/renderJob/post/HDRBloomPost.ts:115](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L115)
• `set` **luminosityThreshold**(`value`): `void`
Expand All @@ -215,7 +215,7 @@ ___
#### Defined in
[src/gfx/renderJob/post/HDRBloomPost.ts:117](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L117)
[src/gfx/renderJob/post/HDRBloomPost.ts:119](https://github.com/Orillusion/orillusion/blob/main/src/gfx/renderJob/post/HDRBloomPost.ts#L119)
## Properties
Expand Down
4 changes: 2 additions & 2 deletions docs/api/classes/InstanceDrawComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -936,7 +936,7 @@ RenderNode.renderPass2

#### Defined in

[src/components/renderer/RenderNode.ts:294](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L294)
[src/components/renderer/RenderNode.ts:291](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L291)

___

Expand Down Expand Up @@ -965,7 +965,7 @@ RenderNode.recordRenderPass2

#### Defined in

[src/components/renderer/RenderNode.ts:334](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L334)
[src/components/renderer/RenderNode.ts:328](https://github.com/Orillusion/orillusion/blob/main/src/components/renderer/RenderNode.ts#L328)

## Constructors

Expand Down
Loading

0 comments on commit 08708eb

Please sign in to comment.