PIXI.filters.DropShadowFilter

class DropShadowFilter extends PIXI.Filter

Drop shadow filter.
original filter

See:

Constructor

new PIXI.filters.DropShadowFilter(options: object) → {}

Parameters:
Name	Type	Attributes	Default	Description
options	object	<optional>		Filter options
options.rotation	number	<optional>	45	The angle of the shadow in degrees.
options.distance	number	<optional>	5	Distance of shadow
options.color	number	<optional>	0x000000	Color of the shadow
options.alpha	number	<optional>	0.5	Alpha of the shadow
options.shadowOnly	boolean	<optional>	false	Whether render shadow only
options.blur	number	<optional>	2	Sets the strength of the Blur properties simultaneously
options.quality	number	<optional>	3	The quality of the Blur filter.
options.kernels	Array<number>	<optional>	null	The kernels of the Blur filter.
options.pixelSize	number \| number<Array> \| PIXI.Point	<optional>	1	the pixelSize of the Blur filter.
options.resolution	number	<optional>	PIXI.settings.FILTER_RESOLUTION	The resolution of the Blur filter.

DropShadowFilterOptions	static defaults Default constructor options.
number	alpha = 1
number	angle = 45 Angle of the shadow in degrees.
number	blur = 2
number	color = 0x000000
number	distance = 5
number[]	kernels Sets the kernels of the Blur Filter
number \| number<Array> \| PIXI.Point	pixelSize = 1 Sets the pixelSize of the Kawase Blur filter
number	quality = 4
number	resolution = PIXI.settings.FILTER_RESOLUTION
number	rotation = 2
boolean	shadowOnly Hide the contents, only show the shadow.

boolean	autoFit = true
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
boolean	enabled If enabled is true the filter is applied, if false it will not.
boolean	legacy
PIXI.MSAA_QUALITY	multisample The samples of the filter.
number	padding
PIXI.State	state The WebGL state the filter requires to render.

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

void	apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES, _currentState: object)

defaults DropShadowFilter.ts:38

static defaults: DropShadowFilterOptions

Default constructor options.

alpha DropShadowFilter.ts:195

alpha: number = 1

The alpha of the shadow

angle DropShadowFilter.ts:55

angle: number = 45

Angle of the shadow in degrees.

blur DropShadowFilter.ts:233

blur: number = 2

The blur of the shadow

color DropShadowFilter.ts:208

color: number = 0x000000

The color of the shadow.

distance DropShadowFilter.ts:166

distance: number = 5

Distance offset of the shadow

kernels DropShadowFilter.ts:221

kernels: number[]

Sets the kernels of the Blur Filter

pixelSize DropShadowFilter.ts:260

pixelSize: number | number<Array> | PIXI.Point = 1

Sets the pixelSize of the Kawase Blur filter

quality DropShadowFilter.ts:247

quality: number = 4

Sets the quality of the Blur Filter

resolution DropShadowFilter.ts:144

resolution: number = PIXI.settings.FILTER_RESOLUTION

The resolution of the filter.

rotation DropShadowFilter.ts:181

rotation: number = 2

The angle of the shadow in degrees

shadowOnly DropShadowFilter.ts:52

shadowOnly: boolean

Hide the contents, only show the shadow.