Class CriAtomExMonitor

CriAtomExMonitor API

Inheritance
object
CriAtomExMonitor
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public static class CriAtomExMonitor

Properties

DataUpdateNotificationCallback

コールバックイベントオブジェクト

Declaration
public static CriAtomExMonitor.DataUpdateNotificationCbFunc DataUpdateNotificationCallback { get; }
Property Value
Type Description
CriAtomExMonitor.DataUpdateNotificationCbFunc
See Also

LogCallback

コールバックイベントオブジェクト

Declaration
public static CriAtomExMonitor.LogCbFunc LogCallback { get; }
Property Value
Type Description
CriAtomExMonitor.LogCbFunc
See Also

Methods

CalculateWorkSize(in Config)

モニター機能初期化用ワーク領域サイズの計算

Declaration
public static int CalculateWorkSize(in CriAtomExMonitor.Config config)
Parameters
Type Name Description
CriAtomExMonitor.Config config

初期化用コンフィグ構造体
Returns
Type Description
int

ワーク領域サイズ
Remarks

説明: モニター機能を使用するために必要な、ワーク領域のサイズを取得します。 ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考: モニター機能が必要とするワーク領域のサイズは、モニター機能初期化用コンフィグ 構造体（ CriAtomExMonitor.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

See Also

Finalize()

モニター機能の終了

Declaration
public static void Finalize()
Remarks

説明: モニター機能を終了します。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

GetClientIpString()

クライアントIPアドレス文字列の取得

Declaration
public static NativeString GetClientIpString()
Returns
Type Description
NativeString
Remarks

説明: クライアントIPアドレス文字列を取得します。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

GetServerIpString()

サーバーIPアドレス文字列の取得

Declaration
public static NativeString GetServerIpString()
Returns
Type Description
NativeString
Remarks

説明: サーバーIPアドレス文字列を取得します。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

Initialize(in Config, IntPtr, int)

モニター機能の初期化

Declaration
public static void Initialize(in CriAtomExMonitor.Config config, IntPtr work = default, int workSize = 0)
Parameters
Type Name Description
CriAtomExMonitor.Config config

初期化用コンフィグ構造体
IntPtr work

ワーク領域
int workSize

ワーク領域サイズ
Remarks

説明: モニター機能を初期化します。 モニター機能を利用するには、必ずこの関数を実行する必要があります。 （モニター機能は、本関数を実行後、 Finalize() 関数を実行するまでの間、 利用可能です。） 本関数の呼び出しは、Initialize(in Config, IntPtr, int) 関数実行後 Finalize() 関数を実行するまでの間に 行うようにしてください。

See Also

IsConnected()

ツール接続状態の取得

Declaration
public static bool IsConnected()
Returns
Type Description
bool

接続状態（true:接続、false:未接続）
Remarks

説明: Craft 接続状態を取得します。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

IsConnectedToProfiler()

プロファイラー接続状態の取得

Declaration
public static bool IsConnectedToProfiler()
Returns
Type Description
bool

接続状態（true:接続、false:未接続）
Remarks

説明: プロファイラー接続状態を取得します。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

OutputUserLog(ArgString)

ユーザログの出力

Declaration
public static void OutputUserLog(ArgString message)
Parameters
Type Name Description
ArgString message

ユーザログメッセージ
Remarks

説明: ユーザログを出力します。 本関数によって出力したログはログ取得コールバックやプロファイラで取得、確認が行えます。

See Also

SetDataUpdateNotificationCallback(delegate* unmanaged[Cdecl]<IntPtr, DataUpdateNotificationInfo*, void>, IntPtr)

データ更新通知コールバック関数の登録

Declaration
public static void SetDataUpdateNotificationCallback(delegate* unmanaged[Cdecl]<IntPtr, CriAtomExMonitor.DataUpdateNotificationInfo*, void> func, IntPtr obj)
Parameters
Type Name Description
delegate* unmanaged[Cdecl]<IntPtr, DataUpdateNotificationInfo*, void> func

データ更新通知コールバック関数
IntPtr obj

ユーザ指定オブジェクト
Remarks

説明: インゲームプレビュー時にオーサリングツールからのデータ更新処理が発生した場合に呼び出すコールバック関数を登録します。

注意: コールバック関数内で、AtomライブラリのAPIを実行しないでください。 コールバック関数はAtomMonitorライブラリ内のサーバ処理からも実行されます。 そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。 コールバック関数内で長時間処理をブロックすると、音切れ等の問題 が発生しますので、ご注意ください。 コールバック関数は1つしか登録できません。 登録操作を複数回行った場合、既に登録済みのコールバック関数が、 後から登録したコールバック関数により上書きされてしまいます。 funcにnullを指定するとことで登録済み関数の登録解除が行えます。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

SetDefaultConfig(out Config)

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

Declaration
public static void SetDefaultConfig(out CriAtomExMonitor.Config pConfig)
Parameters
Type Name Description
CriAtomExMonitor.Config pConfig

コンフィグ
Remarks

説明: Initialize(in Config, IntPtr, int) 関数に設定するコンフィグ構造体 （ CriAtomExMonitor.Config ）に、デフォルト値をセットします。

See Also

SetLogCallback(delegate* unmanaged[Cdecl]<IntPtr, NativeString, void>, IntPtr)

ログ取得コールバックの登録

Declaration
public static void SetLogCallback(delegate* unmanaged[Cdecl]<IntPtr, NativeString, void> cbf, IntPtr obj)
Parameters
Type Name Description
delegate* unmanaged[Cdecl]<IntPtr, NativeString, void> cbf

コールバック関数
IntPtr obj

ユーザ指定オブジェクト
Remarks

説明: ログ取得用コールバック関数を登録します。 関数を登録するとログ取得を開始し、nullを設定することでログ取得を停止します。 取得するログのモード切替は SetLogMode(uint) 関数で設定指定ください。

注意: Initialize(in Config, IntPtr, int) 関数実行前に本関数を実行することはできません。

See Also

SetLogMode(uint)

ログモードの設定

Declaration
public static void SetLogMode(uint mode)
Parameters
Type Name Description
uint mode

ログ出力モード
Remarks

説明: ログ取得のモードを設定します。 本関数で設定したモードにしたがって SetLogCallback(delegate* unmanaged[Cdecl]<IntPtr, NativeString, void>, IntPtr) 関数で 登録したログ取得用コールバック関数が呼び出されます。

See Also