Skip to content

Brightness

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery/blob/main/js/filters/Brightness.ts for the most up-to-date information.

Overview

Brightness filter

@author Jonathan Olson <jonathan.olson@colorado.edu>

Class Brightness

import { Brightness } from 'scenerystack/scenery';

Constructor

new Brightness( amount : number )

Instance Methods

getCSSFilterString() : string

Returns the CSS-style filter substring specific to this single filter, e.g. grayscale(1). This should be used for both DOM elements (https://developer.mozilla.org/en-US/docs/Web/CSS/filter) and when supported, Canvas (https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/filter).

isDOMCompatible() : boolean

Static Properties

BLACKEN : Brightness

(readonly)

Fully darkens the content

Source Code

See the source for Brightness.ts in the scenery repository.