Cubism SDK

https://docs.live2d.com/cubism-sdk-manual/
Admin
Cubism SDK is a comprehensive development kit for integrating Live2D Cubism animated models into...
Tokens:375,416
Snippets:2,002
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Java Implementation Example for CubismPose.create

Source: https://docs.live2d.com/cubism-sdk-manual/pose

Implementation example in Java that loads the pose file path, creates a buffer, calls CubismPose.create, and deletes the buffer.

```Java
// Java
	String path = modelSetting.getPoseFileName();
	path = modelHomeDir + path;
	buffer = CreateBuffer(path);
	CubismPose pose = CubismPose.create(buffer);
```

--------------------------------

### C++ Implementation Example for CubismPose::Create

Source: https://docs.live2d.com/cubism-sdk-manual/pose

Implementation example in C++ that loads the pose file path, creates a buffer, calls CubismPose::Create, and deletes the buffer.

```C++
// C++
	csmString path = _modelSetting->GetPoseFileName();
    path = _modelHomeDir + path;

    buffer = CreateBuffer(path.GetRawString(), &size);
    CubismPose*　pose = CubismPose::Create(buffer, size);
    DeleteBuffer(buffer, path.GetRawString());
```

--------------------------------

### TypeScript Implementation Example for CubismPose.create

Source: https://docs.live2d.com/cubism-sdk-manual/pose

Implementation example in TypeScript that fetches the pose file, converts it to an ArrayBuffer, creates a CubismPose instance, and deletes the buffer.

```TypeScript
// TypeScritp
	let path: string = _modelSetting.getPoseFileName();
    path = _modelHomeDire + path;

    fetch(path).then(
        (response) => 
        {
            return response.arrayBuffer();
        }
    ).then(
        (arrayBuffer) =>
        {
            let buffer: ArrayBuffer = arrayBuffer;
            let size: number = buffer.byteLength;

            let pose: CubismPose = CubismPose.create(buffer, size);
            deleteBuffer(buffer, path);
        }
    );
```

--------------------------------

### CubismRaycaster.refresh() と start() の実装

Source: https://docs.live2d.com/cubism-sdk-manual/raycasting

CubismRaycasterの初期化時に、PrefabにアタッチされたすべてのCubismRaycastableの参照を取得する。実行中に当たり判定用のメッシュを追加/削除した際には、refresh()を呼んで参照を取得し直す。start()はCocos Creatorによって呼ばれ、キャッシュを初期化する。

```TypeScript
/** Refreshes the controller. Call this method after adding and/or removing {@link CubismRaycastable}. */
private refresh(): void {
  const candidates = ComponentExtensionMethods.findCubismModel(this)?.drawables ?? null;
  if (candidates == null) {
    console.error('CubismRaycaster.refresh(): candidates is null.');
    return;
  }

  // Find raycastable drawables.
  const raycastables = new Array<CubismRenderer>();
  const raycastablePrecisions = new Array<CubismRaycastablePrecision>();

  for (var i = 0; i < candidates.length; i++) {
    // Skip non-raycastables.
    if (candidates[i].getComponent(CubismRaycastable) == null) {
      continue;
    }
    const renderer = candidates[i].getComponent(CubismRenderer);
    console.assert(renderer);
    raycastables.push(renderer!);

    const raycastable = candidates[i].getComponent(CubismRaycastable);
    console.assert(raycastable);
    console.assert(raycastable!.precision);
    raycastablePrecisions.push(raycastable!.precision!);
  }

  // Cache raycastables.
  this.raycastables = raycastables;
  this.raycastablePrecisions = raycastablePrecisions;
}

/** Called by Cocos Creator. Makes sure cache is initialized. */
protected start(): void {
  // Initialize cache.
  this.refresh();
}
```

--------------------------------

### CubismFramework.startUp

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close-web

Framework の起動時にログオプションを設定します。この関数を呼び出さないと initialize 関数は動作しません。

```APIDOC
## CubismFramework.startUp

### Description
Framework の起動時にログオプションを設定します。この関数を呼び出さないと initialize 関数は動作しません。

### Method
startUp

### Parameters
- **cubismOption** (Option) - Required - ログ関数とログレベルを設定するオプションオブジェクト。
  - **logFunction** (Function) - Required - ログ出力用の関数。
  - **loggingLevel** (LogLevel) - Required - ログレベル。

### Request Example
```typescript
let cubismOption: Option;
// prepare for Cubism Framework API.
cubismOption.logFunction = LAppPal.printMessage;
cubismOption.loggingLevel = LogLevel.LogLevel_Info;
CubismFramework.startUp(cubismOption);
```

### Response
#### Success Response
初期化時にデバッグ用関数を介して Cubism Core for Web のバージョン情報が表示されます。

#### Response Example
```
[CSM][I]Live2D Cubism Core version: 03.00.0003 (50331651)
```
```

