简体中文

下载 App

探索
探索
了解鸿蒙应用和多设备开发，学习如何构建应用/元服务
应用形态
HarmonyOS 应用
One as All，All as One
元服务
秒开直达服务随行无处不在
游戏
为游戏创意玩法带来无限可能
多设备应用开发
穿戴
折叠屏手机
鸿蒙电脑
开发者学堂
视频课程
Codelabs
设计
设计
了解鸿蒙应用和多设备开发，学习如何构建应用/元服务
开发
开发
获取官方开发工具和文档等资源，将创意转化为鸿蒙应用
开发工具
DevEco Studio
应用开发 IDE, AI Agent 和 CLI
小艺开放平台
Skill 和智能体开发平台
ArkTS
ArKUI
AppGallery Connect
DevEco Testing
开发资源
工具下载
示例代码
开发文档
最佳实践
分发
分发
通过华为应用市场发布你的应用，多渠道触达用户
应用分发
应用市场
纯净安全的全场景应用分发平台
游戏中心
应用审核政策
服务分发
小艺
HarmonyOS 的超级 AI 入口
智慧助手·今天
服务分发文档
内容分发
主题服务
内容分发文档
推广与变现
推广与变现
一站式流量增长与营销变现平台
推广
应用推广引擎
全链路应用推广与增长服务平台
鲸鸿动能广告
为企业广告主提供广告营销服务
联运服务
推广文档
变现
鲸鸿动能流量变现
使能应用展示广告，实现流量变现
应用内支付
变现文档
生态合作
生态合作
携手伙伴共建共享鸿蒙智能终端生态
伙伴 SDK
一站式获取安全可靠的鸿蒙伙伴 SDK
生态服务
鸿蒙应用开发、培训和人力服务
服务商伙伴中心
华为终端云服务商伙伴的统一门户
伙伴入驻指南
生态市场介绍，卖家和买家服务指引
廉洁政策
合作伙伴诚信廉洁政策
支持
支持
获取客服帮助、技术支持、活动资讯等信息
智能客服
24小时 AI 在线自助服务，即问即答
社区问答
在官方论坛提问，与开发者互动交流
在线提单
提交工单，获得技术支持
开发者活动
HDD 等线下活动速览及报名入口
资讯
帮助指南

输入关键字搜索

开发者能力认证

鸿蒙高校创新赛

HarmonyOS 7

animation

HarmonyOS行业解决方案

layoutWeight

HarmonyOS模板&组件

bindPopup

bindsheet

CTRL+K

文档管理中心

我的

Hello，

欢迎来到开发者联盟

CommandBuffer

更新时间: 2022-10-27 06:33

展开

Class Info
class CommandBuffer 命令缓冲类，用于命令缓存区的有关操作。

Class Info

class CommandBuffer

命令缓冲类，用于命令缓存区的有关操作。

Public Constructor Summary

展开

Constructor Name
CommandBuffer() 构造函数。

Constructor Name

CommandBuffer()

构造函数。

Public Destructor Summary

展开

Destructor Name
virtual ~CommandBuffer() 析构函数。

Destructor Name

virtual ~CommandBuffer()

析构函数。

Public Method Summary

展开

