Cubism Core API 레퍼런스

업데이트: 2022/07/07

이 페이지에 게시된 Cubism Core API 레퍼런스의 PDF에서는

Live2D Cubism SDK for Native에서의 Live2D Cubism Core의 역할, 사용법 및 API 사양을 다룹니다.

대상자

  • Live2D Cubism SDK for Native 사용자
  • 다른 언어(Java, Python 등)에서 Core를 호출할 수 있도록 Wrapper 구현을 검토 중인 사람
  • 게임 엔진 등 다른 프로그램이나 플랫폼에 도입하는 것을 검토하고 있는 사람

Core 및 Framework 기능 분류

아래 그림은 Application, Core, Framework의 관계와 기능의 역할을 보여줍니다.

Core는 Application과 Framework에서 사용됩니다.

Core란?

Core는 Cubism 3 이후의 에디터를 사용해 작성된 모델(.moc3 파일)을 취급하기 위해 필요한 API를 갖춘 라이브러리입니다. 특징에 대해 아래에 설명합니다.

  • API는 C언어로 구성.
  • Core 자신으로 메모리를 확보・파기하지 않습니다. 필요한 메모리 양을 Core로부터 요구받기 때문에, 이용하는 측에서 지정량을 확보해 Core에 전달할 필요가 있습니다.
  • 그리기 기능은 포함하지 않습니다. 모델의 파라미터에 따라 정점 정보를 계산하는 것이 Core의 역할이며, 이용하는 측은 계산이 끝난 정점 정보 및 그리기에 필요한 정보(UV나 불투명도 등)를 Core로부터 취득

상기의 특징으로부터, 이식성이 높고 플랫폼에 의존하지 않는 설계로 되어 있습니다.

일본어 버전 PDF 파일

다운로드: 일본어 버전 Cubism Core API 레퍼런스(2.85MB)

[마지막 갱신일 2022/07/07 r10]

업데이트 내역

갱신일 버전 수 유형 내용
2022/07/07 r10 추가 파라미터 유형을 취득하는 기능에 대한 설명을 추가했습니다.
추가 아트메쉬의 부모 파츠를 취득하는 기능에 대한 설명을 추가했습니다.
추가 「moc3의 파일 버전」 「csmGetMocVersion」에, 취득할 수 있는 버전에 대한 설명을 업데이트했습니다.
2022/05/19 r9 추가 곱하기 색·스크린색 관련 설명을 추가했습니다.
파라미터에 설정된 키 정보 취득에 관련한 설명을 추가했습니다.
2021/02/26 r8 수정 csmGetDrawableIndexCounts에서 개수 0의 Drawable이 존재하는 설명을 추가했습니다.
수정 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
이 기사에 관한 의견 및 요청사항을 보내 주시기 바랍니다.