--------------------------------

### Register AnimationBeginHandler callback for animation start

Source: https://docs.live2d.com/cubism-sdk-manual/motion-unity

Registers a custom OnAnimationBegin method to the CubismMotionController.AnimationBeginHandler event to receive a callback when an animation starts. The example assumes the model is already imported and uses CubismFadeController's CubismFadeMotionList to identify the started motion by instance ID. Note that the callback will not work if null is registered to the callback.

```C#
private CubismMotionController _motionController;
private CubismFadeMotionList _cubismFadeMotionList;

// Start is called before the first frame update
private void Start()
{
    _motionController = GetComponent<CubismMotionController>();

    _cubismFadeMotionList = GetComponent<CubismFadeController>().CubismFadeMotionList;
    _motionController.AnimationBeginHandler += OnAnimationBegin;
}

private void OnAnimationBegin(int instanceId)
{
    if (!_cubismFadeMotionList)
    {
        return;
    }

    for (int i = 0; i < _cubismFadeMotionList.MotionInstanceIds.Length; i++)
    {
        if (_cubismFadeMotionList.MotionInstanceIds[i] != instanceId)
        {
            continue;
        }

        Debug.Log("StartedMotion: " + _cubismFadeMotionList.CubismFadeMotionObjects[i].MotionName);
        break;
    }
}

```

--------------------------------

### CubismFrameworkの初期化処理 (Java)

Source: https://docs.live2d.com/cubism-sdk-manual/use-framework-java

CubismFramework.startUp() と CubismFramework.initialize() を使用してCubismFrameworkを初期化するコードです。Cubism SDK for Native では第一引数にアロケータを取りますが、Javaでは不要です。ログ出力レベルを設定するためのOptionを設定し、cleanUp() を呼び出してから startUp() を呼び出しています。

```java
public class LAppDelegate{
    public void onSurfaceCreated() {
        ...
        // Initialize Cubism SDK framework
        CubismFramework.initialize();

        // シェーダーの初期化
        _view.initializeShader();
    }

    private LAppDelegate() {
        ...
        // ログ出力のレベルを設定。LogLevel.VERBOSEの場合は詳細ログを出力させる。
        _cubismOption = new CubismFramework.Option();
        _cubismOption.logFunction = new LAppPal.PrintLogFunction();
        _cubismOption.loggingLevel = LAppDefine.cubismLoggingLevel;

        CubismFramework.cleanUp();
        // CubismJavaFrameworkの初期化に必要なパラメーターを設定する。
        CubismFramework.startUp(_cubismOption);
    }
  
    private CubismFramework.Option _cubismOption;
}
```

--------------------------------

### Save and restore parameters in TypeScript (CubismModel.saveParameters/loadParameters)

Source: https://docs.live2d.com/cubism-sdk-manual/parameters

TypeScript example using CubismModel.saveParameters and CubismModel.loadParameters to temporarily save and restore all parameter values. It shows getting the index for 'ParamAngleX', setting it to 30, saving, setting to 0, and then loading to restore the value to 30.

```TypeScript
// TypeScript
// 初期化時
let paramAngleX: number;
paramAngleX = _model.getParameterIndex(CubismFramework.getIdManager().getId("ParamAngleX"));

// パラメータを30に設定
_model.setParameterValueByIndex(paramAngleX, 30.0, 1.0);

// 現在のすべてのパラメータ値を一時保存
_model.saveParameters();

// 0に設定
_model.setParameterValue(paramAngleX, 0.0, 1.0);

// output: value = 0
LAppPal.printLog("value = {0}", _model.getParameterValueByIndex(paramAngleX));

// 前回のsaveParam時の状態を復元
_model.loadParameters();

// output: value = 30
LAppPal.printLog("value = {0}", _model.getParameterValueByIndex(paramAngleX));

```

--------------------------------

### CubismFramework.initialize

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close-web

Framework を使用する前に一度だけ呼び出す初期化関数です。startUp 関数の後に呼び出します。

```APIDOC
## CubismFramework.initialize

### Description
Framework を使用する前に一度だけ呼び出す初期化関数です。startUp 関数の後に呼び出します。

### Method
initialize

### Parameters
なし

### Request Example
```typescript
CubismFramework.initialize();
```

### Response
#### Success Response
なし

### Notes
- 一度も呼ばなかった場合は Framework 使用時にエラーになります。
- 連続で呼んだ場合は処理は無視されます。
- dispose 関数を呼んで終了した後ならば、再度 initialize 関数を呼んで初期化することができます。
```

