Cubism Core API参考

最終更新: 2022年7月7日

在此页面上发布的Cubism Core API参考的PDF中,

涵盖了Live2D Cubism Core在Live2D Cubism SDK for Native中的作用、用方法和API规格。

对象用户

  • Live2D Cubism SDK for Native用户
  • 正在考虑实装包装以便可以从其他语言(Java,Python等)调用Core的用户
  • 正在考虑嵌入到其他程序或平台(例如游戏引擎)中的人

Core和Framework的功能分类

下图展示了Application、Core、Framework之间的关系以及功能的作用。

Application和Framework都使用Core。

什么是Core?

Core是一个工具库,其中包含处理使用Cubism 3或更高版本Editor创建的模型(.moc3文件)所需的API。其特点如下所述。

  • API由C语言组成。
  • Core本身不分配或放弃内存记忆。由于Core请求了所需的内存记忆量,因此用户有必要确保指定量并将其传递给Core。
  • 不包括绘制功能。根据模型的参数计算顶点信息是Core的作用,用户端从Core获取计算出的顶点信息和绘制所需的信息(UV、不透明度等)

由于上述特性,它被设计成高度可移植、且不依赖平台。

日文版 PDF文件

下载:日文版 Cubism Core API参考(2.85 MB)

[最后更新时间:2022/07/07 r10]

更新历史记录

更新日期 版本号 类型 内容
2022/07/07 r10 追加 追加了获取参数类型的功能说明。
追加 追加了对获取图形网格的父部件的功能说明。
追加 更新了“moc3的文件版本”和“csmGetMocVersion”中可以获取的版本说明。
2022/05/19 r9 追加 追加了正片叠底色和屏幕色的相关说明。
追加获取参数中设置为键的信息的相关说明。
2021/02/26 r8 修正 追加了csmGetDrawableIndexCounts中Drawable数量为0的说明。
修正 追加了csmGetDrawableIndices中存在有效地址未存储的情况的说明。
2019/09/04 r7 修正 调整Cubism Core和Cubism SDK的符号
2019/08/01 r6 追加 追加moc3文件版本常量
因追加ConstantFlag元素而追加代码片段
追加关于反转蒙版标志的说明
追加反转蒙版功能的说明
向个别API追加了可用版本项目
修正 错字修正
2019/02/12 r5 追加 追加查找文件版本的方法 
追加 追加csmGetLatestMocVersion的API说明 
追加 追加csmGetMocVersion的API说明 
追加 追加带csmGetPartParentPartIndices的API的CoreVersion符号 
2018/12/20 r4 追加 追加“关于moc3文件版本”
追加 追加“获取部件的父部件”
追加 追加“csmGetPartParentPartIndices”的API说明
修正 修正错字和遗漏。修正措辞以避免歧义。
2018/07/11 r3 修正 修正错字和遗漏
修正 修正措辞以避免歧义
修正 详细修正蒙版绘制方法及其访问相关的绘制方法的指定。
修正 修正API列表中部分参数中有const的错误
2018/05/18 r2 修正 错字修正
后记 追加关于csmGetDrawableVertexPositions获取的信息的特征
2018/03/27 r1 创建 创建

English PDF File

Download:English Cubism Core API Reference(2.71MB)

[Last Update 2022/07/07 r10]

Change log

Update day Version Update Type Content
2022/07/07 r10 Added Added description of the function to get parameter types.
Added Added description of the function to get parent parts of ArtMeshes.
Added Updated obtained versions in “File version of moc3” and “csmGetMocVersion”.
2022/05/19 r9 Added Added explanations related to multiply colors and screen colors.
Added explanations related to obtaining information on keys set in parameters.
2021/03/01 r8 Fixed Added an explanation for the existence of Drawables with a count of 0 in csmGetDrawableIndexCounts.
Fixed Added explanation of the case where csmGetDrawableIndices does not store valid addresses.
2019/09/04 r7 Fixed Adjusted notation of “Cubism Core” and “Cubism SDK”
2019/08/01 r6 Added Added a constant stands for moc3 file version
Added a snippet since the ConstantFlag element has added
Added a description of the Inverted Mask flag
Added a description of the Inverted Mask function
Added an item stands for the available version of each API
Fixed Typo fixes
2019/02/26 r5 Added Added “File version of moc3” 
Added Added “Getting the parent parts of the parts” 
Added Added the API description of csmGetLatestMocVersion
Added Added the API description of csmGetMocVersion
Added Added the API description of csmGetPartParentPartIndices 
2018/07/20 r3 Corrected Corrected errors of snipet
Corrected Corrected vague expression
Corrected Corrected omissions of letter in snipet
Corrected Corrected vague expression
Corrected Corrected mistake that const is included in notation of arguments.
Corrected Added more detailed explanation about rendering method of mask and how to access it
2018/06/14 r2 translation translation to English from Japanese
关于本报道,敬请提出您的意见及要求。