@belife/belife-bim-air 1.6.1-zy.86.patch.6 → 1.6.1-zy.86.patch.8

package/docs/classes/Longan.BaseShader.md

@@ -1,804 +0,0 @@
-[gs-bim-air](../gs-bim-air.md) / [Longan](../modules/Longan.md) / BaseShader
-
-# Class: BaseShader
-
-[Longan](../modules/Longan.md).BaseShader
-
-## Hierarchy
-
-- [`Shader`](Longan.Shader.md)
-
-  ↳ **`BaseShader`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Longan.BaseShader.md#constructor)
-
-### Properties
-
-- [\_fragment](Longan.BaseShader.md#_fragment)
-- [\_gl](Longan.BaseShader.md#_gl)
-- [\_image](Longan.BaseShader.md#_image)
-- [\_name](Longan.BaseShader.md#_name)
-- [\_owner](Longan.BaseShader.md#_owner)
-- [\_program](Longan.BaseShader.md#_program)
-- [\_segment](Longan.BaseShader.md#_segment)
-- [\_vertex](Longan.BaseShader.md#_vertex)
-- [banded\_face](Longan.BaseShader.md#banded_face)
-- [blinn\_phong\_double\_face](Longan.BaseShader.md#blinn_phong_double_face)
-- [blinn\_phong\_face](Longan.BaseShader.md#blinn_phong_face)
-- [blinn\_phong\_face\_custom](Longan.BaseShader.md#blinn_phong_face_custom)
-- [half\_lambert\_face](Longan.BaseShader.md#half_lambert_face)
-- [isLog](Longan.BaseShader.md#islog)
-- [lambert\_face](Longan.BaseShader.md#lambert_face)
-- [pbr\_face](Longan.BaseShader.md#pbr_face)
-- [phong\_face](Longan.BaseShader.md#phong_face)
-- [typeName](Longan.BaseShader.md#typename)
-
-### Accessors
-
-- [customBlinnPhong](Longan.BaseShader.md#customblinnphong)
-- [customEdgeFragment](Longan.BaseShader.md#customedgefragment)
-- [customTextureSampling](Longan.BaseShader.md#customtexturesampling)
-- [customVertexPos](Longan.BaseShader.md#customvertexpos)
-- [fragment](Longan.BaseShader.md#fragment)
-- [fragmentIn](Longan.BaseShader.md#fragmentin)
-- [fragmentMain](Longan.BaseShader.md#fragmentmain)
-- [fragmentUniform](Longan.BaseShader.md#fragmentuniform)
-- [fragmentVoid](Longan.BaseShader.md#fragmentvoid)
-- [gl](Longan.BaseShader.md#gl)
-- [image](Longan.BaseShader.md#image)
-- [name](Longan.BaseShader.md#name)
-- [owner](Longan.BaseShader.md#owner)
-- [program](Longan.BaseShader.md#program)
-- [vertex](Longan.BaseShader.md#vertex)
-- [vertexMain](Longan.BaseShader.md#vertexmain)
-- [vertexOut](Longan.BaseShader.md#vertexout)
-- [vertexUniform](Longan.BaseShader.md#vertexuniform)
-- [vertexVoid](Longan.BaseShader.md#vertexvoid)
-
-### Methods
-
-- [createBuffer](Longan.BaseShader.md#createbuffer)
-- [createIndexBuffer](Longan.BaseShader.md#createindexbuffer)
-- [createVertexArray](Longan.BaseShader.md#createvertexarray)
-- [finaComponent](Longan.BaseShader.md#finacomponent)
-- [getAttribLocation](Longan.BaseShader.md#getattriblocation)
-- [getUniform](Longan.BaseShader.md#getuniform)
-- [getUniformLocation](Longan.BaseShader.md#getuniformlocation)
-- [initComponent](Longan.BaseShader.md#initcomponent)
-- [renderVao](Longan.BaseShader.md#rendervao)
-- [setFloat](Longan.BaseShader.md#setfloat)
-- [setFloat2v](Longan.BaseShader.md#setfloat2v)
-- [setFloat3v](Longan.BaseShader.md#setfloat3v)
-- [setFloat4v](Longan.BaseShader.md#setfloat4v)
-- [setFloatv](Longan.BaseShader.md#setfloatv)
-- [setInt](Longan.BaseShader.md#setint)
-- [setMat4](Longan.BaseShader.md#setmat4)
-
-## Constructors
-
-### constructor
-
-• **new BaseShader**()
-
-#### Overrides
-
-[Shader](Longan.Shader.md).[constructor](Longan.Shader.md#constructor)
-
-## Properties
-
-### \_fragment
-
-• **\_fragment**: `string` = `null`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_fragment](Longan.Shader.md#_fragment)
-
-___
-
-### \_gl
-
-• **\_gl**: `WebGL2RenderingContext` = `null`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_gl](Longan.Shader.md#_gl)
-
-___
-
-### \_image
-
-• **\_image**: `string` = `"../../images/shader.svg"`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_image](Longan.Shader.md#_image)
-
-___
-
-### \_name
-
-• **\_name**: `string` = `"着色器"`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_name](Longan.Shader.md#_name)
-
-___
-
-### \_owner
-
-• **\_owner**: [`RenderObject`](Longan.RenderObject.md) = `null`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_owner](Longan.Shader.md#_owner)
-
-___
-
-### \_program
-
-• **\_program**: `WebGLProgram` = `null`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_program](Longan.Shader.md#_program)
-
-___
-
-### \_segment
-
-• **\_segment**: [`Segment`](Longan.Segment.md) = `null`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_segment](Longan.Shader.md#_segment)
-
-___
-
-### \_vertex
-
-• **\_vertex**: `string` = `null`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[_vertex](Longan.Shader.md#_vertex)
-
-___
-
-### banded\_face
-
-• **banded\_face**: `string`
-
-___
-
-### blinn\_phong\_double\_face
-
-• **blinn\_phong\_double\_face**: `string`
-
-___
-
-### blinn\_phong\_face
-
-• **blinn\_phong\_face**: `string`
-
-___
-
-### blinn\_phong\_face\_custom
-
-• **blinn\_phong\_face\_custom**: `string`
-
-___
-
-### half\_lambert\_face
-
-• **half\_lambert\_face**: `string`
-
-___
-
-### isLog
-
-• **isLog**: `boolean` = `false`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[isLog](Longan.Shader.md#islog)
-
-___
-
-### lambert\_face
-
-• **lambert\_face**: `string`
-
-___
-
-### pbr\_face
-
-• **pbr\_face**: `string`
-
-___
-
-### phong\_face
-
-• **phong\_face**: `string`
-
-___
-
-### typeName
-
-• **typeName**: `string` = `"Shader"`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[typeName](Longan.Shader.md#typename)
-
-## Accessors
-
-### customBlinnPhong
-
-• `get` **customBlinnPhong**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### customEdgeFragment
-
-• `get` **customEdgeFragment**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### customTextureSampling
-
-• `get` **customTextureSampling**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### customVertexPos
-
-• `get` **customVertexPos**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### fragment
-
-• `get` **fragment**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-Shader.fragment
-
-___
-
-### fragmentIn
-
-• `get` **fragmentIn**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### fragmentMain
-
-• `get` **fragmentMain**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### fragmentUniform
-
-• `get` **fragmentUniform**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### fragmentVoid
-
-• `get` **fragmentVoid**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### gl
-
-• `get` **gl**(): `WebGLRenderingContext`
-
-#### Returns
-
-`WebGLRenderingContext`
-
-#### Inherited from
-
-Shader.gl
-
-___
-
-### image
-
-• `get` **image**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-Shader.image
-
-• `set` **image**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Shader.image
-
-___
-
-### name
-
-• `get` **name**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-Shader.name
-
-• `set` **name**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Shader.name
-
-___
-
-### owner
-
-• `get` **owner**(): [`RenderObject`](Longan.RenderObject.md)
-
-#### Returns
-
-[`RenderObject`](Longan.RenderObject.md)
-
-#### Inherited from
-
-Shader.owner
-
-___
-
-### program
-
-• `get` **program**(): `WebGLProgram`
-
-#### Returns
-
-`WebGLProgram`
-
-#### Inherited from
-
-Shader.program
-
-___
-
-### vertex
-
-• `get` **vertex**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-Shader.vertex
-
-___
-
-### vertexMain
-
-• `get` **vertexMain**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### vertexOut
-
-• `get` **vertexOut**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### vertexUniform
-
-• `get` **vertexUniform**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### vertexVoid
-
-• `get` **vertexVoid**(): `string`
-
-#### Returns
-
-`string`
-
-## Methods
-
-### createBuffer
-
-▸ **createBuffer**(`attrName`, `data`, `attrSize`): `WebGLBuffer`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `attrName` | `string` |
-| `data` | `BufferSource` |
-| `attrSize` | `number` |
-
-#### Returns
-
-`WebGLBuffer`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[createBuffer](Longan.Shader.md#createbuffer)
-
-___
-
-### createIndexBuffer
-
-▸ **createIndexBuffer**(`indices`): `WebGLBuffer`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `indices` | `BufferSource` |
-
-#### Returns
-
-`WebGLBuffer`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[createIndexBuffer](Longan.Shader.md#createindexbuffer)
-
-___
-
-### createVertexArray
-
-▸ **createVertexArray**(`vaoInfo`): `vertexArrayObjectInfo`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `vaoInfo` | `any` |
-
-#### Returns
-
-`vertexArrayObjectInfo`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[createVertexArray](Longan.Shader.md#createvertexarray)
-
-___
-
-### finaComponent
-
-▸ **finaComponent**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[finaComponent](Longan.Shader.md#finacomponent)
-
-___
-
-### getAttribLocation
-
-▸ **getAttribLocation**(`name`): `number`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-
-#### Returns
-
-`number`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[getAttribLocation](Longan.Shader.md#getattriblocation)
-
-___
-
-### getUniform
-
-▸ **getUniform**(`name`): `Promise`<`any`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[getUniform](Longan.Shader.md#getuniform)
-
-___
-
-### getUniformLocation
-
-▸ **getUniformLocation**(`name`): `WebGLUniformLocation`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-
-#### Returns
-
-`WebGLUniformLocation`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[getUniformLocation](Longan.Shader.md#getuniformlocation)
-
-___
-
-### initComponent
-
-▸ **initComponent**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[initComponent](Longan.Shader.md#initcomponent)
-
-___
-
-### renderVao
-
-▸ **renderVao**(`vaoInfo`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `vaoInfo` | `vertexArrayObjectInfo` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[renderVao](Longan.Shader.md#rendervao)
-
-___
-
-### setFloat
-
-▸ **setFloat**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `number` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setFloat](Longan.Shader.md#setfloat)
-
-___
-
-### setFloat2v
-
-▸ **setFloat2v**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `Float32Array` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setFloat2v](Longan.Shader.md#setfloat2v)
-
-___
-
-### setFloat3v
-
-▸ **setFloat3v**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `Float32Array` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setFloat3v](Longan.Shader.md#setfloat3v)
-
-___
-
-### setFloat4v
-
-▸ **setFloat4v**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `Float32Array` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setFloat4v](Longan.Shader.md#setfloat4v)
-
-___
-
-### setFloatv
-
-▸ **setFloatv**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `Float32Array` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setFloatv](Longan.Shader.md#setfloatv)
-
-___
-
-### setInt
-
-▸ **setInt**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `number` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setInt](Longan.Shader.md#setint)
-
-___
-
-### setMat4
-
-▸ **setMat4**(`name`, `value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `value` | `Float32Array` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Shader](Longan.Shader.md).[setMat4](Longan.Shader.md#setmat4)