Class CubismFramework

Live2D Cubism SDK Original Workflow SDKのエントリポイント利用開始時はCubismFramework.initialize()を呼び、CubismFramework.dispose()で終了する。

Hierarchy

CubismFramework

Index

Methods

cleanUp coreLogFunction dispose getLoggingLevel initialize isInitialized isStarted startUp

Methods

`Static` cleanUp

cleanUp(): void
StartUp()で初期化したCubismFrameworkの各パラメータをクリアします。 Dispose()したCubismFrameworkを再利用する際に利用してください。

Returns void
- Defined in cubism/src/live2dcubismframework.ts:86

`Static` coreLogFunction

coreLogFunction(message: string): void
Core APIにバインドしたログ関数を実行する

Praram
message ログメッセージ
Parameters
- message: string
Returns void
- Defined in cubism/src/live2dcubismframework.ts:165

`Static` dispose

dispose(): void
Cubism Framework内の全てのリソースを解放します。ただし、外部で確保されたリソースについては解放しません。外部で適切に破棄する必要があります。

Returns void
- Defined in cubism/src/live2dcubismframework.ts:122

`Static` getLoggingLevel

getLoggingLevel(): LogLevel
現在のログ出力レベル設定の値を返す。

Returns
現在のログ出力レベル設定の値

Returns LogLevel
- Defined in cubism/src/live2dcubismframework.ts:179

`Static` initialize

initialize(): void
Cubism Framework内のリソースを初期化してモデルを表示可能な状態にします。
再度Initialize()するには先にDispose()を実行する必要があります。

Returns void
- Defined in cubism/src/live2dcubismframework.ts:96

`Static` isInitialized

isInitialized(): boolean
Cubism Frameworkのリソース初期化がすでに行われているかどうか

Returns
リソース確保が完了していればtrueが返ります

Returns boolean
- Defined in cubism/src/live2dcubismframework.ts:156

`Static` isStarted

isStarted(): boolean
Cubism FrameworkのAPIを使用する準備が完了したかどうか

Returns
APIを使用する準備が完了していればtrueが返ります。

Returns boolean
- Defined in cubism/src/live2dcubismframework.ts:148

`Static` startUp

startUp(option?: CubismStartupOption): boolean
Cubism FrameworkのAPIを使用可能にする。 APIを実行する前に必ずこの関数を実行すること。一度準備が完了して以降は、再び実行しても内部処理がスキップされます。

Returns
準備処理が完了したらtrueが返ります。
Parameters
- Optional option: CubismStartupOption
  
  Optionクラスのインスタンス
Returns boolean
- Defined in cubism/src/live2dcubismframework.ts:39

Generated using TypeDoc