Qualifier and Type	Method Name and Description
virtual void	SetPipelineBarrier(const BufferMemoryBarrier* bufferMemoryBarrier) = 0 根据BufferMemoryBarrier信息创建管线屏障。
virtual void	SetPipelineBarrier(const TextureMemoryBarrier* textureMemoryBarrier, const Texture* texture) = 0 根据TextureMemoryBarrier信息为Texture创建管线屏障。
virtual void	BeginRenderPass(const ClearValue& clearValue, const Viewport& viewPort, const RenderPass* renderPass, const FrameBuffer* frameBuffer, SubpassContents subpassContents) = 0 渲染通道相关流程开始执行。
virtual void	EndRenderPass() = 0 渲染通道流程执行结束。
virtual bool	BeginCommand(const RenderPass* renderPass = nullptr, const FrameBuffer* frameBuffer = nullptr) = 0 开始执行渲染指令。
virtual void	EndCommand() = 0 渲染指令执行结束。
virtual void	BindViewport(const Viewport& viewport) = 0 视口绑定。
virtual void	BindScissorRect(s32 x, s32 y, u32 width, u32 height) = 0 绑定裁剪矩形。
virtual void	SetVertexBuffer(const std::vector<DynamicBuffer*>& vertexBuffers) = 0 设置顶点缓冲。
virtual void	SetIndexBuffer(const Buffer* indexBuffer, u32 stride) = 0 设置索引缓冲。
virtual void	SetPipeline(const Pipeline* pipeline) = 0 设置渲染管线。
virtual void	BindDescriptorSets(const std::map<u32, DescriptorSet*>& descriptorSets) = 0 绑定描述符。
virtual void	PushConstant(Pipeline* pipeline, ShaderStageType type, const void* values, u32 offset, u32 size) = 0 推式常量操作，给定参数进行设置。
virtual void	Draw(u32 vertexCount) = 0 绘制接口。
virtual void	DrawIndexed(u32 indexCount, u32 indexOffset, u32 vertexOffset) = 0 根据索引缓冲绘制
virtual void	ExecuteCommand(CommandBuffer* secondaryCommandBuffer) = 0 执行指令接口。
virtual void	Reset() = 0 重置缓冲。
virtual void	NextSubpass() = 0 执行下一步渲染流程。
virtual void	SetLineWidth(f32 width) = 0 设置线宽。
virtual u8*	CopyTextureToBuffer(const void* imageView, u8* buffer, u32 width, u32 height) = 0 将纹理拷贝到缓冲。
virtual void	SetStencilTestEnable(bool bEnable) = 0 模板测试使能接口。
virtual void	SetStencilCompareMask(StencilFaceFlag stencilFaceFlag, u32 mask) = 0 设置模板测试的对比掩码。
virtual void	SetStencilReference(StencilFaceFlag stencilFaceFlag, u32 ref) = 0 设置模板测试的引用。
virtual void	SetStencilWriteMask(StencilFaceFlag stencilFaceFlag, u32 mask) = 0 设置模板测试的写掩码。
virtual void	SetBlendConstants(const std::vector<f32>& blendConstants) = 0 设置混合常数数值。
bool	Create(const CommandBufferCreateInfo& commandBufferCreateInfo) 根据CommandBufferCreateInfo信息创建命令缓冲。
const CommandBufferCreateInfo&	GetCommandBufferCreateInfo() const 获取命令缓冲的创建信息。
bool	isRecorded() const 是否已记录。
void	SetRecordedStatus(bool status) 设置记录状态。

Public Constructors

CommandBuffer

展开

Constructor
CommandBuffer(const GraphicsRenderer* graphicsRenderer); 构造函数。

Constructor

CommandBuffer(const GraphicsRenderer* graphicsRenderer);

构造函数。

Parameters

展开

Name	Description
graphicsRenderer	图形渲染器。

Public Destructors

~CommandBuffer

展开

Destructor
virtual ~CommandBuffer() 析构函数。

Destructor

virtual ~CommandBuffer()

析构函数。

Public Methods

SetPipelineBarrier(const BufferMemoryBarrier* bufferMemoryBarrier)

展开

Method
virtual void SetPipelineBarrier(const BufferMemoryBarrier* bufferMemoryBarrier) = 0 根据BufferMemoryBarrier信息创建管线屏障。

Method

virtual void SetPipelineBarrier(const BufferMemoryBarrier* bufferMemoryBarrier) = 0

根据BufferMemoryBarrier信息创建管线屏障。

Parameters

展开

Name	Description
bufferMemoryBarrier	BufferMemoryBarrier信息。

SetPipelineBarrier(const TextureMemoryBarrier* textureMemoryBarrier, const Texture* texture)

展开

Method
virtual void SetPipelineBarrier(const TextureMemoryBarrier* textureMemoryBarrier, const Texture* texture) = 0 根据TextureMemoryBarrier信息为Texture创建管线屏障。

Method

virtual void SetPipelineBarrier(const TextureMemoryBarrier* textureMemoryBarrier, const Texture* texture) = 0

根据TextureMemoryBarrier信息为Texture创建管线屏障。

Parameters

展开

Name	Description
textureMemoryBarrier	TextureMemoryBarrier信息。
texture	Texture信息。

BeginRenderPass

展开

Method
virtual void BeginRenderPass(const ClearValue& clearValue, const Viewport& viewPort, const RenderPass* renderPass, const FrameBuffer* frameBuffer,SubpassContents subpassContents) = 0 渲染通道相关流程开始执行。

Method

virtual void BeginRenderPass(const ClearValue& clearValue, const Viewport& viewPort, const RenderPass* renderPass, const FrameBuffer* frameBuffer,SubpassContents subpassContents) = 0

渲染通道相关流程开始执行。

Parameters

展开