--------------------------------

### Save and restore parameters in C++ (CubismModel::SaveParameters/LoadParameters)

Source: https://docs.live2d.com/cubism-sdk-manual/parameters

C++ example using CubismModel::SaveParameters and CubismModel::LoadParameters to temporarily save and restore all parameter values. It shows getting the index for 'ParamAngleX', setting it to 30, saving, setting to 0, and then loading to restore the value to 30.

```C++
// C++
//初期化時
csmInt32 paramAngleX;
paramAngleX = _model->GetParameterIndex(CubismFramework::GetIdManager()->GetId("ParamAngleX"));

// パラメータを30に設定
_model->SetParameterValue( paramAngleX, 30.0f ,1.0f );

//現在のすべてのパラメータ値を一時保存
_model->SaveParameters();

// 0に設定
_model->SetParameterValue( paramAngleX, 0.0f ,1.0f );

//output: value = 0
printf("value = %f",_model->GetParameterValue( paramAngleX ) );

//前回のsaveParam時の状態を復元
_model->LoadParameters();

//output: value = 30
printf("value = %f",_model->GetParameterValue(　paramAngleX ) );

```

--------------------------------

### CubismEyeBlinkController.refresh() and start() in TypeScript

Source: https://docs.live2d.com/cubism-sdk-manual/eyeblink-cocos

Refreshes the controller's cached references to CubismEyeBlinkParameter components. Call after adding or removing such parameters. The start() method initializes the cache when the component starts.

```TypeScript
/** Refreshes controller. Call this method after adding and/or removing <see cref="CubismEyeBlinkParameter"/>s. */
  public refresh(): void {
    const model = CoreComponentExtensionMethods.findCubismModel(this);

    // Fail silently...
    if (model == null) {
      return;
    }

    // Cache destinations.
    const tags =
      model.parameters != null
        ? ComponentExtensionMethods.getComponentsMany(model.parameters, CubismEyeBlinkParameter)
        : null;

    this.destinations = new Array(tags?.length ?? 0);

    for (var i = 0; i < this.destinations.length; i++) {
      this.destinations[i] = tags![i].getComponent(CubismParameter);
    }

    // Get cubism update controller.
    this.hasUpdateController = this.getComponent(CubismUpdateController) != null;
  }

...

  /** Called by Cocos Creator. Makes sure cache is initialized. */
  protected start(): void {
    // Initialize cache.
    this.refresh();
  }
```

--------------------------------

### CubismFramework::StartUpで初期化オプションを設定する

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close

Cubism Framework for Nativeの初期化前に、メモリアロケータとログオプションを設定します。LAppAllocatorはCsm::ICubismAllocatorを継承し、LogFunctionとLoggingLevelを設定してからStartUpを呼び出します。メモリアロケータが設定されていないと、後続のCubismFramework::Initialize関数が動作しません。

```C++
// C++
LAppAllocator                  cubismAllocator;  //LAppAllocatorはCsm::ICubismAllocatorより継承
Csm::CubismFramework::Option   cubismOption;

// prepare for Cubism Framework API.
cubismOption.LogFunction = LAppPal::PrintMessage;
cubismOption.LoggingLevel = Live2D::Cubism::Framework::CubismFramework::Option::LogLevel_Info;
Csm::CubismFramework::StartUp(&cubismAllocator, &cubismOption);
```

--------------------------------

### CubismFramework.startUpの設定と初期化

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close-java

CubismFramework.startUp関数を呼び出す前に、ログオプションを設定します。この関数を呼び出さないと、後で行うCubismFramework.initialize関数が動作しません。初期化時にはデバッグ用関数を介してCubism Coreのバージョン情報が表示されます。

```Java
// Java
private LAppDelegate() {
    currentModel = ModelDir.values()[0];

    // Set up Cubism SDK framework.
    cubismOption.logFunction = new LAppPal.PrintLogFunction();
    cubismOption.loggingLevel = LAppDefine.cubismLoggingLevel;

    CubismFramework.cleanUp();
    CubismFramework.startUp(cubismOption);
}

private final CubismFramework.Option cubismOption = new CubismFramework.Option();
```

```Plain text
[CSM][I]Live2D Cubism Core Version: 04.02.0001 (67239937)
```

--------------------------------

### Java startMotion method for CubismMotionManager

Source: https://docs.live2d.com/cubism-sdk-manual/motion

Starts a motion with group, number, priority, and an optional completion callback. Returns -1 if the motion cannot start. Uses LAppDefine.Priority.FORCE to reserve priority and logs 'Cannot start motion.' when reservation fails.

```Java
// Java
	public int startMotion(final String group,
                           int number,
                           int priority,
                           IFinishedMotionCallback onFinishedMotionHandler
                          ) {
      if (priority == LAppDefine.Priority.FORCE.getPriority()) {
        motionManager.setReservationPriority(priority);
      } else if (!motionManager.reserveMotion(priority)) {

        if (debugMode) {
          LAppPal.printLog("Cannot start motion.");
        }
        return -1;
      }

      /*モーションデータ準備部分省略*/
      if (motionManager.startMotionPriority(motion, priority) != -1) {
        return motionManager.startMotionPriority(motion, priority);
      }
      return -1;
    }
```

--------------------------------

### TypeScript startMotion method for CubismMotionManager

Source: https://docs.live2d.com/cubism-sdk-manual/motion

Starts a motion by group, number, and priority. Returns a CubismMotionQueueEntryHandle or InvalidMotionQueueEntryHandleValue if the motion cannot start. Uses LAppDefine.PriorityForce to reserve priority and logs '[APP]can't start motion.' when reservation fails.

```TypeScript
// TypeScript
    /**
     * 引数で指定したモーションの再生を開始する
     * @param group モーショングループ名
     * @param no グループ内の番号
     * @param priority 優先度
     * @return 開始したモーションの識別番号を返す。
     *         個別のモーションが終了したか否かを判定するisFinished()の引数で使用する。
     *         開始できない時は[-1]
     */
    public startMotion(group: string, no: number, priority: number) : CubismMotionQueueEntryHandle
    {
        if(priority == LAppDefine.PriorityForce)
        {
            this._motionManager.setReservePriority(priority);
        }
        else if(!this._motionManager.reserveMotion(priority))
        {
            if(this._debugMode)
            {
                LAppPal.printLog("[APP]can't start motion.");
            }
            return InvalidMotionQueueEntryHandleValue;
        }

/*モーションデータ準備部分省略*/
        return this._motionManager.startMotionPriority(motion, autoDelete, priority);
    }
```

--------------------------------

### Refresh CubismLookController references and initialize in start()

Source: https://docs.live2d.com/cubism-sdk-manual/lookat-cocos

CubismLookController refreshes its references to all CubismLookParameter components on the model. Call refresh() after adding or removing look parameters at runtime. The start() method initializes the center node and calls refresh() when the component starts.

```TypeScript
/** Refreshes the controller. Call this method after adding and/or removing {@link CubismLookParameter}s. */
public refresh(): void {
  const model = CoreComponentExtensionMethods.findCubismModel(this);
  if (model == null) {
    return;
  }
  if (model.parameters == null) {
    return;
  }

  // Catch sources and destinations.

  this.sources = ComponentExtensionMethods.getComponentsMany(
    model.parameters,
    CubismLookParameter
  );
  this.destinations = new Array<CubismParameter>(this.sources.length);

  for (let i = 0; i < this.sources.length; i++) {
    this.destinations[i] = this.sources[i].getComponent(CubismParameter);
  }

  // Get cubism update controller.
  this.hasUpdateController = this.getComponent(CubismUpdateController) != null;
}

...

/** Called by Cocos Creator. Makes sure cache is initialized. */
protected start(): void {
  // Default center if necessary.
  if (this.center == null) {
    this.center = this.node;
  }

  // Initialize cache.
  this.refresh();
}
```

--------------------------------

### CubismFramework::StartUp

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close

Cubism Frameworkを初期化するための最初の関数です。メモリアロケータとログオプションを設定します。

```APIDOC
## CubismFramework::StartUp

### Description
Cubism Frameworkを起動するための関数です。メモリアロケータとログオプションを設定します。メモリアロケータが設定されないと、後続のInitialize関数が動作しません。

### Method
StartUp

### Signature
Csm::CubismFramework::StartUp(ICubismAllocator* allocator, Option* option)

### Parameters
- **allocator** (ICubismAllocator*) - Required - メモリ確保のメソッドが登録されたオブジェクト。
- **option** (Option*) - Required - デバッグレベルやデバッグ用関数の登録を指定するオプション。

### Option Fields
- **LogFunction** (function) - Required - ログ出力用の関数ポインタ。
- **LoggingLevel** (LogLevel) - Required - ログの出力レベル。例: LogLevel_Info

### Request Example
```cpp
LAppAllocator cubismAllocator; //LAppAllocatorはCsm::ICubismAllocatorより継承
Csm::CubismFramework::Option cubismOption;
// prepare for Cubism Framework API.
cubismOption.LogFunction = LAppPal::PrintMessage;
cubismOption.LoggingLevel = Live2D::Cubism::Framework::CubismFramework::Option::LogLevel_Info;
Csm::CubismFramework::StartUp(&cubismAllocator, &cubismOption);
```

### Response
#### Success Response
初期化時にデバッグ用関数を介して、Cubism Core for Nativeのバージョン情報が表示されます。

#### Response Example
```
[CSM][I]Live2D Cubism Core version: 03.00.0003 (50331651)
```
```

