Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Detect whether an image or canvas element contains any transparent pixels.
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
test
.gitignore
LICENSE.md
README.md
component.json
index.js
package.json

README.md

opaque

Browserify module for detecting if an image or canvas element has transparent pixels.

Installation

Using NPM and Browserify:

npm install opaque

As a component:

component install hughsk/opaque

Usage

opaque(element)

Returns false if transparent, or true if not.

opaque.transparent(element)

The opposite of opaque: true if transparent, false if not.

var opaque = require('opaque')
  , transparent = require('opaque').transparent

var brick = new Image
brick.src = '/brick.png'
brick.onload = function() {
  opaque(brick)      // true
  transparent(brick) // false
};

var glass = new Image
glass.src = '/glass.png'
glass.onload = function() {
  opaque(glass)      // false
  transparent(glass) // true
};

Note that an image must be fully loaded before being checked.

Something went wrong with that request. Please try again.