类 CommandBuffer

En

The CommandBuffer Class used to create command buffer

Zh

CommandBuffer 类用于创建命令缓冲区。

属性

`静态`instance

instance: CommandBuffer

访问器

casterShadow

get casterShadow(): boolean
返回 boolean
En
Whether the command buffer casts shadows.

Zh
命令缓冲区是否投射阴影。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:69

context

get context(): RenderContext3D
返回 RenderContext3D
En
The rendering context for the command buffer.

Zh
命令缓冲区的渲染上下文。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:77
set context(value: RenderContext3D): void
参数
- value: RenderContext3D
返回 void
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:81

name

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

Zh
命令缓冲区的名称。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:61

方法

_apply

_apply(render?: boolean): void
参数
- render: boolean = false
返回 void
En
Executes all rendering commands.

Zh
调用所有渲染指令。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:90

_applyOne

_applyOne(): boolean
返回 boolean
En
Executes a single command from the command buffer.

Zh
从命令缓冲区执行单个命令。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:105

addCustomCMD

addCustomCMD(command: Command): void
参数
- command: Command
  The custom command to add.
返回 void
En
Adds a custom render command.

Zh
添加一个自定义的渲染命令。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:553

blitScreenQuad

blitScreenQuad(
    source: BaseTexture,
    dest: RenderTexture,
    offsetScale?: Vector4,
    shader?: Shader3D,
    shaderData?: ShaderData,
    subShader?: number,
): void
参数
- source: BaseTexture
  The source texture. If null, the previous render result is used as the original texture.
- dest: RenderTexture
  The destination texture. If null, it renders directly to the final canvas.
- offsetScale: Vector4 = null
  Offset scaling
- shader: Shader3D = null
  The shader. If null, the internal copy shader is used without any processing.
- shaderData: ShaderData = null
  The shader data. If null, only the sourceTexture is accepted.
- subShader: number = 0
  The subShader index, defaults to 0.
返回 void
En
Adds a fullscreen quad rendering command to the command buffer.

Zh
向命令缓冲区添加一条通过全屏四边形渲染命令。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:398

blitScreenQuadByMaterial

blitScreenQuadByMaterial(
    source: BaseTexture,
    dest: RenderTexture,
    offsetScale?: Vector4,
    material?: Material,
    subShader?: number,
): void
参数
- source: BaseTexture
  The source texture. If null, the previous render result is used as the original texture.
- dest: RenderTexture
  The destination texture. If null, it renders directly to the final canvas.
- offsetScale: Vector4 = null
  Offset scaling.
- material: Material = null
  The material.
- subShader: number = 0
  The shader index.
返回 void
En
Add a command to render the source texture to the target texture through a full screen quadrilateral.

Zh
添加一条通过全屏四边形将源纹理渲染到目标渲染纹理指令。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:418

blitScreenTriangle

blitScreenTriangle(
    source: BaseTexture,
    dest: RenderTexture,
    offsetScale?: Vector4,
    shader?: Shader3D,
    shaderData?: ShaderData,
    subShader?: number,
): void
参数
- source: BaseTexture
  The source texture.
- dest: RenderTexture
  The destination texture.
- offsetScale: Vector4 = null
  Offset scaling.
- shader: Shader3D = null
  The shader. If null, the internal copy shader is used without any processing.
- shaderData: ShaderData = null
  The shader data. If null, only the sourceTexture is accepted.
- subShader: number = 0
  The subShader index, defaults to 0.
返回 void
En
Add a command to render the source texture to the target texture through full screen triangles.

Zh
添加一条通过全屏三角形将源纹理渲染到目标渲染纹理指令。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:446

drawMesh

drawMesh(
    mesh: Mesh,
    matrix: Matrix4x4,
    material: Material,
    submeshIndex: number,
    subShaderIndex: number,
): void
参数
- mesh: Mesh
  The original mesh information.
- matrix: Matrix4x4
  The world matrix of the mesh.
- material: Material
  The material applied to the mesh.
- submeshIndex: number
  The index of the submesh.
- subShaderIndex: number
  The index of the sub-shader, generally 0.
