1 /*
   2  * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package java.awt.image;
  26 
  27 import java.awt.Image;
  28 import java.awt.geom.AffineTransform;
  29 import java.util.List;
  30 
  31 /**
  32  * This interface is designed to provide a set of images at various resolutions.
  33  *
  34  * The <code>MultiResolutionImage</code> interface should be implemented by any
  35  * class whose instances are intended to provide image resolution variants
  36  * according to the given image width and height.
  37  *
  38  *
  39  * It is recommended to cache image variants for performance reasons.
  40  *
  41  * @since 1.9
  42  */
  43 public interface MultiResolutionImage {
  44 
  45     /**
  46      * Provides an image with necessary resolution which best fits to the given
  47      * arguments.
  48      *
  49      * @param logicalDPIX the logical horizontal DPI of the desktop.
  50      * @param logicalDPIY the logical vertical DPI of the desktop.
  51      * @param baseImageWidth the width of the base image.
  52      * @param baseImageHeight the height of the base image.
  53      * @param destImageWidth the width of the destination image.
  54      * @param destImageHeight the height of the destination image.
  55      * @return image resolution variant.
  56      *
  57      * @since 1.9
  58      */
  59 
  60     Image getResolutionVariant(float logicalDPIX, float logicalDPIY,
  61             float baseImageWidth, float baseImageHeight,
  62             float destImageWidth, float destImageHeight);
  63 
  64     /**
  65      * Gets an immutable list of all resolution variants
  66      *
  67      * @return list of resolution variants.
  68      * @since 1.9
  69      */
  70     public List<Image> getResolutionVariants();
  71 }