Cubism 核心 API 参考

[最后更新 2022/07/07]

在此页面上发布的 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之间的关系以及功能的作用。

应用程序和框架都使用核心。

什么是核心?

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

・API由C语言组成。

・Core 本身不分配或丢弃内存。由于 Core 请求了所需的内存量,因此用户有必要确保指定的数量并将其传递给 Core。

・不包括绘图功能。根据模型的参数计算顶点信息是Core的作用,用户端从Core获取计算出的顶点信息和绘制所需的信息(UV、不透明度等),进行绘制增加。绘图功能不需要独立实现,因为Framework提供了参考实现。

由于上述特性,它被设计成高度可移植和平台无关的。

 

日文PDF文件

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

[最后更新 2022/07/07 r10]

 

更新历史记录

更新日期 版本号 种类 内容
2022/07/07 r10 追加 追加了获取参数类型的函数说明。
追加 追加了对获取图形网格的父部件的能力的描述。
追加 更新了“moc3的文件版本”和“csmGetMocVersion”中可以获取的版本说明。
2022/05/19 r9 追加 追加了正片叠底色和屏幕色的相关说明。
追加获取参数中设定为key的信息相关的说明。
2021/02/26 r8 使固定 在 csmGetDrawableIndexCounts 中增加了 Drawable 数量为 0 的说明。
使固定 增加了在csmGetDrawableIndices中存在有效地址未存储的情况的描述。
2019/09/04 r7 使固定 Cubism Core 和 Cubism SDK 的调整符号
2019/08/01 r6 追加 追加 moc3文件版本常量
由于追加了常量标志元素而追加了代码片段
追加了关于掩码反转标志的描述
增加了掩码反转功能说明
向各个 API 追加了可用版本项
使固定 排版更正
2019/02/12 r5 追加 追加了如何查找文件版本 
追加 为 csmGetLatestMocVersion 追加了 API 描述 
追加 为 csmGetMocVersion 追加了 API 描述 
追加 为 csmGetPartParentPartIndices 追加了带有 API 的核心版本符号 
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

© 2010 - 2022 Live2D Inc.