Metodo IDCompositionVisual::SetClip(constD2D_RECT_F&) (dcomp.h)

  • Articolo

Imposta la proprietà Clip di questo oggetto visivo sul rettangolo specificato. La proprietà Clip limita il rendering del sottoalbero visivo radicato in questo oggetto visivo nell'area rettangolare specificata.

Sintassi

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

Parametri

[in, ref] rect

Tipo: const D2D_RECT_F

Rettangolo da utilizzare per ritagliare questo oggetto visivo. Tutte le proprietà del parametro rect 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 ritaglia questo oggetto visivo insieme a tutti gli oggetti visivi nel sottoalbero che è radicato in questo oggetto visivo. Il clip viene trasformato dalle proprietà OffsetX, OffsetY e Transform.

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

Questo metodo ha esito negativo se uno dei membri della struttura del rect è NaN, infinito positivo o infinito negativo.

Se il rettangolo di ritaglio è vuoto, l'oggetto visivo viene completamente ritagliato; ovvero, l'oggetto visivo è incluso nella struttura ad albero visuale, ma non esegue il rendering di alcun elemento. Per escludere un particolare oggetto visivo da una composizione, rimuovere l'oggetto visivo dalla struttura ad albero visuale anziché impostare un rettangolo di ritaglio vuoto. La rimozione dell'oggetto visivo comporta prestazioni migliori.

Requisiti

   
Client minimo supportato Windows 8 [solo app desktop]
Server minimo supportato Windows Server 2012 [solo app desktop]
Piattaforma di destinazione Windows
Intestazione dcomp.h
Libreria Dcomp.lib
DLL Dcomp.dll

Vedi anche

Ritaglio

IDCompositionRectangleClip

IDCompositionVisual