Compartilhar via


Função CLIPOBJ_cEnumStart (winddi.h)

A função CLIPOBJ_cEnumStart define parâmetros para enumerar retângulos em uma região de clipe especificada.

Sintaxe

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

Parâmetros

[in] pco

Ponteiro para a estrutura CLIPOBJ que define a região do clipe a ser enumerada.

[in] bAll

Especifica se toda a região deve ser enumerada. Esse parâmetro será TRUE se toda a região deve ser enumerada. É FALSE se apenas as partes relevantes para a operação de desenho atual devem ser enumeradas.

Um driver que armazena em cache regiões de clipe deve enumerar toda a região.

[in] iType

Especifica as estruturas de dados que devem ser gravadas por CLIPOBJ_bEnum. Atualmente, esse parâmetro deve ser CT_RECTANGLES, indicando que a região deve ser enumerada como uma lista de retângulos.

[in] iDirection

Determina a ordem na qual os retângulos devem ser enumerados. Essa ordem pode ser essencial se uma operação DrvBitBlt estiver sendo executada simultaneamente na mesma superfície. Se a ordem não for relevante para o driver do dispositivo, CD_ANY deverá ser especificado para regiões complexas, permitindo que a GDI otimize a enumeração. Este valor pode ser um dos seguintes:

Valor Significado
CD_ANY Qualquer pedido conveniente para GDI.
CD_LEFTDOWN Da direita para a esquerda, de cima para baixo.
CD_LEFTUP Da direita para a esquerda, de baixo para cima.
CD_RIGHTDOWN Da esquerda para a direita, de cima para baixo.
CD_RIGHTUP Da esquerda para a direita, de baixo para cima.

[in] cLimit

Especifica o número máximo de retângulos a serem enumerados. Se esse parâmetro for zero, a contagem será omitida.

Valor retornado

O valor retornado é a contagem de retângulos enumerados. Se a contagem exceder cLimit, o valor retornado será 0xFFFFFFFF.

Comentários

Uma região pode ser enumerada se essa função for chamada. Por padrão, o driver enumera apenas retângulos relevantes, começando no canto superior esquerdo.

O driver pode reiniciar a enumeração chamando essa função novamente.

Requisitos

   
Cliente mínimo com suporte Disponível no Windows 2000 e versões posteriores dos sistemas operacionais Windows.
Plataforma de Destino Universal
Cabeçalho winddi.h (inclua Winddi.h)
Biblioteca Win32k.lib
DLL Win32k.sys

Confira também

CLIPOBJ

CLIPOBJ_bEnum

DrvBitBlt