CLIPOBJ_cEnumStart

CLIPOBJ_cEnumStart 関数は、指定したクリップ領域内の矩形を列挙するためのパラメータを設定する。

CLIPOBJ_cEnumStart pco, bAll, iType, iDirection, cLimit

pco : [var] 列挙対象のクリップ領域を定義する CLIPOBJ 構造体へのポインタ。
bAll : [int] 領域全体を列挙するかどうかを指定する。領域全体を列挙する場合は TRUE、現在の描画操作に関連する部分のみを列挙する場合は FALSE を指定する。クリップ領域をキャッシュするドライバは領域全体を列挙する必要がある。
iType : [int] CLIPOBJ_bEnum によって書き込まれるデータ構造を指定する。現在は CT_RECTANGLES のみ指定可能で、領域は矩形のリストとして列挙される。
iDirection : [int] 矩形を列挙する順序を決定する。同じサーフェス上で DrvBitBlt 操作が並行して実行される場合、この順序が重要になることがある。順序がデバイスドライバにとって重要でなければ、複雑な領域に対しては CD_ANY を指定して GDI に列挙の最適化を任せるべきである。次のいずれかを指定できる。
cLimit : [int] 列挙する矩形の最大数。0 を指定するとカウントは省略される。

(プラグイン / モジュール : gdi32.dll)

解説

CLIPOBJ_cEnumStart 関数は、指定したクリップ領域内の矩形を列挙するためのパラメータを設定する。

[戻り値]
戻り値は列挙される矩形の数となる。カウントが cLimit を超える場合、戻り値は 0xFFFFFFFF となる。

[備考]

この関数の呼び出しの有無に関係なく領域は列挙できる。デフォルトでは、ドライバは関連する矩形のみを左上から列挙する。再度この関数を呼ぶことで列挙を再開できる。

情報