Name	Description
clearValue	ClearValue信息。
viewPort	Viewport信息。
renderPass	RenderPass信息。
frameBuffer	FrameBuffer信息。
subpassContents	子通道内容信息。

EndRenderPass

展开

Method
virtual void EndRenderPass() = 0 渲染通道流程执行结束。

Method

virtual void EndRenderPass() = 0

渲染通道流程执行结束。

BeginCommand

展开

Method
virtual bool BeginCommand(const RenderPass* renderPass = nullptr, const FrameBuffer* frameBuffer = nullptr) = 0 开始执行渲染指令。

Method

virtual bool BeginCommand(const RenderPass* renderPass = nullptr, const FrameBuffer* frameBuffer = nullptr) = 0

开始执行渲染指令。

Parameters

展开

Name	Description
renderPass	RenderPass信息。
frameBuffer	FrameBuffer信息。

Returns

展开

Type	Description
bool	开始命令缓冲操作，成功则返回true，否则为false。

EndCommand

展开

Method
virtual void EndCommand() = 0 渲染指令执行结束。

Method

virtual void EndCommand() = 0

渲染指令执行结束。

BindViewport

展开

Method
virtual void BindViewport(const Viewport& viewport) = 0 视口绑定。

Method

virtual void BindViewport(const Viewport& viewport) = 0

视口绑定。

Parameters

展开

Name	Description
viewport	Viewport信息。

BindScissorRect

展开

Method
virtual void BindScissorRect(s32 x, s32 y, u32 width, u32 height) = 0 绑定裁剪矩形。

Method

virtual void BindScissorRect(s32 x, s32 y, u32 width, u32 height) = 0

绑定裁剪矩形。

Parameters

展开

Name	Description
x	x坐标。
y	y坐标。
width	矩阵的宽。
height	矩阵的高。

SetVertexBuffer

展开

Method
virtual void SetVertexBuffer(const std::vector<DynamicBuffer*>& vertexBuffers) = 0 设置顶点缓冲。

Method

virtual void SetVertexBuffer(const std::vector<DynamicBuffer*>& vertexBuffers) = 0

设置顶点缓冲。

Parameters

展开

Name	Description
vertexBuffers	顶点缓冲信息。

SetIndexBuffer

展开

Method
virtual void SetIndexBuffer(const Buffer* indexBuffer, u32 stride) = 0 设置索引缓冲。

Method

virtual void SetIndexBuffer(const Buffer* indexBuffer, u32 stride) = 0

设置索引缓冲。

Parameters

展开

Name	Description
indexBuffer	缓冲信息。
stride	对应的步长。

SetPipeline

展开

Method
virtual void SetPipeline(const Pipeline* pipeline) = 0 设置渲染管线。

Method

virtual void SetPipeline(const Pipeline* pipeline) = 0

设置渲染管线。

Parameters

展开

Name	Description
pipeline	渲染管线信息。

BindDescriptorSets

展开

Method
virtual void BindDescriptorSets(const std::map<u32, DescriptorSet*>& descriptorSets) = 0 绑定描述符。

Method

virtual void BindDescriptorSets(const std::map<u32, DescriptorSet*>& descriptorSets) = 0

绑定描述符。

Parameters

展开

Name	Description
descriptorSets	需要绑定的DescriptorSet列表。

PushConstant

展开

Method
virtual void PushConstant(Pipeline* pipeline, ShaderStageType type, const void* values, u32 offset, u32 size) = 0 推式常量操作，给定参数进行设置。

Method

virtual void PushConstant(Pipeline* pipeline, ShaderStageType type, const void* values, u32 offset, u32 size) = 0

推式常量操作，给定参数进行设置。

Parameters

展开

Name	Description
pipeline	渲染管线。
type	shader阶段，如顶点阶段或者片元阶段等。
values	具体常量内容。
offset	偏移量。
size	常量内容大小。

Draw

展开

Method
virtual void Draw( u32 vertexCount) = 0 绘制接口。

Method

virtual void Draw( u32 vertexCount) = 0

绘制接口。

Parameters

展开

Name	Description
vertexCount	顶点个数。

DrawIndexed

展开

Method
virtual void DrawIndexed( u32 indexCount, u32 indexOffset, u32 vertexOffset) = 0 按索引绘制。

Method

virtual void DrawIndexed( u32 indexCount, u32 indexOffset, u32 vertexOffset) = 0

按索引绘制。

Parameters

展开

Name	Description
indexCount	索引个数。
indexOffset	索引偏移量。
vertexOffset	顶点偏移量。

ExecuteCommand

展开