--------------------------------

### CubismModelMatrix.setupFromLayout (Java)

Source: https://docs.live2d.com/cubism-sdk-manual/layout

Applies layout information from model3.json to set the model's position and scale in Java.

```APIDOC
## CubismModelMatrix.setupFromLayout (Java)

### Description
Applies layout information from model3.json to set the model's position and scale in Java.

### Method
setupFromLayout

### Parameters
- **layout** (Map<String, Float>) - Required - The layout map obtained from model3.json.

### Request Example
```java
CubismModelSettingJson model3Json;
Map<String, Float> layout = new HashMap<String, Float>();
model3Json.getLayoutMap(layout);

// モデルのレイアウトを設定
cubismModelMatrix.setupFromLayout(layout);
```

### Response
No return value.
```

--------------------------------

### startMotion(motion: ACubismMotion, autoDelete: boolean, userTimeSeconds: number): CubismMotionQueueEntryHandle

Source: https://docs.live2d.com/cubism-sdk-manual/motion

Starts the specified motion. If a motion of the same type already exists, it sets a finish flag on the existing motion and begins fade-out. Returns the identifier of the started motion, or -1 if it cannot be started.

```APIDOC
## startMotion(motion: ACubismMotion, autoDelete: boolean, userTimeSeconds: number): CubismMotionQueueEntryHandle

### Description
Starts the specified motion. If a motion of the same type already exists, it sets a finish flag on the existing motion and begins fade-out. Returns the identifier of the started motion, or -1 if it cannot be started.

### Method
startMotion

### Signature
`public startMotion(motion: ACubismMotion, autoDelete: boolean, userTimeSeconds: number) : CubismMotionQueueEntryHandle`

### Parameters
- **motion** (ACubismMotion) - Required - The motion to start.
- **autoDelete** (boolean) - Required - If true, the motion instance will be deleted when playback finishes.
- **userTimeSeconds** (number) - Required - The accumulated delta time in seconds.

### Return Value
- **CubismMotionQueueEntryHandle** - The identifier of the started motion. Used as an argument for `IsFinished()` to determine if a specific motion has finished. Returns `-1` if the motion cannot be started.

### Behavior
- If `motion` is null, returns `InvalidMotionQueueEntryHandleValue`.
- For each existing motion in the queue, calls `startFadeout` with the existing motion's fade-out time and `userTimeSeconds` to begin fade-out.
- Creates a new `CubismMotionQueueEntry` with the provided motion and autoDelete flag, adds it to the queue, and returns its handle.

### Example
```typescript
const handle = motionQueueManager.startMotion(motion, true, deltaTimeSeconds);
```
```

--------------------------------

### Playback Speed Adjustment Example

Source: https://docs.live2d.com/cubism-sdk-manual/motion

Example of adjusting the playback speed by multiplying deltaTimeSeconds with a playSpeed factor. The playSpeed is calculated as 2^(motionSpeed/10).

```APIDOC
## Playback Speed Adjustment Example

### Description
Example of adjusting the playback speed by multiplying deltaTimeSeconds with a playSpeed factor. The playSpeed is calculated as 2^(motionSpeed/10).

### Method
Function call

### Endpoint
CubismMotionManager::UpdateMotion / updateMotion

### Parameters
#### Parameters
- **motionSpeed** (number) - Required - The speed multiplier value used to calculate playSpeed.
- **deltaTimeSeconds** (number) - Required - The base delta time in seconds.

### Request Example
```cpp
const csmFloat32 playSpeed = pow(2, (csmFloat32)_motionSpeed / 10.0);
motionUpdated = _motionManager->UpdateMotion(_model, deltaTimeSeconds * playSpeed); // モーションを更新
```

```typescript
let playSpeed:number = Math.pow(2, _motionSpeed / 10.0);
motionUpdated = motionManager.updateMoiton(model, deltaTimeSeconds);
```

```java
final float playSpeed = Math.pow(2, (float)motionSpeed / 10.0f);
isMotionUpdated = motionManager.updateMotion(model, deltaTimeSeconds * playSpeed); // モーションを更新
```

### Response
#### Success Response
- **motionUpdated** (boolean) - Indicates whether the motion was updated.

#### Response Example
```cpp
bool motionUpdated = _motionManager->UpdateMotion(_model, deltaTimeSeconds * playSpeed);
```

### Notes
- Negative deltaTimeSeconds (reverse playback) is not supported.
```

