Compartilhar via


Método IDCompositionVisual::SetClip(constD2D_RECT_F&) (dcomp.h)

Define a propriedade Clip desse visual como o retângulo especificado. A propriedade Clip restringe a renderização da subárvore visual com raiz nesse visual para a região retangular especificada.

Sintaxe

HRESULT SetClip(
  [in, ref] const D2D_RECT_F & rect
);

Parâmetros

[in, ref] rect

Tipo: const D2D_RECT_F

O retângulo a ser usado para recortar esse visual. Todas as propriedades do parâmetro rect 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.

Retornar valor

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 objeto clip, o retângulo de clipe recém-especificado substituirá o objeto clip.

Esse método falhará se algum membro da estrutura de rect for NaN, infinito positivo ou infinito negativo.

Se o retângulo do clipe estiver 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