IXREffect::GetCustomEffect (Compact 2013)

3/28/2014

This method retrieves a pointer to the class that applies a custom effect to an object in your application.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetCustomEffect(
    __out IXRCustomEffect** ppCustomEffect
) = 0;

Parameters

  • ppCustomEffect
    [out] Pointer to a pointer to the class that represents a custom effect that is applied to an object in your application. This class must derive from IXRCustomEffect, and is supplied by an OEM developer.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

Effects modify the appearance of UI elements, for example, by blurring an element or adding a drop shadow. Effects alter the individual pixels of a rasterized UI object by using an algorithm to alter how the pixels are displayed.

In XAML for Windows Embedded, effects are implemented by OEM developers who use graphics functionality specific to their platform. If an OEM developer has provided you with a header file (.h) for a custom effect, you can use that effect in your application. Use GetCustomEffect to get the custom effect from the IXREffect object. For more information about custom effects, see the Remarks section in IXREffect.

.NET Framework Equivalent

None.

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXREffect