类 CommandBuffer2D

En

Interface is used to collect 2D rendering instructions

Zh

接口用来收集2D渲染指令

索引

方法

addCacheCommand apply applyOne blitTextureBlur blitTextureQuad clear drawLine drawMesh drawQuad drawRenderElement getCommandsSize getName setGlobalShaderDataValue setRenderTarget setShaderDataValue setShaderDefine

方法

addCacheCommand

addCacheCommand(cmd: Command2D): void
添加缓存渲染指令
参数
- cmd: Command2D
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:278

apply

apply(render?: boolean, recoverContextStat?: boolean): void
参数
- render: boolean = true
  Whether to render immediately, the default is true
- recoverContextStat: boolean = true
返回 void
En
Executes all rendering commands.

Zh
调用所有渲染指令。
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:88

applyOne

applyOne(recoverContextStat?: boolean): boolean
参数
- recoverContextStat: boolean = true
返回 boolean
En
Executes a single command from the command buffer.

Zh
从命令缓冲区执行单个命令。
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:104

blitTextureBlur

blitTextureBlur(source: BaseTexture, dest: IRenderTarget, blurParams: any): void
参数
- source: BaseTexture
- dest: IRenderTarget
- blurParams: any
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:221

blitTextureQuad

blitTextureQuad(
    source: BaseTexture,
    dest: IRenderTarget,
    offsetScale?: Vector4,
    shader?: Shader3D,
    shaderData?: ShaderData,
): void
拷贝纹理到渲染目标渲染指令
参数
- source: BaseTexture
  copy source
- dest: IRenderTarget
  dest of render
- 可选offsetScale: Vector4
  offset&scale of copy
- 可选shader: Shader3D
  copy use shader
- 可选shaderData: ShaderData
  copy use data for shader
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:213

clear

clear(recover?: boolean): void
参数
- recover: boolean = true
返回 void
En
Clears the command buffer.

Zh
清除命令缓冲区
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:122

drawLine

drawLine(): void
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:270

drawMesh

drawMesh(
    mesh: Mesh2D,
    mat: Matrix,
    meshTexture?: BaseTexture,
    color?: Color,
    material?: Material,
): void
渲染Mesh2D指令
参数
- mesh: Mesh2D
- mat: Matrix
- 可选meshTexture: BaseTexture
- 可选color: Color
- 可选material: Material
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:259

drawQuad

drawQuad(): void
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:266

drawRenderElement

drawRenderElement(renderelement: IRenderElement2D, mat: Matrix): void
渲染元素位置指令
参数
- renderelement: IRenderElement2D
- mat: Matrix
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:244

getCommandsSize

getCommandsSize(): number
返回 number
En
Gets the number of commands contained in the command buffer

Zh
获取命令缓冲区包含的命令数量
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:134

getName

getName(): string
返回 string
En
The name of the command buffer.

Zh
命令缓冲区的名称。
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:58

setGlobalShaderDataValue

setGlobalShaderDataValue(
    nameID: number,
    dataType: ShaderDataType,
    value: any,
): void
参数
- nameID: number
  property id
- dataType: ShaderDataType
  proprty type
- value: any
  set value
返回 void
En
set global render data

Zh
设置全局渲染数据
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:174

setRenderTarget

setRenderTarget(
    renderTexture: IRenderTarget,
    clearColor: boolean,
    colorValue?: Color,
    invertY?: boolean,
): void
设置渲染目标指令
参数
- renderTexture: IRenderTarget
  dest render target
- clearColor: boolean
  clear color when change target
- colorValue: Color = Color.BLACK
  clear color value
- invertY: boolean = true
  invert y coordinate
返回 void
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:232

setShaderDataValue

setShaderDataValue(
    shaderData: ShaderData,
    nameID: number,
    dataType: ShaderDataType,
    value: any,
): void
Set rendering instructions for rendering data
参数
- shaderData: ShaderData
  dest render data
- nameID: number
  property id
- dataType: ShaderDataType
  proprty type
- value: any
  set value
返回 void
Zh
设置渲染数据渲染指令
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:152

setShaderDefine

setShaderDefine(
    shaderData: ShaderData,
    define: ShaderDefine,
    value: boolean,
): void
参数
- shaderData: ShaderData
  dest render data
- define: ShaderDefine
  marco of shader
- value: boolean
  set bool of marco
返回 void
En
set Shader Define marco cmd

Zh
设置渲染宏的指令
- 定义于 src/layaAir/laya/display/Scene2DSpecial/RenderCMD2D/CommandBuffer2D.ts:197

类 CommandBuffer2D

En

Zh

索引

方法

方法

addCacheCommand

参数

返回 void

apply

参数

返回 void

En

Zh

applyOne

参数

返回 boolean

En

Zh

blitTextureBlur

参数

返回 void

blitTextureQuad

参数

返回 void

clear

参数

返回 void

En

Zh

drawLine

返回 void

drawMesh

参数

返回 void

drawQuad

返回 void

drawRenderElement

参数

返回 void

getCommandsSize

返回 number

En

Zh

getName

返回 string

En

Zh

setGlobalShaderDataValue

参数

返回 void

En

Zh

setRenderTarget

参数

返回 void

setShaderDataValue

参数

返回 void

Zh

setShaderDefine

参数

返回 void

En

Zh

显示设置

目录