<commit_before>import {vertex} from '@tools/fragments';
import fragment from './adjustment.frag';

/**
 * The AdjustmentFilter to adjust gamma/contrast/saturation/brightness.
.<br>
 * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/adjustment.gif)
 *
 * @class
 * @extends PIXI.Filter
 * @memberof PIXI.filters
 *
 * @param {object|number} [options] - The optional parameters of old film effect.
 *                        When options is a number , it will be `seed`
 * @param {number} [options.sepia=0.3] - The amount of saturation of sepia effect,
 *        a value of `1` is more saturation and closer to `0` is less, and a value of
 *        `0` produces no sepia effect
 * @param {number} [options.noise=0.3] - Opacity/intensity of the noise effect between `0` and `1`
 * @param {number} [options.noiseSize=1.0] - The size of the noise particles
 * @param {number} [options.scratch=0.5] - How often scratches appear
 * @param {number} [options.scratchDensity=0.3] - The density of the number of scratches
 * @param {number} [options.scratchWidth=1.0] - The width of the scratches
 * @param {number} [options.vignetting=0.3] - The radius of the vignette effect, smaller
 *        values produces a smaller vignette
 * @param {number} [options.vignettingAlpha=1.0] - Amount of opacity of vignette
 * @param {number} [options.vignettingBlur=0.3] - Blur intensity of the vignette
 * @param {number} [seed=0] - A see value to apply to the random noise generation
 */
export default class AdjustmentFilter extends PIXI.Filter {
    constructor(options) {
        super(vertex, fragment);

        Object.assign(this, {
            gamma: 1,
            saturation: 1,
            contrast: 1,
            brightness: 1,
            red: 1,
            green: 1,
            blue: 1,<commit_msg>add documentation<commit_after>import {vertex} from '@tools/fragments';
import fragment from './adjustment.frag';

/**
 * The AdjustmentFilter to adjust gamma/contrast/saturation/brightness.
.<br>
 * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/adjustment.gif)
 *
 * @class
 * @extends PIXI.Filter
 * @memberof PIXI.filters
 *
 * @param {object|number} [options] - The optional parameters of the filter.
 * @param {number} [options.gamma=1] - TODO
 * @param {number} [options.saturation=1] - TODO
 * @param {number} [options.contrast=1] - TODO
 * @param {number} [options.brightness=1] - TODO
 * @param {number} [options.red=1] - TODO
 * @param {number} [options.green=1] - TODO
 * @param {number} [options.blue=1] - TODO
 * @param {number} [options.alpha=1] - TODO
 */
export default class AdjustmentFilter extends PIXI.Filter {
    constructor(options) {
        super(vertex, fragment);

        Object.assign(this, {
            /**
             * The amount of Gamma
             * @member {number} gamma
             * @default 1
             */
            gamma: 1,

            /**
             * The amount of saturation
             * @member {number} saturation
             * @default 1
             */
            saturation: 1,

            /**
             * The amount of contrast
             * @member {number} contrast
             * @default 1
             */
            contrast: 1,

            /**
             * The amount of brightness
             * @member {number} brightness
             * @default 1
             */
            brightness: 1,

            /**
             * The amount of Red Channel
             * @member {number} red
             * @default 1
             */
            red: 1,

            /**
             * The amount of Green Channel
             * @member {number} green
             * @default 1
             */
            green: 1,

            /**
             * The amount of Blue Channel
             * @member {number} blue
             * @default 1
             */
            blue: 1,

            /**
             * The amount of Alpha Channel
             * @member {number} alpha
             * @default 1
             */
{'fraction_non_alphanumeric': 0.11980319803198032, 'fraction_numerical': 0.013284132841328414, 'mean_word_length': 1.9188801148600143, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3619329', 'n_tokens_mistral': 1202, 'n_tokens_neox': 1132, 'n_words': 346}