構成 | マクロ定義 | 関数
CriAtomEx MacOSX API

構成

struct  CriAtomConfig_MACOSX
 Atomライブラリ初期化用コンフィグ構造体CRI Atomライブラリの動作仕様を指定するための構造体です。
criAtom_Initialize_MACOSX 関数の引数に指定します。
[詳細]
struct  CriAtomExConfig_MACOSX
 Atomライブラリ初期化用コンフィグ構造体CRI Atomライブラリの動作仕様を指定するための構造体です。
criAtomEx_Initialize_MACOSX 関数の引数に指定します。
[詳細]

マクロ定義

#define criAtom_SetDefaultConfig_MACOSX(p_config)
 ライブラリ初期化用コンフィグ構造体にデフォルト値をセット
#define criAtomEx_SetDefaultConfig_MACOSX(p_config)
 ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

関数

CriSint32 CRIAPI criAtom_CalculateWorkSize_MACOSX (const CriAtomConfig_MACOSX *config)
 ライブラリ初期化用ワーク領域サイズの計算
void CRIAPI criAtom_Initialize_MACOSX (const CriAtomConfig_MACOSX *config, void *work, CriSint32 work_size)
 ライブラリの初期化
void CRIAPI criAtom_Finalize_MACOSX (void)
 ライブラリの終了
void CRIAPI criAtom_SetServerThreadPriority_MACOSX (int prio)
 サーバスレッドプライオリティの設定
CriSint32 CRIAPI criAtomEx_CalculateWorkSize_MACOSX (const CriAtomExConfig_MACOSX *config)
 ライブラリ初期化用ワーク領域サイズの計算
void CRIAPI criAtomEx_Initialize_MACOSX (const CriAtomExConfig_MACOSX *config, void *work, CriSint32 work_size)
 ライブラリの初期化
void CRIAPI criAtomEx_Finalize_MACOSX (void)
 ライブラリの終了
void CRIAPI criAtomEx_SetServerThreadPriority_MACOSX (int prio)
 サーバスレッドプライオリティの設定

説明


マクロ定義

#define criAtom_SetDefaultConfig_MACOSX (   p_config)
値:
{                                                           \
    criAtom_SetDefaultConfig(&(p_config)->atom);            \
    criAtomExAsr_SetDefaultConfig(&(p_config)->asr);        \
    criAtomHcaMx_SetDefaultConfig(&(p_config)->hca_mx);     \
}

ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

引数:
[out]p_config初期化用コンフィグ構造体へのポインタ
説明:
criAtom_Initialize_MACOSX 関数に設定するコンフィグ構造体 ( CriAtomConfig_MACOSX )に、デフォルトの値をセットします。
注意:
本マクロは下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本マクロの代わりに criAtomEx_SetDefaultConfig_MACOSX マクロをご利用ください。
参照:
CriAtomConfig_MACOSX
#define criAtomEx_SetDefaultConfig_MACOSX (   p_config)
値:
{                                                           \
    criAtomEx_SetDefaultConfig(&(p_config)->atom_ex);       \
    criAtomExAsr_SetDefaultConfig(&(p_config)->asr);        \
    criAtomExHcaMx_SetDefaultConfig(&(p_config)->hca_mx);   \
}

ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

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

関数

CriSint32 CRIAPI criAtom_CalculateWorkSize_MACOSX ( const CriAtomConfig_MACOSX config)

ライブラリ初期化用ワーク領域サイズの計算

引数:
[in]config初期化用コンフィグ構造体
戻り値:
CriSint32 ワーク領域サイズ
説明:
ライブラリを使用するために必要な、ワーク領域のサイズを取得します。
備考:
ライブラリが必要とするワーク領域のサイズは、ライブラリ初期化用コンフィグ 構造体( CriAtomConfig_MACOSX )の内容によって変化します。

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_CalculateWorkSize_MACOSX 関数をご利用ください。
参照:
CriAtomConfig_MACOSX, criAtom_Initialize_MACOSX
void CRIAPI criAtom_Initialize_MACOSX ( const CriAtomConfig_MACOSX config,
void *  work,
CriSint32  work_size 
)

ライブラリの初期化

引数:
[in]config初期化用コンフィグ構造体
[in]workワーク領域
[in]work_sizeワーク領域サイズ
説明:
ライブラリを初期化します。
ライブラリの機能を利用するには、必ずこの関数を実行する必要があります。
(ライブラリの機能は、本関数を実行後、 criAtom_Finalize_MACOSX 関数を実行するまでの間、 利用可能です。)

ライブラリを初期化する際には、ライブラリが内部で利用するためのメモリ領域(ワーク領域) を確保する必要があります。
ライブラリが必要とするワーク領域のサイズは、初期化用コンフィグ構造体の内容に応じて 変化します。
ワーク領域サイズの計算には、 criAtom_CalculateWorkSize_MACOSX 関数を使用してください。
備考:
criAtom_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
( work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。)
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

