Método IDCompositionVisual::SetClip(IDCompositionClip*) (dcomp.h)

Define a propriedade Clip desse visual como o objeto de clipe especificado. A propriedade Clip restringe a renderização da subárvore visual com raiz nesse visual para uma região retangular.

Sintaxe

HRESULT SetClip(
  [in, optional] IDCompositionClip *clip
);

Parâmetros

[in, optional] clip

Tipo: IDCompositionClip*

O objeto de clipe a ser associado a esse visual. Este parâmetro pode ser NULL. Todas as propriedades float de IDCompositionRectangleClip têm um limite numérico de -2^21 a 2^21. A API aceita números fora desse intervalo, mas eles são sempre vinculados a esse intervalo.

Valor retornado

Tipo: HRESULT

Se a função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT. Confira Códigos de erro do DirectComposition para obter uma lista de códigos de erro.

Comentários

Definir a propriedade Clip corta esse visual junto com todos os visuais na subárvore que tem raiz nesse visual. O clipe é transformado pelas propriedades OffsetX, OffsetY e Transform.

Se a propriedade Clip tiver especificado anteriormente um retângulo de clipe, o objeto Clip recém-especificado substituirá o retângulo de clipe.

Esse método falhará se clip for um ponteiro inválido ou se não tiver sido criado pela mesma interface IDCompositionDevice que criou esse visual. A interface não pode ser uma implementação personalizada; somente interfaces criadas pelo Microsoft DirectComposition podem ser usadas com esse método.

Se clip for NULL, o visual não será recortado em relação ao pai. No entanto, o visual é recortado pelo objeto de clipe do visual pai ou pelo visual ancestral mais próximo que tem um objeto clip. Definir o clipe como NULL é semelhante a especificar um objeto de clipe cujo retângulo de clipe tem os lados esquerdo e superior definidos como infinito negativo e os lados direito e inferior definidos como infinito positivo. O uso de um objeto de clipe NULL resulta em um desempenho ligeiramente melhor.

Se clip especificar um objeto de clipe que tenha um retângulo vazio, o visual será totalmente recortado; ou seja, o visual está incluído na árvore visual, mas não renderiza nada. Para excluir um visual específico de uma composição, remova o visual da árvore visual em vez de definir um retângulo de clipe vazio. Remover o visual resulta em um melhor desempenho.

Requisitos

Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	dcomp.h
Biblioteca	Dcomp.lib
DLL	Dcomp.dll

Confira também

Recortando

IDCompositionRectangleClip

IDCompositionVisual