Method
virtual void ExecuteCommand(CommandBuffer* secondaryCommandBuffer) = 0 执行指令接口。

Method

virtual void ExecuteCommand(CommandBuffer* secondaryCommandBuffer) = 0

执行指令接口。

Parameters

展开

Name	Description
secondaryCommandBuffer	要被执行的指令。

Reset

展开

Method
virtual void Reset() = 0 重置缓冲。

Method

virtual void Reset() = 0

重置缓冲。

NextSubpass

展开

Method
virtual void NextSubpass() = 0 执行下一步渲染流程。

Method

virtual void NextSubpass() = 0

执行下一步渲染流程。

SetLineWidth

展开

Method
virtual void SetLineWidth(f32 width) = 0 设置线宽。

Method

virtual void SetLineWidth(f32 width) = 0

设置线宽。

Parameters

展开

Name	Description
width	线的宽度。

CopyTextureToBuffer

展开

Method
virtual u8* CopyTextureToBuffer(const void* imageView, u8* buffer, u32 width, u32 height) = 0 将纹理拷贝到缓冲。

Method

virtual u8* CopyTextureToBuffer(const void* imageView, u8* buffer, u32 width, u32 height) = 0

将纹理拷贝到缓冲。

Parameters

展开

Name	Description
imageView	图像视图。
buffer	图像缓冲。
width	图像的宽度
height	图像的高度

Returns

展开

Type	Description
u8*	图像缓冲地址。

SetStencilTestEnable

展开

Method
virtual void SetStencilTestEnable(bool bEnable) = 0 模板测试使能接口。

Method

virtual void SetStencilTestEnable(bool bEnable) = 0

模板测试使能接口。

Parameters

展开

Name	Description
bEnable	true：开启模板测试。 false：关闭模板测试

SetStencilCompareMask

展开

Method
virtual void SetStencilCompareMask(StencilFaceFlag stencilFaceFlag, u32 mask) = 0 设置模板测试的对比掩码。

Method

virtual void SetStencilCompareMask(StencilFaceFlag stencilFaceFlag, u32 mask) = 0

设置模板测试的对比掩码。

Parameters

展开

Name	Description
stencilFaceFlag	模板比较作用范围，正面或背面或者双面。
mask	模板比较新设置的掩码值。

SetStencilReference

展开

Method
virtual void SetStencilReference(StencilFaceFlag stencilFaceFlag, u32 ref) = 0 设置模板测试的引用。

Method

virtual void SetStencilReference(StencilFaceFlag stencilFaceFlag, u32 ref) = 0

设置模板测试的引用。

Parameters

展开

Name	Description
stencilFaceFlag	模板比较作用范围，正面或背面或者双面。
ref	模板引用新设置的值。

SetStencilWriteMask

展开

Method

virtual void SetStencilWriteMask(StencilFaceFlag stencilFaceFlag, u32 mask) = 0

设置模板测试的写掩码。

Parameters

展开

Name	Description
stencilFaceFlag	模板比较作用范围，正面或背面或者双面。
mask	模板写入新设置的掩码值。

SetBlendConstants

展开

Method

virtual void SetBlendConstants(const std::vector<f32>& blendConstants) = 0

设置混合常数数值。

Parameters

展开

Name	Description
blendConstants	混合常数数值。

Create

展开

Method

bool Create(const CommandBufferCreateInfo& commandBufferCreateInfo)

创建命令缓冲。

Parameters

展开

Name	Description
commandBufferCreateInfo	命令缓冲创建信息。

Returns

展开

Type	Description
bool	创建命令缓冲是否成功。true，成功；false，失败。

GetCommandBufferCreateInfo

展开

Method

const CommandBufferCreateInfo& GetCommandBufferCreateInfo() const

获取命令缓冲的创建信息。

Returns

展开

Type	Description
CommandBufferCreateInfo	命令缓冲创建信息。

isRecorded

展开

Method

bool isRecorded() const

是否已记录。

Returns

展开

Type	Description
bool	是否已记录。 true：已记录。 false：未记录。

SetRecordedStatus

展开

Method

void SetRecordedStatus(bool status)

设置记录状态。

Parameters

展开

Name	Description
status	记录的状态。

Color

CameraFrameGraph

意见反馈

以上内容对您是否有帮助？

意见反馈

如果您有其他疑问，您也可以通过开发者社区问答频道来和我们联系探讨。

社区提问智能客服提问

在 API参考中进行搜索

只在 Class Summary 中搜索只搜索章节标题

请输入您想要搜索的关键词