001/*
002Copyright 2006 Jerry Huxtable
003
004Licensed under the Apache License, Version 2.0 (the "License");
005you may not use this file except in compliance with the License.
006You may obtain a copy of the License at
007
008   http://www.apache.org/licenses/LICENSE-2.0
009
010Unless required by applicable law or agreed to in writing, software
011distributed under the License is distributed on an "AS IS" BASIS,
012WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013See the License for the specific language governing permissions and
014limitations under the License.
015*/
016
017package com.jhlabs.image;
018
019import java.awt.*;
020import java.awt.image.*;
021import java.io.*;
022
023/**
024 * Applies a bit mask to each ARGB pixel of an image. You can use this for, say, masking out the red channel.
025 */
026public class MaskFilter extends PointFilter {
027
028        private int mask;
029
030        public MaskFilter() {
031                this(0xff00ffff);
032        }
033
034        public MaskFilter(int mask) {
035                canFilterIndexColorModel = true;
036                setMask(mask);
037        }
038
039        public void setMask(int mask) {
040                this.mask = mask;
041        }
042
043        public int getMask() {
044                return mask;
045        }
046
047        public int filterRGB(int x, int y, int rgb) {
048                return rgb & mask;
049        }
050
051        public String toString() {
052                return "Mask";
053        }
054
055}