Metodo IDCompositionVisual::SetOffsetY(float) (dcomp.h)

Modifica il valore della proprietà OffsetY di questo oggetto visivo. La proprietà OffsetY specifica il nuovo offset dell'oggetto visivo lungo l'asse y, rispetto all'oggetto visivo padre.

Sintassi

HRESULT SetOffsetY(
  [in] float offsetY
);

Parametri

[in] offsetY

Tipo: float

Nuova offset dell'oggetto visivo lungo l'asse y, in pixel.

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

Questo metodo ha esito negativo se il parametro offsetY è NaN, infinito positivo o infinito negativo.

La modifica della proprietà OffsetY trasforma il sistema di coordinate dell'intero sottoalbero visivo radicato in questo oggetto visivo. Se viene specificata la proprietà Clip di questo oggetto visivo, viene trasformato anche il rettangolo di clip.

Una trasformazione specificata dalla proprietà Transform viene applicata dopo la proprietà OffsetY. In altre parole, l'effetto dell'impostazione della proprietà Transform e della proprietà OffsetY corrisponde all'impostazione solo della proprietà Transform in un oggetto gruppo di trasformazione in cui il primo membro del gruppo è un oggetto IDCompositionTranslateTranslateTransform con lo stesso valore OffsetY di offsetY. Tuttavia, è consigliabile usare IDCompositionVisual::SetOffsetY ogni volta che è possibile perché è leggermente più veloce.

Se le proprietà OffsetX e OffsetY sono impostate su 0 e la proprietà Transform è impostata su NULL, il sistema di coordinate dell'oggetto visivo è uguale a quello del relativo padre.

Se la proprietà OffsetY è stata animata in precedenza, questo metodo rimuove l'animazione e imposta la proprietà sul valore statico specificato.

Esempio

Per un esempio, vedere Come creare un albero visivo semplice.

Requisiti

Vedi anche

IDCompositionVisual

IDCompositionVisual::SetOffsetX

IDCompositionVisual::SetTransform