--------------------------------

### Importer implementation example (C#)

Source: https://docs.live2d.com/cubism-sdk-manual/importerdeleter

Shows how to create a custom importer by extending CubismImporterBase and registering it with CubismImporter.RegisterImporter<T>(). The importer logs the asset path during import. Requires the Live2D.Cubism.Editor.Importers namespace.

```csharp
using Live2D.Cubism.Editor.Importers;

public sealed class ImporterCustomization : CubismImporterBase
{
    private static string _extension = ".asset";

    [UnityEditor.InitializeOnLoadMethod]
    private static void RegisterImporter()
    {
        CubismImporter.RegisterImporter<ImporterCustomization>(_extension);
    }

    public override void Import()
    {
        UnityEngine.Debug.Log("Asset Import as path : " + AssetPath);
    }
}
```

--------------------------------

### Measure shader setup and draw time in DrawMeshOpenGL

Source: https://docs.live2d.com/cubism-sdk-manual/ow-sdk-mask-premake

Shows how to measure the time for shader data setup and the draw command itself within CubismRenderer_OpenGLES2::DrawMeshOpenGL. Uses P_TIME1 macros to measure shader setup and glDrawElements, and includes post-processing with glUseProgram(0) and clearing clipping context buffers.

```cpp
void CubismRenderer_OpenGLES2::DrawMeshOpenGL(const CubismModel& model, const csmInt32 index)
{
　・
　・
　・
    {　//　★シェーダーへのデータのセット時間を測定
        P_TIME1(ProcessingTime sharder(s_sharder);)
        if (IsGeneratingMask())  // マスク生成時
        {
            CubismShader_OpenGLES2::GetInstance()->SetupShaderProgramForMask(this, model, index);
        }
        else
        {
            CubismShader_OpenGLES2::GetInstance()->SetupShaderProgramForDraw(this, model, index);
        }
    }

    {　//　★描画命令単体の時間測定
        P_TIME1(ProcessingTime gldraw(s_gldraw);)
        // ポリゴンメッシュを描画する
        glDrawElements(GL_TRIANGLES, indexCount, GL_UNSIGNED_SHORT, indexArray);
    }

    // 後処理
    glUseProgram(0);
    SetClippingContextBufferForDraw(NULL);
    SetClippingContextBufferForMask(NULL);
}
```

--------------------------------

### CubismFramework.initializeの呼び出し

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close-java

CubismFramework.startUp関数を実行した後で、CubismFramework.initialize関数を呼び出します。アプリケーションでFrameworkを使用する前に必ず一度だけ呼んでください。一度も呼ばなかった場合はFramework使用時にエラーになります。連続で呼んだ場合は処理は無視されます。ただし、CubismFramework.dispose関数を呼んで終了した後ならば、再度initialize関数を呼んで初期化することができます。

```Java
// Java
public void onSurfaceCreated() {
    // テクスチャサンプリング設定
    GLES20.glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
    GLES20.glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);

    // 透過設定
    GLES20.glEnable(GLES20.GL_BLEND);
    GLES20.glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);

    // Initialize Cubism SDK framework
    CubismFramework.initialize();

    // シェーダーの初期化
    view.initializeShader();
}
```

--------------------------------

### CubismLookController の Refresh() と Start() の実装

Source: https://docs.live2d.com/cubism-sdk-manual/lookat-unity

CubismLookController の Refresh() メソッドは、モデルから CubismLookParameter を取得し、対応する CubismParameter を設定します。また、CubismUpdateController の有無を確認します。Start() メソッドは、Center が null の場合に ICubismLookCenter を取得し、Refresh() を呼び出してキャッシュを初期化します。

```csharp
        /// <summary>
        /// Refreshes the controller. Call this method after adding and/or removing <see cref="CubismLookParameter"/>s.
        /// </summary>
        public void Refresh()
        {
            var model = this.FindCubismModel();


            // Catch sources and destinations.
            Sources = model
                .Parameters
                .GetComponentsMany<CubismLookParameter>();
            Destinations = new CubismParameter[Sources.Length];


            for (var i = 0; i < Sources.Length; ++i)
            {
                Destinations[i] = Sources[i].GetComponent<CubismParameter>();
            }

            // Get cubism update controller.
            HasUpdateController = (GetComponent<CubismUpdateController>() != null);
        }

        ...
        
        /// <summary>
        /// Called by Unity. Makes sure cache is initialized.
        /// </summary>
        private void Start()
        {
            // Default center if necessary.
            if (Center == null)
            {
                Center = GetComponent<ICubismLookCenter>() as Object;
            }


            // Initialize cache.
            Refresh();
        }
```

