Class ShadowStyle

Stores properties for applying a shadow to a canvas context. Can also be used to save & restore context shadow properties.

Index

Accessors

Constructors

Methods

resetCoordinates render saveContext restoreContext

Properties

color blur offset

Accessors

isEmpty

get isEmpty(): boolean
Returns true if blur and offset are are <= 0.

Returns boolean

Constructors

constructor

new ShadowStyle(init?: PartialDeep<ShadowStyle>): ShadowStyle
Parameters
- Optionalinit: PartialDeep<ShadowStyle>
Returns ShadowStyle

Methods

resetCoordinates

resetCoordinates(): void
Resets shadow coordinates to zero. Does not affect color.

Returns void

render

render(ctx: CanvasRenderingContext2D): void
Applies current shadow styling properties to the given canvas ctx.
Parameters
- ctx: CanvasRenderingContext2D
Returns void

saveContext

saveContext(ctx: CanvasRenderingContext2D): void
Saves the given context's shadow properties. See also restoreContext().
Parameters
- ctx: CanvasRenderingContext2D
Returns void

restoreContext

restoreContext(ctx: CanvasRenderingContext2D): void
Resets all shadow attributes on given context to the values saved with saveContext().
Parameters
- ctx: CanvasRenderingContext2D
Returns void

Properties

color

color: string = "#0000"

Shadow color.

blur

blur: number = 0

Shadow blur radius.

`Readonly`offset

offset: Vect2d = ...

Shadow offset coordinates.