ID2D1Effect

<summary> The effect interface. Properties control how the effect is rendered. The effect is Drawn with the DrawImage call. </summary>

interface ID2D1Effect : ID2D1Properties {

void SetInput(UINT32 index, ID2D1Image input, BOOL invalidate = TRUE);

HRESULT SetInputCount(UINT32 inputCount);

void GetInput(UINT32 index, ID2D1Image** input);

UINT32 GetInputCount();

void GetOutput(ID2D1Image* outputImage);

}

Members

Functions

GetInput
void GetInput(UINT32 index, ID2D1Image** input): <summary> Returns the input image to the effect. The input could be another effect or a bitmap. </summary>
GetInputCount UINT32 GetInputCount(): <summary> This returns the number of input that are bound into this effect. </summary>
GetOutput void GetOutput(ID2D1Image* outputImage): <summary> Returns the output image of the given effect. This can be set as the input to another effect or can be drawn with DrawImage. </summary>
SetInput void SetInput(UINT32 index, ID2D1Image input, BOOL invalidate = TRUE): <summary> Sets the input to the given effect. The input can be a concrete bitmap or the output of another effect. </summary>
SetInputCount HRESULT SetInputCount(UINT32 inputCount): <summary> If the effect supports a variable number of inputs, this sets the number of input that are currently active on the effect. </summary>

Inherited Members

From ID2D1Properties

GetPropertyCount UINT32 GetPropertyCount(): <summary> Returns the total number of custom properties in this interface. </summary>
GetPropertyName HRESULT GetPropertyName(UINT32 index, PWSTR name, UINT32 nameCount): <summary> Retrieves the property name from the given property index. </summary>
GetPropertyNameLength UINT32 GetPropertyNameLength(UINT32 index): <summary> Returns the length of the property name from the given index. </summary>
GetType D2D1_PROPERTY_TYPE GetType(UINT32 index): <summary> Retrieves the type of the given property. </summary>
GetPropertyIndex UINT32 GetPropertyIndex(PCWSTR name): <summary> Retrieves the property index for the given property name. </summary>
SetValueByName HRESULT SetValueByName(PCWSTR name, D2D1_PROPERTY_TYPE type, const(BYTE)* data, UINT32 dataSize): <summary> Sets the value of the given property using its name. </summary>
SetValue HRESULT SetValue(UINT32 index, D2D1_PROPERTY_TYPE type, const(BYTE)* data, UINT32 dataSize): <summary> Sets the given value using the property index. </summary>
GetValueByName HRESULT GetValueByName(PCWSTR name, D2D1_PROPERTY_TYPE type, BYTE* data, UINT32 dataSize): <summary> Retrieves the given property or sub-property by name. '.' is the delimiter for sub-properties. </summary>
GetValue HRESULT GetValue(UINT32 index, D2D1_PROPERTY_TYPE type, BYTE* data, UINT32 dataSize): <summary> Retrieves the given value by index. </summary>
GetValueSize UINT32 GetValueSize(UINT32 index): <summary> Returns the value size for the given property index. </summary>
GetSubProperties HRESULT GetSubProperties(UINT32 index, ID2D1Properties* subProperties): <summary> Retrieves the sub-properties of the given property by index. </summary>

ID2D1Effect

Members

Functions

Inherited Members

From ID2D1Properties

Meta

Source