CLIPOBJ_cEnumStart関数 (winddi.h)

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

構文

ENGAPI ULONG CLIPOBJ_cEnumStart(
  [in] CLIPOBJ *pco,
  [in] BOOL    bAll,
  [in] ULONG   iType,
  [in] ULONG   iDirection,
  [in] ULONG   cLimit
);

パラメーター

[in] pco

列挙するクリップ領域を定義する CLIPOBJ 構造体へのポインター。

[in] bAll

リージョン全体を列挙するかどうかを指定します。 リージョン全体を列挙する必要がある場合、このパラメーターは TRUE です。 現在の描画操作に関連する部分のみを列挙する必要がある場合は FALSE です。

クリップ領域をキャッシュするドライバーは、リージョン全体を列挙する必要があります。

[in] iType

CLIPOBJ_bEnumによって書き込まれるデータ構造を指定します。 このパラメーターは、現在、領域が四角形の一覧として列挙されることを示すCT_RECTANGLESする必要があります。

[in] iDirection

四角形を列挙する順序を決定します。 この順序は、 DrvBitBlt 操作が同じサーフェイスで同時に実行されている場合に不可欠な場合があります。 順序がデバイス ドライバーに関連しない場合は、複雑な領域にCD_ANYを指定して、GDI が列挙を最適化できるようにする必要があります。 この値は、次のいずれかです。

値	説明
CD_ANY	GDI に便利な任意の順序。
CD_LEFTDOWN	右から左、上から下へ。
CD_LEFTUP	右から左、下から上へ。
CD_RIGHTDOWN	左から右、上から下へ。
CD_RIGHTUP	左から右、下から上へ。

[in] cLimit

列挙する四角形の最大数を指定します。 このパラメーターが 0 の場合、カウントは省略されます。

戻り値

戻り値は、列挙された四角形の数です。 カウントが cLimit を超える場合、戻り値は0xFFFFFFFF。

解説

この関数が呼び出されるかどうかに関して、リージョンを列挙できます。 既定では、ドライバーは左上から関連する四角形のみを列挙します。

ドライバーは、この関数を再度呼び出すことによって列挙を再開できます。

要件

サポートされている最小のクライアント	Windows 2000 以降のバージョンの Windows オペレーティング システムで使用できます。
対象プラットフォーム	ユニバーサル
Header	winddi.h (Winddi.h を含む)
Library	Win32k.lib
[DLL]	Win32k.sys

関連項目

CLIPOBJ

CLIPOBJ_bEnum

DrvBitBlt