Метод IDCompositionVisual::SetClip(constD2D_RECT_F&) (dcomp.h)
Задает для свойства Clip этого визуального элемента указанный прямоугольник. Свойство Clip ограничивает отрисовку поддеревьев визуального элемента, которое коренится в этом визуальном элементе, заданной прямоугольной областью.
Синтаксис
HRESULT SetClip(
[in, ref] const D2D_RECT_F & rect
);
Параметры
[in, ref] rect
Тип: const D2D_RECT_F
Прямоугольник, используемый для обрезки этого визуального элемента. Все свойства параметра rect имеют числовое ограничение от -2^21 до 2^21. API принимает числа за пределами этого диапазона, но они всегда зажаты в этом диапазоне.
Возвращаемое значение
Тип: HRESULT
Если функция выполняется успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT . Список кодов ошибок см. в разделе Коды ошибок DirectComposition .
Комментарии
Задание свойства Клип обрезает этот визуальный элемент вместе со всеми визуальными элементами в поддереве, которое является корнем этого визуального элемента. Клип преобразуется с помощью свойств OffsetX, OffsetY и Transform.
Если в свойстве Clip ранее указан объект клипа, новый прямоугольник клипа заменяет объект клипа.
Этот метод завершается ошибкой, если какие-либо элементы структуры прямоугольника имеют значение NaN, положительная бесконечность или отрицательная бесконечность.
Если прямоугольник клипа пуст, визуальный элемент полностью обрезается; то есть визуальный элемент включается в визуальное дерево, но ничего не отображается. Чтобы исключить определенный визуальный элемент из композиции, удалите визуальный элемент из визуального дерева вместо задания пустого прямоугольника клипа. Удаление визуального элемента приводит к повышению производительности.
Требования
| Минимальная версия клиента | Windows 8 [только классические приложения] |
| Минимальная версия сервера | Windows Server 2012 [только классические приложения] |
| Целевая платформа | Windows |
| Header | dcomp.h |
| Библиотека | Dcomp.lib |
| DLL | Dcomp.dll |