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

Establece la propiedad Clip de este objeto visual en el objeto clip especificado. La propiedad Clip restringe la representación del subárbol visual que se basa en este objeto visual en una región rectangular.

Sintaxis

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

Parámetros

[in, optional] clip

Tipo: IDCompositionClip*

Objeto clip que se va a asociar a este objeto visual. Este parámetro puede ser NULL. Todas las propiedades float de IDCompositionRectangleClip tienen un límite numérico de -2^21 a 2^21. La API acepta números fuera de este intervalo, pero siempre se fijan a este intervalo.

Valor devuelto

Tipo: HRESULT

Si la función se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT. Consulte Códigos de error de DirectComposition para obtener una lista de códigos de error.

Comentarios

Al establecer la propiedad Clip, este objeto visual se recorta junto con todos los objetos visuales del subárbol que se basa en este objeto visual. El clip se transforma mediante las propiedades OffsetX, OffsetY y Transform.

Si la propiedad Clip especificó previamente un rectángulo de clip, el objeto Clip recién especificado reemplaza el rectángulo de clip.

Este método produce un error si clip es un puntero no válido o si no lo creó la misma interfaz IDCompositionDevice que creó este objeto visual. La interfaz no puede ser una implementación personalizada; solo se pueden usar interfaces creadas por Microsoft DirectComposition con este método.

Si clip es NULL, el objeto visual no se recorta en relación con su elemento primario. Sin embargo, el objeto clip del objeto visual primario recorta el objeto visual principal o el objeto visual antecesor más cercano que tiene un objeto clip. Establecer clip en NULL es similar a especificar un objeto clip cuyo rectángulo de recorte tiene los lados izquierdo y superior establecidos en infinito negativo y los lados derecho e inferior establecidos en infinito positivo. El uso de un objeto clip NULL da como resultado un rendimiento ligeramente mejor.

Si clip especifica un objeto clip que tiene un rectángulo vacío, el objeto visual se recorta completamente; es decir, el objeto visual se incluye en el árbol visual, pero no representa nada. Para excluir un objeto visual determinado de una composición, quite el objeto visual del árbol visual en lugar de establecer un rectángulo de recorte vacío. La eliminación del objeto visual da como resultado un mejor rendimiento.

Requisitos

Cliente mínimo compatible	Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2012 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	dcomp.h
Library	Dcomp.lib
Archivo DLL	Dcomp.dll

Consulte también

Recorte

IDCompositionRectangleClip

IDCompositionVisual