@belife/belife-bim-air 1.6.1-zy.86.patch.7 → 1.6.1-zy.86.patch.9

package/docs/classes/Longan.Shader.md

@@ -0,0 +1,526 @@
+[gs-bim-air](../gs-bim-air.md) / [Longan](../modules/Longan.md) / Shader
+
+# Class: Shader
+
+[Longan](../modules/Longan.md).Shader
+
+## Hierarchy
+
+- [`PropertyComponent`](Longan.PropertyComponent.md)
+
+  ↳ **`Shader`**
+
+  ↳↳ [`BaseShader`](Longan.BaseShader.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Longan.Shader.md#constructor)
+
+### Properties
+
+- [\_fragment](Longan.Shader.md#_fragment)
+- [\_gl](Longan.Shader.md#_gl)
+- [\_image](Longan.Shader.md#_image)
+- [\_name](Longan.Shader.md#_name)
+- [\_owner](Longan.Shader.md#_owner)
+- [\_program](Longan.Shader.md#_program)
+- [\_segment](Longan.Shader.md#_segment)
+- [\_vertex](Longan.Shader.md#_vertex)
+- [isLog](Longan.Shader.md#islog)
+- [typeName](Longan.Shader.md#typename)
+
+### Accessors
+
+- [fragment](Longan.Shader.md#fragment)
+- [gl](Longan.Shader.md#gl)
+- [image](Longan.Shader.md#image)
+- [name](Longan.Shader.md#name)
+- [owner](Longan.Shader.md#owner)
+- [program](Longan.Shader.md#program)
+- [vertex](Longan.Shader.md#vertex)
+
+### Methods
+
+- [createBuffer](Longan.Shader.md#createbuffer)
+- [createIndexBuffer](Longan.Shader.md#createindexbuffer)
+- [createVertexArray](Longan.Shader.md#createvertexarray)
+- [finaComponent](Longan.Shader.md#finacomponent)
+- [getAttribLocation](Longan.Shader.md#getattriblocation)
+- [getUniform](Longan.Shader.md#getuniform)
+- [getUniformLocation](Longan.Shader.md#getuniformlocation)
+- [initComponent](Longan.Shader.md#initcomponent)
+- [renderVao](Longan.Shader.md#rendervao)
+- [setFloat](Longan.Shader.md#setfloat)
+- [setFloat2v](Longan.Shader.md#setfloat2v)
+- [setFloat3v](Longan.Shader.md#setfloat3v)
+- [setFloat4v](Longan.Shader.md#setfloat4v)
+- [setFloatv](Longan.Shader.md#setfloatv)
+- [setInt](Longan.Shader.md#setint)
+- [setMat4](Longan.Shader.md#setmat4)
+
+## Constructors
+
+### constructor
+
+• **new Shader**()
+
+#### Overrides
+
+[PropertyComponent](Longan.PropertyComponent.md).[constructor](Longan.PropertyComponent.md#constructor)
+
+## Properties
+
+### \_fragment
+
+• **\_fragment**: `string` = `null`
+
+___
+
+### \_gl
+
+• **\_gl**: `WebGL2RenderingContext` = `null`
+
+___
+
+### \_image
+
+• **\_image**: `string` = `"../../images/shader.svg"`
+
+#### Overrides
+
+[PropertyComponent](Longan.PropertyComponent.md).[_image](Longan.PropertyComponent.md#_image)
+
+___
+
+### \_name
+
+• **\_name**: `string` = `"着色器"`
+
+#### Overrides
+
+[PropertyComponent](Longan.PropertyComponent.md).[_name](Longan.PropertyComponent.md#_name)
+
+___
+
+### \_owner
+
+• **\_owner**: [`RenderObject`](Longan.RenderObject.md) = `null`
+
+#### Inherited from
+
+[PropertyComponent](Longan.PropertyComponent.md).[_owner](Longan.PropertyComponent.md#_owner)
+
+___
+
+### \_program
+
+• **\_program**: `WebGLProgram` = `null`
+
+___
+
+### \_segment
+
+• **\_segment**: [`Segment`](Longan.Segment.md) = `null`
+
+#### Inherited from
+
+[PropertyComponent](Longan.PropertyComponent.md).[_segment](Longan.PropertyComponent.md#_segment)
+
+___
+
+### \_vertex
+
+• **\_vertex**: `string` = `null`
+
+___
+
+### isLog
+
+• **isLog**: `boolean` = `false`
+
+___
+
+### typeName
+
+• **typeName**: `string` = `"Shader"`
+
+#### Overrides
+
+[PropertyComponent](Longan.PropertyComponent.md).[typeName](Longan.PropertyComponent.md#typename)
+
+## Accessors
+
+### fragment
+
+• `get` **fragment**(): `string`
+
+#### Returns
+
+`string`
+
+___
+
+### gl
+
+• `get` **gl**(): `WebGLRenderingContext`
+
+#### Returns
+
+`WebGLRenderingContext`
+
+___
+
+### image
+
+• `get` **image**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+PropertyComponent.image
+
+• `set` **image**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+PropertyComponent.image
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+PropertyComponent.name
+
+• `set` **name**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+PropertyComponent.name
+
+___
+
+### owner
+
+• `get` **owner**(): [`RenderObject`](Longan.RenderObject.md)
+
+#### Returns
+
+[`RenderObject`](Longan.RenderObject.md)
+
+#### Inherited from
+
+PropertyComponent.owner
+
+___
+
+### program
+
+• `get` **program**(): `WebGLProgram`
+
+#### Returns
+
+`WebGLProgram`
+
+___
+
+### vertex
+
+• `get` **vertex**(): `string`
+
+#### Returns
+
+`string`
+
+## Methods
+
+### createBuffer
+
+▸ **createBuffer**(`attrName`, `data`, `attrSize`): `WebGLBuffer`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `attrName` | `string` |
+| `data` | `BufferSource` |
+| `attrSize` | `number` |
+
+#### Returns
+
+`WebGLBuffer`
+
+___
+
+### createIndexBuffer
+
+▸ **createIndexBuffer**(`indices`): `WebGLBuffer`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `indices` | `BufferSource` |
+
+#### Returns
+
+`WebGLBuffer`
+
+___
+
+### createVertexArray
+
+▸ **createVertexArray**(`vaoInfo`): `vertexArrayObjectInfo`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `vaoInfo` | `any` |
+
+#### Returns
+
+`vertexArrayObjectInfo`
+
+___
+
+### finaComponent
+
+▸ **finaComponent**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[PropertyComponent](Longan.PropertyComponent.md).[finaComponent](Longan.PropertyComponent.md#finacomponent)
+
+___
+
+### getAttribLocation
+
+▸ **getAttribLocation**(`name`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`number`
+
+___
+
+### getUniform
+
+▸ **getUniform**(`name`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+___
+
+### getUniformLocation
+
+▸ **getUniformLocation**(`name`): `WebGLUniformLocation`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`WebGLUniformLocation`
+
+___
+
+### initComponent
+
+▸ **initComponent**(): `void`
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[PropertyComponent](Longan.PropertyComponent.md).[initComponent](Longan.PropertyComponent.md#initcomponent)
+
+___
+
+### renderVao
+
+▸ **renderVao**(`vaoInfo`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `vaoInfo` | `vertexArrayObjectInfo` |
+
+#### Returns
+
+`void`
+
+___
+
+### setFloat
+
+▸ **setFloat**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### setFloat2v
+
+▸ **setFloat2v**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `Float32Array` |
+
+#### Returns
+
+`void`
+
+___
+
+### setFloat3v
+
+▸ **setFloat3v**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `Float32Array` |
+
+#### Returns
+
+`void`
+
+___
+
+### setFloat4v
+
+▸ **setFloat4v**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `Float32Array` |
+
+#### Returns
+
+`void`
+
+___
+
+### setFloatv
+
+▸ **setFloatv**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `Float32Array` |
+
+#### Returns
+
+`void`
+
+___
+
+### setInt
+
+▸ **setInt**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### setMat4
+
+▸ **setMat4**(`name`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `Float32Array` |
+
+#### Returns
+
+`void`