返回 void
En
Renders a Mesh.

Zh
渲染一个网格。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:486

drawMeshInstance

drawMeshInstance(
    mesh: Mesh,
    subMeshIndex?: number,
    matrixs: Matrix4x4[],
    material: Material,
    subShaderIndex?: number,
    instanceProperty: MaterialInstancePropertyBlock,
    drawnums: number,
): any
参数
- mesh: Mesh
  The original mesh information.
- subMeshIndex: number = 0
  The index of the mesh.
- matrixs: Matrix4x4[]
  An array of world matrices for rendering, describing the position of each Mesh to be rendered. If null, no world matrix buffer will be created or updated.
- material: Material
  The material used for rendering.
- subShaderIndex: number = 0
  The shader index of the rendering material.
- instanceProperty: MaterialInstancePropertyBlock
  Custom properties for the instance.
- drawnums: number
  The number of instances to render.
返回 any
En
Renders a Mesh using instanced rendering for dynamic batching.

Zh
使用实例化渲染动态合批方式渲染网格。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:538

drawRender

drawRender(render: BaseRender, material: Material, subMeshIndex?: number): void
参数
- render: BaseRender
  The renderer object to be rendered.
- material: Material
  The material applied to the renderer.
- subMeshIndex: number = 0
  The index of the sub-shader, defaults to 0.
返回 void
En
Renders a Render object.

Zh
渲染一个渲染对象。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:502

drawRenderElement

drawRenderElement(renderElement: RenderElement): void
参数
- renderElement: RenderElement
  The RenderElement to be rendered.
返回 void
En
Renders a RenderElement.

Zh
渲染一个渲染元素。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:514

getCommandsSize

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

Zh
获取命令缓冲区包含的命令数量
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:120

setGlobalColor

setGlobalColor(nameID: number, source: Color): void
参数
- nameID: number
  The ID of the data.
- source: Color
  The color data to be set.
返回 void
En
Sets the global color.

Zh
设置全局颜色。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:179

setGlobalInt

setGlobalInt(nameID: number, source: number): void
参数
- nameID: number
  The ID of the data.
- source: number
  The data to be set.
返回 void
En
Sets the global integer property.

Zh
设置全局的整型属性。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:330

setGlobalMatrix

setGlobalMatrix(nameID: number, source: number): void
参数
- nameID: number
  The ID of the data.
- source: number
  The Matrix data to be set.
返回 void
En
Sets the global Matrix property.

Zh
设置全局的矩阵属性。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:376

setGlobalNumber

setGlobalNumber(nameID: number, source: number): void
参数
- nameID: number
  The ID of the data.
- source: number
  The Number data to be set.
返回 void
En
Sets the global Number property.

Zh
设置全局 Number 属性。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:299

setGlobalTexture

setGlobalTexture(nameID: number, source: BaseTexture): void
参数
- nameID: number
  The Uniform ID for the texture.
- source: BaseTexture
  The source of the texture.
返回 void
En
Sets the global texture data.

Zh
设置全局纹理数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:149

setGlobalVector

setGlobalVector(nameID: number, source: Vector4): void
参数
- nameID: number
  The ID of the data.
- source: Vector4
  The Vector4 data to be set.
返回 void
En
Sets the global Vector4 data.

Zh
设置全局 Vector4 数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:209

setGlobalVector2

setGlobalVector2(nameID: number, source: Vector2): void
参数
- nameID: number
  The ID of the data.
- source: Vector2
  The Vector2 data to be set.
返回 void
En
Sets the global Vector2 data.

Zh
设置全局 Vector2 数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:269

setGlobalVector3

setGlobalVector3(nameID: number, source: Vector3): void
参数
- nameID: number
  The ID of the data.
- source: Vector3
  The Vector3 data to be set.
返回 void
En
Sets the global Vector3 data.

Zh
设置全局 Vector3 数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:239

setRenderTarget

setRenderTarget(
    renderTexture: RenderTexture,
    clearColor: boolean,
    clearDepth: boolean,
    backgroundColor?: Color,
    depth?: number,
): void
参数
- renderTexture: RenderTexture
  The render target texture.
