Shadow effect

Use the shadow effect to generate a shadow from the alpha channel of an image. The shadow is more opaque for higher alpha values and more transparent for lower alpha values. You can set the amount of blur and the color of the shadow.

The CLSID for this effect is CLSID_D2D1Shadow.

Example image

The example here shows the output of the shadow effect translated down and right with the source image composited over it in the original location. The shadow effect only outputs the shadow.

Before
The image before the effect.
After
The image after the transform.

 


ComPtr<ID2D1Effect> shadowEffect;
m_d2dContext->CreateEffect(CLSID_D2D1Shadow, &shadowEffect);

shadowEffect->SetInput(0, bitmap);

// Shadow is composited on top of a white surface to show opacity.
ComPtr<ID2D1Effect> floodEffect;
m_d2dContext->CreateEffect(CLSID_D2D1Flood, &floodEffect);

floodEffect->SetValue(D2D1_FLOOD_PROP_COLOR, D2D1::Vector4F(1.0f, 1.0f, 1.0f, 1.0f));

ComPtr<ID2D1Effect> affineTransformEffect;
m_d2dContext->CreateEffect(CLSID_D2D12DAffineTransform, &affineTransformEffect);

affineTransformEffect->SetInputEffect(0, shadowEffect.Get());

D2D1_MATRIX_3X2_F matrix = D2D1::Matrix3x2F::Translation(20, 20));

affineTransformEffect->SetValue(D2D1_2DAFFINETRANSFORM_PROP_TRANSFORM_MATRIX, matrix);

ComPtr<ID2D1Effect> compositeEffect;
m_d2dContext->CreateEffect(CLSID_D2D1Composite, &compositeEffect);

compositeEffect->SetInputEffect(0, floodEffect.Get());
compositeEffect->SetInputEffect(1, affineTransformEffect.Get());
compositeEffect->SetInput(2, bitmap);

m_d2dContext->BeginDraw();
m_d2dContext->DrawImage(compositeEffect.Get());
m_d2dContext->EndDraw();

Effect properties

Display name and index enumerationDescription

BlurStandardDeviation

D2D1_SHADOW_PROP_BLUR_STANDARD_DEVIATION

The amount of blur to be applied to the alpha channel of the image. You can compute the blur radius of the kernel by multiplying the standard deviation by 3. The units of both the standard deviation and blur radius are DIPs.

This property is the same as the Gaussian Blur standard deviation property.

The type is FLOAT.

The default value is 3.0f.

Color

D2D1_SHADOW_PROP_COLOR

The color of the drop shadow. This property is a D2D1_VECTOR_4F defined as: (R, G, B, A). You must specify this color in straight alpha.

The type is D2D1_VECTOR_4F.

The default value is {0.0f, 0.0f, 0.0f, 1.0f}.

Optimization

D2D1_SHADOW_PROP_OPTIMIZATION

The level of performance optimization.

The type is D2D1_SHADOW_OPTIMIZATION.

The default value is D2D1_SHADOW_OPTIMIZATION_BALANCED.

 

Optimization modes

NameDescription
D2D1_DIRECTIONALBLUR_OPTIMIZATION_SPEEDApplies internal optimizations such as pre-scaling at relatively small radii. Uses linear filtering.
D2D1_DIRECTIONALBLUR_OPTIMIZATION_BALANCEDUses the same optimization thresholds as Speed mode, but uses trilinear filtering.
D2D1_DIRECTIONALBLUR_OPTIMIZATION_QUALITYOnly uses internal optimizations with large blur radii, where approximations are less likely to be visible. Uses trilinear filtering.

 

Output bitmap

The size of the output bitmap is the size of the blur output. The amount the output bitmap growth relative to the original bitmap can be calculated using the following equation:

Output Bitmap Growth (X and Y) = BlurStandardDeviation (device-independent pixels (DIPs))*6*(User DPI)/96

The output increases equally in all direction, so for example if the size increases by 10 pixels in each direction, the upper left corner of the bitmap is located at (-5, -5) and the lower right will be at (105, 105) as shown in the diagram here.

Shadow effect output size growth diagram.

Requirements

Minimum supported clientWindows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]
Minimum supported serverWindows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]
Headerd2d1effects.h
Libraryd2d1.lib, dxguid.lib

 

Related topics

ID2D1Effect

 

 

Show: