PD2D1_PROPERTY_GET_FUNCTION function pointer

Gets a property from an effect.

Syntax


typedef HRESULT ( CALLBACK *PD2D1_PROPERTY_GET_FUNCTION)(
  _In_      const IUnknown *effect,
  _Out_           BYTE     *data,
                  UINT32   dataSize,
  _Out_opt_       UINT32   *actualSize
);

Parameters

effect [in]

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

data [out]

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.

actualSize [out, optional]

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

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

D2d1effectauthor.h

See also

D2D1_PROPERTY_BINDING

 

 

Show: