既定の画像領域確保時のオプション [初期値:0、範囲:0=既定の動作,1=DIB を使用しない]

Namespace: FVIL
Assembly: FVILbasic (in FVILbasic.dll) Version: 3.1.0.0 (3.1.0.17)

Syntax

C#
public static int DefaultAllocateOption { get; set; }
Visual Basic
Public Shared Property DefaultAllocateOption As Integer
	Get
	Set

Return Value

Type: Int32

画像オブジェクトの確保を行う際のオプションの既定値の設定または取得を行います。
この値は、ライブラリ内で共有しますのでアプリケーション起動時に１度設定するだけで構いません。

Remarks

このプロパティで設定された値が、インスタンスメンバ DefaultAllocateOption の既定値となります。 詳しくは DefaultAllocateOption の説明をご参照ください。

この他、画像オブジェクト(CFviImage、CFviPattern) のコンストラクタや SetSize の alloc_option 引数の既定値としても使用されます。 具体的なコードについては、後述のサンプルコードをご参照ください。


許容値：

値意味
0既定の動作
1DIB を使用しない

設定に失敗した場合は例外を発行します。 例外の原因と発生位置を特定するには、発行された例外クラスの ErrorCode メンバと Function メンバを参照してください。

エラーコード：

値ErrorCode メンバ内容
11FVIL.ErrorCode.INVALID_PARAMETER 指定された値が不正です。

Examples

サンプルコード:

下記のようにアプリケーション起動時に DefaultAllocateOption に 1 を指定した後、 alloc_option を省略して画像オブジェクトの確保を行った場合は、 alloc_option に 1 を指定した場合と同様の動作になります。

C# Copy imageCopy
static void Main()
{
    FVIL._SetUp.InitVisionLibrary();
    FVIL.CFviObject.DefaultAllocateOption = 1;

    Test1();
    Test2();
}

static void Test1()
{
    FVIL.Data.CFviImage    image_d = new FVIL.Data.CFviImage(640, 480, FVIL.ImageType.RGB32, 1);
    FVIL.Data.CFviImage    image_0 = new FVIL.Data.CFviImage(640, 480, FVIL.ImageType.RGB32, 1, 0);
    FVIL.Data.CFviImage    image_1 = new FVIL.Data.CFviImage(640, 480, FVIL.ImageType.RGB32, 1, 1);

    // image_d と image_1 は DIB を使用しない.
    // image_0 は DIB を使用する.
}

static void Test2()
{
    FVIL.Data.CFviImage    image_d = new FVIL.Data.CFviImage();
    FVIL.Data.CFviImage    image_0 = new FVIL.Data.CFviImage();
    FVIL.Data.CFviImage    image_1 = new FVIL.Data.CFviImage();
    image_d.SetSize(640, 480, FVIL.ImageType.RGB32, 1);
    image_0.SetSize(640, 480, FVIL.ImageType.RGB32, 1, 0);
    image_1.SetSize(640, 480, FVIL.ImageType.RGB32, 1, 1);

    // image_d と image_1 は DIB を使用しない.
    // image_0 は DIB を使用する.
}

Exceptions

ExceptionCondition
FVIL..::..CFviExceptionこの例外の原因については、上記のエラーコード表をご参照ください。

See Also