--------------------------------

### CubismFramework.startUpでログオプションを設定 (TypeScript)

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close-web

CubismFramework.startUp関数を呼び出してログオプションを設定します。この関数を呼び出さないと、後で行うCubismFramework.initialize関数が動作しません。引数にはデバッグレベルやデバッグ用関数を登録します。

```TypeScript
// TypeScript
let cubismOption: Option;

// prepare for Cubism Framework API.
cubismOption.logFunction = LAppPal.printMessage;
cubismOption.loggingLevel = LogLevel.LogLevel_Info;
CubismFramework.startUp(cubismOption);
```

--------------------------------

### CubismMouthController.Refresh() and Start()

Source: https://docs.live2d.com/cubism-sdk-manual/mouthmovement-unity

Refreshes the controller's cached references to CubismMouthParameter components. Call Refresh() after adding or removing CubismMouthParameter components. Start() calls Refresh() to initialize the cache.

```C#
        /// <summary>
        /// Refreshes controller. Call this method after adding and/or removing <see cref="CubismMouthParameter"/>s.
        /// </summary>
        public void Refresh()
        {
            var model = this.FindCubismModel();


            // Fail silently...
            if (model == null)
            {
                return;
            }


            // Cache destinations.
            var tags = model
                .Parameters
                .GetComponentsMany<CubismMouthParameter>();


            Destinations = new CubismParameter[tags.Length];


            for (var i = 0; i < tags.Length; ++i)
            {
                Destinations[i] = tags[i].GetComponent<CubismParameter>();
            }

            // Get cubism update controller.
            HasUpdateController = (GetComponent<CubismUpdateController>() != null);
        }

        ...

        /// <summary>
        /// Called by Unity. Makes sure cache is initialized.
        /// </summary>
        private void Start()
        {
            // Initialize cache.
            Refresh();
        }
```

--------------------------------

### Initialize Cubism Framework (C++)

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close

Call CubismFramework::Initialize once after CubismFramework::StartUp. Must be called before using the Framework; repeated calls are ignored, and it can be called again after Dispose.

```C++
// C++
CubismFramework::Initialize();
```

--------------------------------

### CubismFrameworkの初期化処理

Source: https://docs.live2d.com/cubism-sdk-manual/cubismnativeframework

ログ出力レベルとログ関数を設定し、CubismFramework::StartUp()で初期化パラメータを設定した後、CubismFramework::Initialize()で初期化します。Initialize()は初期化時に一度のみ呼び出し、破棄後は再度呼び出せます。

```cpp
    // ログ出力のレベルを設定。LogLevel_Verboseの場合は詳細ログを出力させる。
    _cubismOption.LoggingLevel = CubismFramework::Option::LogLevel_Verbose;
    _cubismOption.LogFunction = PrintMessage;
    
    // CubismNativeFrameworkの初期化に必要なパラメータを設定する。
    CubismFramework::StartUp(&_cubismAllocator, &_cubismOption);
    
    // CubismFrameworkを初期化する。
    CubismFramework::Initialize();

```

--------------------------------

### Start lip sync motion with startMotionPriority in Java

Source: https://docs.live2d.com/cubism-sdk-manual/lipsync

Starts a lip sync motion using the mouthMotionManager's startMotionPriority method, passing the motion, autoDelete flag, and priority.

```Java
// Java
mouseMotionManager.startMotionPriority(lipSyncMotion, autoDelete, priority);
```

--------------------------------

### CubismFramework.initializeで初期化 (TypeScript)

Source: https://docs.live2d.com/cubism-sdk-manual/framework-init-close-web

CubismFramework.startUp関数の後に呼び出し、Frameworkを使用する前に必ず一度だけ呼びます。呼ばない場合はエラーになり、連続で呼んだ場合は無視されます。dispose後に再度呼ぶことができます。

```TypeScript
// TypeScript
CubismFramework.initialize();
```

--------------------------------

### CubismEyeBlinkController.Refresh() and Start()

Source: https://docs.live2d.com/cubism-sdk-manual/eyeblink-unity

Refreshes the controller's cache of CubismEyeBlinkParameter references. Call this method after adding or removing CubismEyeBlinkParameter components. The Start() method calls Refresh() to initialize the cache.

```csharp
        /// <summary>
        /// Refreshes controller. Call this method after adding and/or removing <see cref="CubismEyeBlinkParameter"/>s.
        /// </summary>
        public void Refresh()
        {
            var model = this.FindCubismModel();
 
 
            // Fail silently...
            if (model == null)
            {
                return;
            }
 
 
            // Cache destinations.
            var tags = model
                .Parameters
                .GetComponentsMany<CubismEyeBlinkParameter>();
 
 
            Destinations = new CubismParameter[tags.Length];
 
 
            for (var i = 0; i < tags.Length; ++i)
            {
                Destinations[i] = tags[i].GetComponent<CubismParameter>();
            }
 
            // Get cubism update controller.
            HasUpdateController = (GetComponent<CubismUpdateController>() != null);
        }
        
        
        ...
        
        
        /// <summary>
        /// Called by Unity. Makes sure cache is initialized.
        /// </summary>
        private void Start()
        {
            // Initialize cache.
            Refresh();
        }
```

--------------------------------

### Implement motion begin and finish callbacks

Source: https://docs.live2d.com/cubism-sdk-manual/callback-motion-end-web

Defines callback functions that log the start and end of motion playback using LAppPal.printMessage(). Modify these implementations to change the behavior at motion start and end.

```typescript
_beganMotion = (self: ACubismMotion) => {
    LAppPal.printMessage("Motion Began:");
    console.log(self);
}

_finishedMotion = (self: ACubismMotion) => {
    LAppPal.printMessage("Motion Finished:");
    console.log(self);
}
```

--------------------------------

### CubismMoc.CreateFrom() でMOC3整合性を検証する (Unity)

Source: https://docs.live2d.com/cubism-sdk-manual/moc3-consistency

Cubism SDK for UnityのCubismMoc.CreateFrom()メソッドは、shouldCheckMocConsistencyがtrue（デフォルト）の場合にHasMocConsistency()で整合性を確認し、失敗時はエラーログを出力してnullを返します。成功時はCubismMocインスタンスを作成して返します。

```csharp
// Cubism SDK for Unity

public static CubismMoc CreateFrom(byte[] moc3, bool shouldCheckMocConsistency = true)
{
    if (shouldCheckMocConsistency && !HasMocConsistency(moc3))
    {
        Debug.LogError("This Moc3 is Invalid. This model generation process is aborted and prefab is not created.\n" +
                                   $"Please check Model's Moc version. This CubismCore supported latest Moc version is `{LatestVersion}`.");
        return null;
    }

    var moc = CreateInstance<CubismMoc>();


    moc.Bytes = moc3;


    return moc;
}
```

--------------------------------

### CubismModelMatrix::SetupFromLayout

Source: https://docs.live2d.com/cubism-sdk-manual/layout

Applies layout information from model3.json to set the model's position and scale.

```APIDOC
## CubismModelMatrix::SetupFromLayout

### Description
Applies layout information from model3.json to set the model's position and scale.

### Method
SetupFromLayout

### Parameters
- **layout** (csmMap<csmString, csmFloat32>) - Required - The layout map obtained from model3.json.

### Request Example
```cpp
CubismModelSettingJson* model3Json;

csmMap<csmString, csmFloat32> layout;
model3Json->GetLayoutMap(layout);

// モデルのレイアウトを設定。
cubismModelMatrix->SetupFromLayout(layout);
```

### Response
No return value.
```

--------------------------------

### CubismHarmonicMotionController.refresh() and start()

Source: https://docs.live2d.com/cubism-sdk-manual/harmonicmotion-cocos

The refresh() method reacquires references to all CubismHarmonicMotionParameter components and their corresponding CubismParameter destinations. Call it after adding or removing parameters at runtime. The start() method, called by Cocos Creator, initializes the cache by invoking refresh().

```TypeScript
  /** Refreshes the controller. Call this method after adding and/or removing {@link CubismHarmonicMotionParameter}. */
  public refresh() {
    const model = CoreComponentExtensionMethods.findCubismModel(this);

    if (model == null || model.parameters == null) {
      return;
    }

    // Catch sources and destinations.
    this.sources = FrameworkComponentExtensionMethods.getComponentsMany(
      model.parameters,
      CubismHarmonicMotionParameter
    );
    this.destinations = new Array<CubismParameter>(this.sources.length);

    for (let i = 0; i < this.sources.length; ++i) {
      this.destinations[i] = this.sources[i].getComponent(CubismParameter);
    }

    // Get cubism update controller.
    this.hasUpdateController = this.getComponent(CubismUpdateController) != null;
  }

  ...

  /** Called by Cocos Creator. Makes sure cache is initialized. */
  protected start() {
    // Initialize cache.
    this.refresh();
  }
```
Tokens:
Raw