Edit

Share via

PD2D1_PROPERTY_GET_FUNCTION callback function (d2d1effectauthor.h)

  • Article

Gets a property from an effect.

Syntax

PD2D1_PROPERTY_GET_FUNCTION Pd2d1PropertyGetFunction;

HRESULT Pd2d1PropertyGetFunction(
  [in]            const IUnknown *effect,
  [out]           BYTE *data,
                  UINT32 dataSize,
  [out, optional] UINT32 *actualSize
)
{...}

Parameters

[in] effect

A pointer to the IUnknown interface for the effect on which the property will be retrieved.

[out] data

A pointer to a variable that stores the data that this function retrieves on the property.

dataSize

The number of bytes in the property to retrieve.

[out, optional] actualSize

A optional pointer to a variable that stores the actual number of bytes retrieved on the property. If not used, set to NULL.

Return value

Returns S_OK if successful; otherwise, returns an HRESULT error code.

Remarks

Supply a PD2D1_PROPERTY_GET_FUNCTION to the getFunction member of a D2D1_PROPERTY_BINDING structure to specify the function that Direct2D uses to get data for a property.

Requirements

Requirement Value
Minimum supported client Windows 8 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header d2d1effectauthor.h

See also

D2D1_PROPERTY_BINDING