juce::GlowEffect Class Reference

A component effect that adds a coloured blur around the component's contents. More...

#include "juce_GlowEffect.h"

Inheritance diagram for juce::GlowEffect:

Public Member Functions
	GlowEffect ()
	Creates a default 'glow' effect.
	~GlowEffect () override
	Destructor.
void	setGlowProperties (float newRadius, Colour newColour, Point< int > offset={})
	Sets the glow's radius and colour.
void	applyEffect (Image &, Graphics &, float scaleFactor, float alpha) override
	Overridden to render the effect.
Public Member Functions inherited from juce::ImageEffectFilter
virtual	~ImageEffectFilter ()=default
	Destructor.

Detailed Description

A component effect that adds a coloured blur around the component's contents.

(This will only work on non-opaque components).

See also

Component::setComponentEffect, DropShadowEffect

@tags{Graphics}

Definition at line 39 of file juce_GlowEffect.h.

Constructor & Destructor Documentation

GlowEffect()

juce::GlowEffect::GlowEffect

(

)

Creates a default 'glow' effect.

To customise its appearance, use the setGlowProperties() method.

Definition at line 29 of file juce_GlowEffect.cpp.

~GlowEffect()

juce::GlowEffect::~GlowEffect ( )

override

Destructor.

Definition at line 30 of file juce_GlowEffect.cpp.

Member Function Documentation

applyEffect()

void juce::GlowEffect::applyEffect ( Image &  sourceImage, Graphics &  destContext, float  scaleFactor, float  alpha  )

overridevirtual

Overridden to render the effect.

The implementation of this method must use the image that is passed in as its source, and should render its output to the graphics context passed in.

Parameters

sourceImage	the image that the source component has just rendered with its paint() method. The image may or may not have an alpha channel, depending on whether the component is opaque.
destContext	the graphics context to use to draw the resultant image.
scaleFactor	a scale factor that has been applied to the image - e.g. if this is 2, then the image is actually scaled-up to twice the original resolution
alpha	the alpha with which to draw the resultant image to the target context

Implements juce::ImageEffectFilter.

Definition at line 39 of file juce_GlowEffect.cpp.

setGlowProperties()

void juce::GlowEffect::setGlowProperties	(	float	newRadius,
		Colour	newColour,
		Point< int >	offset = {}
	)

Sets the glow's radius and colour.

The radius is how large the blur should be, and the colour is used to render it (for a less intense glow, lower the colour's opacity).

Definition at line 32 of file juce_GlowEffect.cpp.

---

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

• juce_graphics/effects/juce_GlowEffect.h
• juce_graphics/effects/juce_GlowEffect.cpp