Метод IDCompositionVisual::SetOffsetY(float) (dcomp.h)

Изменяет значение свойства OffsetY этого визуального элемента. Свойство OffsetY указывает новое смещение визуального элемента вдоль оси Y относительно родительского визуального элемента.

Синтаксис

HRESULT SetOffsetY(
  [in] float offsetY
);

Параметры

[in] offsetY

Тип: float

Новое смещение визуального элемента вдоль оси Y в пикселях.

Возвращаемое значение

Тип: HRESULT

Если функция выполняется успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT . Список кодов ошибок см. в разделе Коды ошибок DirectComposition .

Комментарии

Этот метод завершается ошибкой, если параметр offsetY имеет значение NaN, положительная бесконечность или отрицательная бесконечность.

Изменение свойства OffsetY преобразует систему координат всего поддеревь визуального элемента, которое коренится в этом визуальном элементе. Если задано свойство Клип этого визуального элемента, прямоугольник клипа также преобразуется.

Преобразование, заданное свойством Transform, применяется после свойства OffsetY. Иными словами, результат задания свойств Transform и OffsetY совпадает с установкой только свойства Transform для объекта группы преобразования, где первым членом группы является объект IDCompositionTranslateTransform , имеющий то же значение OffsetY, что и offsetY. Однако по возможности следует использовать IDCompositionVisual::SetOffsetY , так как это немного быстрее.

Если для свойств OffsetX и OffsetY задано значение 0, а для свойства Transform задано значение NULL, система координат визуального элемента будет такая же, как и у его родительского элемента.

Если свойство OffsetY было ранее анимировано, этот метод удаляет анимацию и присваивает свойству указанное статическое значение.

Примеры

Пример см. в статье Создание простого визуального дерева.

Требования

См. также раздел

IDCompositionVisual

IDCompositionVisual::SetOffsetX

IDCompositionVisual::SetTransform