本関数を実行後、必ず対になる criAtom_Finalize_MACOSX 関数を実行してください。
また、 criAtom_Finalize_MACOSX 関数を実行するまでは、本関数を再度実行しないでください。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_Initialize_MACOSX 関数をご利用ください。
参照:
CriAtomConfig_MACOSX, criAtom_Finalize_MACOSX, criAtom_SetUserAllocator, criAtom_CalculateWorkSize_MACOSX
void CRIAPI criAtom_Finalize_MACOSX ( void  )

ライブラリの終了

説明:
ライブラリを終了します。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

criAtom_Initialize_MACOSX 関数実行前に本関数を実行することはできません。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_Finalize_MACOSX 関数をご利用ください。
参照:
criAtom_Initialize_MACOSX
void CRIAPI criAtom_SetServerThreadPriority_MACOSX ( int  prio)

サーバスレッドプライオリティの設定

引数:
[in]prioスレッドのプライオリティ
説明:
CRIサーバスレッドのプライオリティを設定します。
引数 prio は pthread のプライオリティ設定値として使用します。
指定できる値の範囲は通常 -16〜99で、数字が大きい方が優先度が高くなります。
アプリケーションのメインスレッド(0)よりも高いプライオリティを指定してください。
プライオリティのデフォルト値は10です。
注意:
criAtom_Initialize_MACOSX 関数実行前に本関数を実行することはできません。

サーバ処理スレッドは、CRI File Systemライブラリでも利用されています。
すでにCRI File SystemライブラリのAPIでサーバ処理スレッドの設定を変更している場合 本関数により設定が上書きされますのでご注意ください。
CriSint32 CRIAPI criAtomEx_CalculateWorkSize_MACOSX ( const CriAtomExConfig_MACOSX config)

ライブラリ初期化用ワーク領域サイズの計算

引数:
[in]config初期化用コンフィグ構造体
戻り値:
CriSint32 ワーク領域サイズ
説明:
ライブラリを使用するために必要な、ワーク領域のサイズを取得します。
備考:
ライブラリが必要とするワーク領域のサイズは、ライブラリ初期化用コンフィグ 構造体( CriAtomExConfig_MACOSX )の内容によって変化します。

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
CriAtomExConfig_MACOSX 構造体のacf_infoメンバに値を設定している場合、本関数は失敗し-1を返します。
初期化処理内でACFデータの登録を行う場合は、本関数値を使用したメモリ確保ではなくADX2システムによる メモリアロケータを使用したメモリ確保処理が必要になります。
参照:
CriAtomExConfig_MACOSX, criAtomEx_Initialize_MACOSX
void CRIAPI criAtomEx_Initialize_MACOSX ( const CriAtomExConfig_MACOSX config,
void *  work,
CriSint32  work_size 
)

ライブラリの初期化

引数:
[in]config初期化用コンフィグ構造体
[in]workワーク領域
[in]work_sizeワーク領域サイズ
説明:
ライブラリを初期化します。
ライブラリの機能を利用するには、必ずこの関数を実行する必要があります。
(ライブラリの機能は、本関数を実行後、 criAtomEx_Finalize_MACOSX 関数を実行するまでの間、 利用可能です。)

ライブラリを初期化する際には、ライブラリが内部で利用するためのメモリ領域(ワーク領域) を確保する必要があります。
ライブラリが必要とするワーク領域のサイズは、初期化用コンフィグ構造体の内容に応じて 変化します。
ワーク領域サイズの計算には、 criAtom_CalculateWorkSize_MACOSX 関数を使用してください。
備考:
criAtomEx_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
( work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。)
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

本関数を実行後、必ず対になる criAtomEx_Finalize_MACOSX 関数を実行してください。
また、 criAtomEx_Finalize_MACOSX 関数を実行するまでは、本関数を再度実行しないでください。
参照:
CriAtomExConfig_MACOSX, criAtomEx_Finalize_MACOSX, criAtomEx_SetUserAllocator, criAtomEx_CalculateWorkSize_MACOSX
void CRIAPI criAtomEx_Finalize_MACOSX ( void  )

ライブラリの終了

説明:
ライブラリを終了します。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

criAtomEx_Initialize_MACOSX 関数実行前に本関数を実行することはできません。
参照:
criAtomEx_Initialize_MACOSX
void CRIAPI criAtomEx_SetServerThreadPriority_MACOSX ( int  prio)

サーバスレッドプライオリティの設定

引数:
[in]prioスレッドのプライオリティ
説明:
CRIサーバスレッドのプライオリティを設定します。
引数 prio は pthread のプライオリティ設定値として使用します。
指定できる値の範囲は通常 -16〜99で、数字が大きい方が優先度が高くなります。
アプリケーションのメインスレッド(0)よりも高いプライオリティを指定してください。
プライオリティのデフォルト値は10です。
注意:
criAtomEx_Initialize_MACOSX 関数実行前に本関数を実行することはできません。

サーバ処理スレッドは、CRI File Systemライブラリでも利用されています。
すでにCRI File SystemライブラリのAPIでサーバ処理スレッドの設定を変更している場合 本関数により設定が上書きされますのでご注意ください。

CRI Middleware logo Copyright (c) 2012-2018 CRI Middleware Co., Ltd. CRI ADX2 LE マニュアル (for Cocos2d-x) SDKVer.2.10版