JUCE: DropShadowEffect Class Reference

JUCE

Public Member Functions | List of all members
DropShadowEffect Class Reference
juce_graphics » effects

An effect filter that adds a drop-shadow behind the image's content. More...

`#include <juce_DropShadowEffect.h>`

Inheritance diagram for DropShadowEffect:

## Public Member Functions
| DropShadowEffect ()
| Creates a default drop-shadow effect. More...
| ~DropShadowEffect () override
| Destructor. More...
void | setShadowProperties (const DropShadow &newShadow)
| Sets up parameters affecting the shadow's appearance. More...
void | applyEffect (Image &sourceImage, Graphics &destContext, float scaleFactor, float alpha) override
Public Member Functions inherited from ImageEffectFilter
virtual void | applyEffect (Image &sourceImage, Graphics &destContext, float scaleFactor, float alpha)=0
| Overridden to render the effect. More...
virtual | ~ImageEffectFilter ()=default
| Destructor. More...

## Detailed Description

An effect filter that adds a drop-shadow behind the image's content.

(This will only work on images/components that aren't opaque, of course).

When added to a component, this effect will draw a soft-edged shadow based on what gets drawn inside it. The shadow will also be applied to the component's children.

For speed, this doesn't use a proper gaussian blur, but cheats by using a simple bilinear filter. If you need a really high-quality shadow, check out ImageConvolutionKernel::createGaussianBlur()

See also
  Component::setComponentEffect

## Constructor & Destructor Documentation

## ◆ DropShadowEffect()

DropShadowEffect::DropShadowEffect | ( |  | ) |

Creates a default drop-shadow effect.

To customise the shadow's appearance, use the setShadowProperties() method.

## ◆ ~DropShadowEffect()

DropShadowEffect::~DropShadowEffect | ( |  | ) |
| override

Destructor.

## Member Function Documentation

## ◆ setShadowProperties()

void DropShadowEffect::setShadowProperties | ( | const DropShadow & | newShadow | ) |

Sets up parameters affecting the shadow's appearance.

## ◆ applyEffect()

void DropShadowEffect::applyEffect | ( | Image & | sourceImage,
|  | Graphics & | destContext,
|  | float | scaleFactor,
|  | float | alpha
| ) |  |
| overridevirtual

Implements ImageEffectFilter.

The documentation for this class was generated from the following file:

- juce_DropShadowEffect.h