CriAtomExTween API


構成

struct  CriAtomExTweenConfigTag
 トゥイーン作成用コンフィグ構造体 [詳細]

マクロ定義

#define criAtomExTween_SetDefaultConfig(p_config)
 トゥイーン作成用コンフィグ構造体にデフォルト値をセット

型定義

typedef enum CriAtomExTweenParameterTypeTag CriAtomExTweenParameterType
 Tweenのパラメータータイプ
typedef CriAtomExTweenConfigTag CriAtomExTweenConfig
 トゥイーン作成用コンフィグ構造体
typedef CriAtomExTweenTag * CriAtomExTweenHn
 トゥイーンハンドル

列挙型

enum  CriAtomExTweenParameterTypeTag { CRIATOMEX_PARAMETER_TYPE_BASIC, CRIATOMEX_PARAMETER_TYPE_AISAC }
 Tweenのパラメータータイプ [詳細]

関数

CriSint32 CRIAPI criAtomExTween_CalculateWorkSize (const CriAtomExTweenConfig *config)
 トゥイーンの作成に必要なワーク領域サイズの計算
CriAtomExTweenHn CRIAPI criAtomExTween_Create (const CriAtomExTweenConfig *config, void *work, CriSint32 work_size)
 トゥイーンの作成
void CRIAPI criAtomExTween_Destroy (CriAtomExTweenHn tween)
 トゥイーンの破棄
CriFloat32 CRIAPI criAtomExTween_GetValue (CriAtomExTweenHn tween)
 現在値の取得
void CRIAPI criAtomExTween_MoveTo (CriAtomExTweenHn tween, CriUint16 time_ms, CriFloat32 value)
 現在値から指定値に変化
void CRIAPI criAtomExTween_MoveFrom (CriAtomExTweenHn tween, CriUint16 time_ms, CriFloat32 value)
 指定値から現在値に変化
void CRIAPI criAtomExTween_Stop (CriAtomExTweenHn tween)
 トゥイーンの停止
void CRIAPI criAtomExTween_Reset (CriAtomExTweenHn tween)
 トゥイーンのリセット

マクロ定義

#define criAtomExTween_SetDefaultConfig ( p_config   ) 

値:

{\
    (p_config)->id.parameter_id = CRIATOMEX_PARAMETER_ID_VOLUME;\
    (p_config)->parameter_type = CRIATOMEX_PARAMETER_TYPE_BASIC;\
}
トゥイーン作成用コンフィグ構造体にデフォルト値をセット

引数:
[out] p_config コンフィグ構造体へのポインタ
説明:
criAtomExTween_Create 関数に設定するコンフィグ構造体( CriAtomExTweenConfig )に、 デフォルトの値をセットします。
参照:
CriAtomExTweenConfig


型定義

typedef enum CriAtomExTweenParameterTypeTag CriAtomExTweenParameterType

Tweenのパラメータータイプ

説明:
Tweenで操作するパラメーターのタイプです。
参照:
CriAtomExTweenConfig

typedef struct CriAtomExTweenConfigTag CriAtomExTweenConfig

トゥイーン作成用コンフィグ構造体

説明:
トゥイーンを作成する際に、動作仕様を指定するための構造体です。
criAtomExTween_Create 関数の引数に指定します。
本構造体を使用する際には criAtomExTween_SetDefaultConfig マクロを使用し、 構造体の初期化を行ってください。
参照:
criAtomExTween_SetDefaultConfig, criAtomExTween_CalculateWorkSize, criAtomExTween_Create

typedef struct CriAtomExTweenTag* CriAtomExTweenHn

トゥイーンハンドル

説明:
CriAtomExTweenHn は、トゥイーンを操作するためのハンドルです。
トゥイーンとは、簡単な手順でパラメーターの時間変化を行うためのモジュールです。 criAtomExTween_Create 関数でトゥイーンを作成すると、 本関数はトゥイーン操作用に、この"トゥイーンハンドル"を返します。
パラメーターの時間変化の開始等、トゥイーンに対して行う操作は、 全てトゥイーンハンドルを介して実行されます。
また、AtomExプレーヤーにトゥイーンを関連づける際にも使用します。
参照:
criAtomExTween_Create, criAtomExPlayer_AttachTween


列挙型

enum CriAtomExTweenParameterTypeTag

Tweenのパラメータータイプ

説明:
Tweenで操作するパラメーターのタイプです。
参照:
CriAtomExTweenConfig
列挙型の値:
CRIATOMEX_PARAMETER_TYPE_BASIC  基本パラメーター

説明:
ボリューム、ピッチ等、CriAtomExParameterIdで指定するパラメーターを操作する際に指定します。
CRIATOMEX_PARAMETER_TYPE_AISAC  AISACコントロール値

説明:
AISACコントロール値を操作する際に指定します。


関数

CriSint32 CRIAPI criAtomExTween_CalculateWorkSize ( const CriAtomExTweenConfig config  ) 

トゥイーンの作成に必要なワーク領域サイズの計算

引数:
[in] config トゥイーン作成用コンフィグ構造体
戻り値:
CriSint32 ワーク領域サイズ
戻り値:
0以上 正常に処理が完了
-1 エラーが発生
説明:
トゥイーンを作成するのに必要な、ワーク領域のサイズを取得します。
アロケーターを登録せずにトゥイーンを作成する場合、あらかじめ本関数で計算した ワーク領域サイズ分のメモリをワーク領域として criAtomExTween_Create 関数に セットする必要があります。

引数にNULLを指定した場合、デフォルト設定 ( criAtomExTween_SetDefaultConfig 適用時と同じパラメーター)で ワーク領域サイズを計算します。

ワーク領域サイズ計算時に失敗した場合、戻り値は -1 になります。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックの メッセージで確認可能です。
備考:
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数を実行する前に、ライブラリを初期化しておく必要があります。
参照:
CriAtomExTweenConfig, criAtomExTween_Create

CriAtomExTweenHn CRIAPI criAtomExTween_Create ( const CriAtomExTweenConfig config,
void *  work,
CriSint32  work_size 
)

トゥイーンの作成

引数:
[in] config トゥイーン作成用コンフィグ構造体へのポインタ
[in] work トゥイーン作成用ワーク領域へのポインタ
[in] work_size トゥイーン作成用ワークサイズ
戻り値:
CriAtomExTweenHn トゥイーンハンドル
説明:
トゥイーン作成用コンフィグに基づいて、トゥイーンを作成します。
作成に成功すると、トゥイーンハンドルを返します。
トゥイーンを作成する際には、ワーク領域としてメモリを渡す必要があります。
必要なメモリのサイズは、 criAtomExTween_CalculateWorkSize 関数で計算します。
criAtomEx_SetUserAllocator マクロを使用してアロケーターを登録済みの場合、 本関数にワーク領域を指定する必要はありません。)
作成したトゥイーンは、criAtomExPlayer_AttachTween 関数にてAtomExプレーヤーにアタッチすることで効果を発揮します。
備考:
トゥイーンの保持するパラメーターの初期値は、コンフィグ構造体でパラメータータイプにCRIATOMEX_PARAMETER_TYPE_BASICを指定した場合は各パラメーターのデフォルト値、またはパラメータータイプにCRIATOMEX_PARAMETER_TYPE_AISACを指定した場合は0.0fです。
注意:
本関数を実行する前に、ライブラリを初期化しておく必要があります。

参照:
criAtomExTween_CalculateWorkSize, criAtomExTween_Destroy, criAtomExPlayer_AttachTween

void CRIAPI criAtomExTween_Destroy ( CriAtomExTweenHn  tween  ) 

トゥイーンの破棄

引数:
[in] tween トゥイーンハンドル
説明:
トゥイーンを破棄します。
本関数を実行した時点で、トゥイーン作成時に確保されたリソースが全て解放されます。
また、引数に指定したトゥイーンハンドルも無効になります。
トゥイーンをアタッチしたAtomExプレーヤーで再生している音声がある場合、 本関数を実行する前に、それらの音声を停止するか、そのAtomExプレーヤーを破棄してください。
参照:
criAtomExTween_Create

CriFloat32 CRIAPI criAtomExTween_GetValue ( CriAtomExTweenHn  tween  ) 

現在値の取得

引数:
[in] tween トゥイーンハンドル
説明:
トゥイーンが保持しているパラメーターの現在値を取得します。

void CRIAPI criAtomExTween_MoveTo ( CriAtomExTweenHn  tween,
CriUint16  time_ms,
CriFloat32  value 
)

現在値から指定値に変化

引数:
[in] tween トゥイーンハンドル
[in] time_ms 変化に要する時間(ミリ秒単位)
[in] value 変化後の最終値
説明:
time_msで指定した時間をかけて、本関数呼び出し時にトゥイーンが保持している現在値から、valueで指定した値へと変化します。
変化カーブはリニア(線形)です。

void CRIAPI criAtomExTween_MoveFrom ( CriAtomExTweenHn  tween,
CriUint16  time_ms,
CriFloat32  value 
)

指定値から現在値に変化

引数:
[in] tween トゥイーンハンドル
[in] time_ms 変化に要する時間(ミリ秒単位)
[in] value 変化前の開始値
説明:
time_msで指定した時間をかけて、valueで指定した値から、本関数呼び出し時にトゥイーンが保持している現在値へと変化します。
変化カーブはリニア(線形)です。

void CRIAPI criAtomExTween_Stop ( CriAtomExTweenHn  tween  ) 

トゥイーンの停止

引数:
[in] tween トゥイーンハンドル
説明:
トゥイーンによるパラメーターの時間変化を停止します。

void CRIAPI criAtomExTween_Reset ( CriAtomExTweenHn  tween  ) 

トゥイーンのリセット

引数:
[in] tween トゥイーンハンドル
説明:
トゥイーンの保持しているパラメーターの現在値をリセットし、初期値に戻します。
トゥイーンの保持するパラメーターの初期値は、コンフィグ構造体でパラメータータイプにCRIATOMEX_PARAMETER_TYPE_BASICを指定した場合は各パラメーターのデフォルト値、またはパラメータータイプにCRIATOMEX_PARAMETER_TYPE_AISACを指定した場合は0.0fです。
備考:
トゥイーンによる時間変化が動作していた場合、動作を停止します。


CRI Middleware logo Copyright (c) 2006-2018 CRI Middleware Co., Ltd.