IDCompositionVisual::SetOffsetY(float)-Methode (dcomp.h)

Ändert den Wert der OffsetY-Eigenschaft dieses Visuals. Die OffsetY-Eigenschaft gibt den neuen Offset des Visuals entlang der y-Achse relativ zum übergeordneten Visual an.

Syntax

HRESULT SetOffsetY(
  [in] float offsetY
);

Parameter

[in] offsetY

Typ: float

Der neue Offset des Visuals entlang der y-Achse in Pixel.

Rückgabewert

Typ: HRESULT

Wenn die Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben. Eine Liste der Fehlercodes finden Sie unter DirectComposition-Fehlercodes .

Hinweise

Diese Methode schlägt fehl, wenn der OffsetY-Parameter NaN, positive Unendlichkeit oder negative Unendlichkeit ist.

Wenn Sie die OffsetY-Eigenschaft ändern, wird das Koordinatensystem der gesamten visuellen Unterstruktur transformiert, die in diesem Visual verwurzelt ist. Wenn die Clip-Eigenschaft dieses Visuals angegeben ist, wird auch das Cliprechteck transformiert.

Eine Transformation, die von der Transform-Eigenschaft angegeben wird, wird nach der OffsetY-Eigenschaft angewendet. Anders ausgedrückt: Die Auswirkung des Festlegens der Transform-Eigenschaft und der OffsetY-Eigenschaft entspricht dem Festlegen der Transform-Eigenschaft für ein Transformationsgruppenobjekt, bei dem das erste Mitglied der Gruppe ein IDCompositionTranslateTransform-Objekt ist, das den gleichen OffsetY-Wert wie offsetY aufweist. Sie sollten idCompositionVisual::SetOffsetY jedoch nach Möglichkeit verwenden, da es etwas schneller ist.

Wenn die Eigenschaften OffsetX und OffsetY auf 0 und die Transform-Eigenschaft auf NULL festgelegt sind, ist das Koordinatensystem des Visuals mit dem des übergeordneten Elements identisch.

Wenn die OffsetY-Eigenschaft zuvor animiert wurde, entfernt diese Methode die Animation und legt die Eigenschaft auf den angegebenen statischen Wert fest.

Beispiele

Ein Beispiel finden Sie unter Erstellen einer einfachen visuellen Struktur.

Anforderungen

Weitere Informationen

IDCompositionVisual

IDCompositionVisual::SetOffsetX

IDCompositionVisual::SetTransform