Class CriAtomEx3dRegion
3Dリージョンオブジェクト
Implements
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public class CriAtomEx3dRegion : IDisposableRemarks
説明: 3Dリージョンを扱うためのオブジェクトです。 3Dトランシーバー機能に使用します。
Constructors
CriAtomEx3dRegion(in Config, IntPtr, int)
3Dリージョンオブジェクトの作成
Declaration
public CriAtomEx3dRegion(in CriAtomEx3dRegion.Config config, IntPtr work = default, int workSize = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomEx3dRegion.Config | config | 3Dリージョンオブジェクト作成用コンフィグ構造体へのポインタ |
| IntPtr | work | 3Dリージョンオブジェクト作成用ワーク領域へのポインタ |
| int | workSize | 3Dリージョンオブジェクト作成用ワークサイズ |
Remarks
説明: 3Dリージョンオブジェクト作成用コンフィグに基づいて、3Dリージョンオブジェクトを作成します。 作成に成功すると、3Dリージョンオブジェクトを返します。 3Dリージョンオブジェクトを作成する際には、ワーク領域としてメモリを渡す必要があります。 必要なメモリのサイズは、 CalculateWorkSize(in Config) 関数で計算します。 （SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドを使用してアロケーターを登録済みの場合、 本関数にワーク領域を指定する必要はありません。）
注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。
See Also
CriAtomEx3dRegion(IntPtr, int)
デフォルト設定でのインスタンス作成
Declaration
public CriAtomEx3dRegion(IntPtr work = default, int workSize = 0)Parameters
| Type | Name | Description |
|---|---|---|
| IntPtr | work | |
| int | workSize |
Properties
NativeHandle
ネイティブハンドル
Declaration
public NativeHandleIntPtr NativeHandle { get; }Property Value
| Type | Description |
|---|---|
| NativeHandleIntPtr |
Methods
CalculateWorkSize(in Config)
3Dリージョンオブジェクトの作成に必要なワーク領域サイズの計算
Declaration
public static int CalculateWorkSize(in CriAtomEx3dRegion.Config config)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomEx3dRegion.Config | config | 3Dリージョンオブジェクト作成用コンフィグ構造体へのポインタ |
Returns
| Type | Description |
|---|---|
| int | 3Dリージョンオブジェクト作成用ワークサイズ |
Remarks
説明: 3Dリージョンオブジェクトを作成するために必要な、ワーク領域のサイズを取得します。 アロケーターを登録せずに3Dリージョンオブジェクトを作成する場合、 あらかじめ本関数で計算したワーク領域サイズ分のメモリを ワーク領域として CriAtomEx3dRegion(in Config, IntPtr, int) 関数にセットする必要があります。 3Dリージョンオブジェクトの作成に必要なワークメモリのサイズは、3Dリージョンオブジェクト作成用コンフィグ 構造体（ CriAtomEx3dRegion.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 ワーク領域サイズ計算時に失敗した場合、戻り値は -1 になります。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックの メッセージで確認可能です。
備考: 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
See Also
Dispose()
3Dリージョンオブジェクトの破棄
Declaration
public void Dispose()Remarks
説明: 3Dリージョンオブジェクトを破棄します。 本関数を実行した時点で、3Dリージョンオブジェクト作成時に確保されたリソースが全て解放されます。 また、引数に指定した3Dリージョンオブジェクトも無効になります。 3Dリージョンオブジェクトをセットした3D音源、3Dリスナー、3Dトランシーバーがある場合、 本関数を実行する前に、当該3Dリージョンを設定している全てのオブジェクトを破棄するか、 設定を外すようにしてください。
See Also
SetDefaultConfig(out Config)
3Dリージョンオブジェクト作成用コンフィグ構造体にデフォルト値をセット
Declaration
public static void SetDefaultConfig(out CriAtomEx3dRegion.Config pConfig)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomEx3dRegion.Config | pConfig | 3Dリージョンオブジェクト作成用コンフィグ構造体へのポインタ |
Remarks
説明: 3Dリージョンオブジェクト作成用コンフィグ構造体（ CriAtomEx3dRegion.Config ）に、デフォルトの値をセットします。