ID2D1Factory1::GetEffectProperties method
Retrieves the properties of an effect.
Syntax
HRESULT GetEffectProperties( [in] REFCLSID effectId, [out] ID2D1Properties **properties ) const;
Parameters
- effectId [in]
-
Type: REFCLSID
The ID of the effect to retrieve properties from.
- properties [out]
-
Type: ID2D1Properties**
When this method returns, contains the address of a pointer to the property interface that can be used to query the metadata of the effect.
Return value
Type: HRESULT
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| HRESULT | Description |
|---|---|
| S_OK | No error occurred. |
| D2DERR_EFFECT_IS_NOT_REGISTERED | The requested effect could not be found. |
| E_OUTOFMEMORY | Direct2D could not allocate sufficient memory to complete the call. |
Remarks
The returned effect properties will have all the mutable properties for the effect set to a default of NULL, or an empty value.
- Value types will be zero-filled.
- Blob and string types will be zero-length.
- Array types will have length 1 and the element of the array will conform to the previous rules.
This method cannot be used to return the properties for any effect not visible to ID2D1DeviceContext::CreateEffect.
Requirements
|
Minimum supported client |
Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps] |
|
Minimum supported phone |
Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also