# Methods¶

## set()¶

Converts the input image to grayscale. The value of 'amount' defines the proportion of the conversion. A value of 100% is completely grayscale. A value of 0% leaves the input unchanged. Values between 0% and 100% are linear multipliers on the effect. If the 'amount' parameter is missing, a value of 100% is used.

## set()¶

Saturates the input image. The value of 'amount' defines the proportion of the conversion. A value of 0% is completely un-saturated. A value of 100% leaves the input unchanged. Other values are linear multipliers on the effect. Values of amount over 100% are allowed, providing super-saturated results. If the 'amount' parameter is missing, a value of 100% is used.

## set()¶

Applies a Gaussian blur to the DOM element. The value of 'radius' defines the value of the standard deviation to the Gaussian function, or how many pixels on the screen blend into each other, so a larger value will create more blur. If no parameter is provided, then a value 0 is used. The parameter is specified as a CSS length, but does not accept percentage values.

## set()¶

Inverts the samples in the input image. The value of 'amount' defines the proportion of the conversion. A value of 100% is completely inverted. A value of 0% leaves the input unchanged. Values between 0% and 100% are linear multipliers on the effect. If the 'amount' parameter is missing, a value of 100% is used.

## set()¶

Applies a hue rotation on the input image. The value of 'angle' defines the number of degrees around the color circle the input samples will be adjusted. A value of 0deg leaves the input unchanged. If the 'angle' parameter is missing, a value of 0deg is used. Maximum value is 360deg.

## set()¶

Adjusts the contrast of the input. A value of 0% will create an image that is completely black. A value of 100% leaves the input unchanged. Values of amount over 100% are allowed, providing results with less contrast. If the 'amount' parameter is missing, a value of 100% is used.

## set()¶

Applies a linear multiplier to input image, making it appear more or less bright. A value of 0% will create an image that is completely black. A value of 100% leaves the input unchanged. Other values are linear multipliers on the effect. Values of an amount over 100% are allowed, providing brighter results. If the 'amount' parameter is missing, a value of 100% is used.

## set()¶

Converts the input image to sepia. The value of 'amount' defines the proportion of the conversion. A value of 100% is completely sepia. A value of 0 leaves the input unchanged. Values between 0% and 100% are linear multipliers on the effect. If the 'amount' parameter is missing, a value of 100% is used.

## set()¶

Applies transparency to the samples in the input image. The value of 'amount' defines the proportion of the conversion. A value of 0% is completely transparent. A value of 100% leaves the input unchanged. Values between 0% and 100% are linear multipliers on the effect. This is equivalent to multiplying the input image samples by amount. If the 'amount' parameter is missing, a value of 100% is used. This function is similar to the more established opacity property; the difference is that with filters, some browsers provide hardware acceleration for better performance.

# Type Definitions¶

## DisplayObject¶

A display object is any object that can be rendered in the Phaser/pixi.js scene graph.

This includes Phaser.Group (groups are displayobjects!), Phaser.Sprite, Phaser.Button, Phaser.Text as well as PIXI.DisplayObject and all derived types.

Source - core/Group.js, line 3102