Metodo IDCompositionVisual::SetClip(IDCompositionClip*) (dcomp.h)

Imposta la proprietà Clip di questo oggetto visivo sull'oggetto clip specificato. La proprietà Clip limita il rendering del sottoalbero visivo che è radicato in questo oggetto visivo in un'area rettangolare.

Sintassi

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

Parametri

[in, optional] clip

Tipo: IDCompositionClip*

Oggetto clip da associare a questo oggetto visivo. Questo parametro può essere NULL. Tutte le proprietà float di IDCompositionRectangleClip hanno un limite numerico di -2^21 a 2^21. L'API accetta numeri al di fuori di questo intervallo, ma sono sempre bloccati a questo intervallo.

Valore restituito

Tipo: HRESULT

Se la funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT . Per un elenco di codici di errore, vedere Codici di errore DirectComposition .

Commenti

L'impostazione della proprietà Clip clip questo oggetto visivo insieme a tutti gli oggetti visivi nel sottoalbero radicato in questo oggetto visivo. La clip viene trasformata dalle proprietà OffsetX, OffsetY e Transform.

Se la proprietà Clip ha specificato in precedenza un rettangolo di clip, l'oggetto Clip appena specificato sostituisce il rettangolo di clip.

Questo metodo ha esito negativo se clip è un puntatore non valido o se non è stato creato dalla stessa interfaccia IDCompositionDevice che ha creato questo oggetto visivo. L'interfaccia non può essere un'implementazione personalizzata; è possibile usare solo interfacce create da Microsoft DirectComposition con questo metodo.

Se clip è NULL, l'oggetto visivo non viene ritagliato rispetto al relativo elemento padre. Tuttavia, l'oggetto visivo viene ritagliato dall'oggetto clip dell'oggetto visivo padre o dall'oggetto visivo predecessore più vicino con un oggetto clip. L'impostazione di clip su NULL è simile a quella di specificare un oggetto clip il cui rettangolo clip ha i lati sinistro e superiore impostati su infinito negativo e i lati destro e inferiore impostati su infinito positivo. L'uso di un oggetto clip NULL comporta prestazioni leggermente migliori.

Se clip specifica un oggetto clip con un rettangolo vuoto, l'oggetto visivo viene completamente ritagliato; ovvero, l'oggetto visivo è incluso nell'albero visivo, ma non esegue il rendering di alcun elemento. Per escludere un oggetto visivo specifico da una composizione, rimuovere l'oggetto visivo dall'albero visivo anziché impostare un rettangolo di clip vuoto. Rimuovere i risultati visivi in prestazioni migliori.

Requisiti

Vedi anche

Ritaglio

IDCompositionRectangleClip

IDCompositionVisual