- clearColor: boolean
  Whether to clear the color buffer.
- clearDepth: boolean
  Whether to clear the depth buffer.
- backgroundColor: Color = Color.BLACK
  The background color when clearing. Defaults to black.
- depth: number = 1
  The depth value when clearing. Defaults to 1.
返回 void
En
Sets the render target for the command buffer.

Zh
设置命令缓冲区的渲染目标。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:466

setShaderDataColor

setShaderDataColor(shaderData: ShaderData, nameID: number, value: Color): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: Color
  The color value.
返回 void
En
Sets the color data for a shader.

Zh
设置着色器的颜色数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:165

setShaderDataInt

setShaderDataInt(shaderData: ShaderData, nameID: number, value: number): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: number
  The Int data to be set.
返回 void
En
Sets the Int property for a shader.

Zh
设置着色器的 Int 属性。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:316

setShaderDataMatrix

setShaderDataMatrix(
    shaderData: ShaderData,
    nameID: number,
    value: Matrix4x4,
): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: Matrix4x4
  The Matrix data to be set.
返回 void
En
Sets the Matrix property for a shader.

Zh
设置着色器的矩阵属性。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:346

setShaderDataNumber

setShaderDataNumber(shaderData: ShaderData, nameID: number, value: number): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: number
  The Number data to be set.
返回 void
En
Sets the Number property for a shader.

Zh
设置着色器的 Number 属性。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:285

setShaderDataTexture

setShaderDataTexture(
    shaderData: ShaderData,
    nameID: number,
    source: BaseTexture,
): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The Uniform ID for the texture.
- source: BaseTexture
  The source of the texture.
返回 void
En
Sets the texture data for a shader.

Zh
设置着色器的纹理数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:134

setShaderDataVector

setShaderDataVector(
    shaderData: ShaderData,
    nameID: number,
    value: Vector4,
): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: Vector4
  The Vector4 data to be set.
返回 void
En
Sets the Vector4 data for a shader.

Zh
设置着色器的 Vector4 数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:195

setShaderDataVector2

setShaderDataVector2(
    shaderData: ShaderData,
    nameID: number,
    value: Vector2,
): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: Vector2
  The Vector2 data to be set.
返回 void
En
Sets the Vector2 data for a shader.

Zh
设置着色器的 Vector2 数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:255

setShaderDataVector3

setShaderDataVector3(
    shaderData: ShaderData,
    nameID: number,
    value: Vector3,
): void
参数
- shaderData: ShaderData
  The collection of shader data.
- nameID: number
  The ID of the data.
- value: Vector3
  The Vector3 data to be set.
返回 void
En
Sets the Vector3 data for a shader.

Zh
设置着色器的 Vector3 数据。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:225

setShaderDefine

setShaderDefine(
    shaderData: ShaderData,
    define: ShaderDefine,
    value: boolean,
): void
参数
- shaderData: ShaderData
  The collection of shader data.
- define: ShaderDefine
  The shader define to be set.
- value: boolean
  A boolean value indicating whether to add (true) or remove (false) the define.
返回 void
En
Sets a shader define.

Zh
设置着色器的定义。
- 定义于 src/layaAir/laya/d3/core/render/command/CommandBuffer.ts:362

类 CommandBuffer

En

Zh

索引

属性

访问器

方法

属性

静态instance

访问器

casterShadow

返回 boolean

En

Zh

context

返回 RenderContext3D

En

Zh

参数

返回 void

name

返回 string

En

Zh

方法

_apply

参数

返回 void

En

Zh

_applyOne

返回 boolean

En

Zh

addCustomCMD

参数

返回 void

En

Zh

blitScreenQuad

参数

返回 void

En

Zh

blitScreenQuadByMaterial

参数

返回 void

En

Zh

blitScreenTriangle

参数

返回 void

En

Zh

drawMesh

参数

返回 void

En

Zh

drawMeshInstance

参数

返回 any

En

Zh

drawRender

参数

返回 void

En

Zh

drawRenderElement

参数

返回 void

En

Zh

getCommandsSize

返回 number

En

Zh

setGlobalColor

参数

`静态`instance