java/javase/note/docs/api/java.desktop/java/awt/Image.html at master · ziyinjava/java

875 lines (873 loc) · 37.4 KB
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<!-- Generated by javadoc -->
<title>Image (Java SE 12 &amp; JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.awt.Image class">
<meta name="keywords" content="accelerationPriority">
<meta name="keywords" content="UndefinedProperty">
<meta name="keywords" content="SCALE_DEFAULT">
<meta name="keywords" content="SCALE_FAST">
<meta name="keywords" content="SCALE_SMOOTH">
<meta name="keywords" content="SCALE_REPLICATE">
<meta name="keywords" content="SCALE_AREA_AVERAGING">
<meta name="keywords" content="getWidth()">
<meta name="keywords" content="getHeight()">
<meta name="keywords" content="getSource()">
<meta name="keywords" content="getGraphics()">
<meta name="keywords" content="getProperty()">
<meta name="keywords" content="getScaledInstance()">
<meta name="keywords" content="flush()">
<meta name="keywords" content="getCapabilities()">
<meta name="keywords" content="setAccelerationPriority()">
<meta name="keywords" content="getAccelerationPriority()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
<script type="text/javascript"><!--
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Image (Java SE 12 & JDK 12 )";
    catch(err) {
var data = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6,"i5":6,"i6":10,"i7":6,"i8":6,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Image.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 &amp; JDK 12</strong> </div></div>
<div class="subNav">
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<a id="skip.navbar.top">
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../module-summary.html">java.desktop</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">java.awt</a></div>
<h2 title="Class Image" class="title">Class Image</h2>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<ul class="inheritance">
<li>java.awt.Image</li>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="image/AbstractMultiResolutionImage.html" title="class in java.awt.image">AbstractMultiResolutionImage</a></code>, <code><a href="image/BufferedImage.html" title="class in java.awt.image">BufferedImage</a></code>, <code><a href="image/VolatileImage.html" title="class in java.awt.image">VolatileImage</a></code></dd>
<pre>public abstract class <span class="typeNameLabel">Image</span>
extends <a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></pre>
<div class="block">The abstract class <code>Image</code> is the superclass of all
 classes that represent graphical images. The image must be
 obtained in a platform-specific manner.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<h3>Field Summary</h3>
<div class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor">
<td class="colFirst"><code>protected float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accelerationPriority">accelerationPriority</a></span></code></th>
<td class="colLast">
<div class="block">Priority for accelerating this image.</div>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCALE_AREA_AVERAGING">SCALE_AREA_AVERAGING</a></span></code></th>
<td class="colLast">
<div class="block">Use the Area Averaging image scaling algorithm.</div>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCALE_DEFAULT">SCALE_DEFAULT</a></span></code></th>
<td class="colLast">
<div class="block">Use the default image-scaling algorithm.</div>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCALE_FAST">SCALE_FAST</a></span></code></th>
<td class="colLast">
<div class="block">Choose an image-scaling algorithm that gives higher priority
 to scaling speed than smoothness of the scaled image.</div>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCALE_REPLICATE">SCALE_REPLICATE</a></span></code></th>
<td class="colLast">
<div class="block">Use the image scaling algorithm embodied in the
 <code>ReplicateScaleFilter</code> class.</div>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCALE_SMOOTH">SCALE_SMOOTH</a></span></code></th>
<td class="colLast">
<div class="block">Choose an image-scaling algorithm that gives higher priority
 to image smoothness than scaling speed.</div>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UndefinedProperty">UndefinedProperty</a></span></code></th>
<td class="colLast">
<div class="block">The <code>UndefinedProperty</code> object should be returned whenever a
 property which was not defined for a particular image is fetched.</div>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<h3>Constructor Summary</h3>
<div class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Image</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor" id="i0">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush()">flush</a></span>()</code></th>
<td class="colLast">
<div class="block">Flushes all reconstructable resources being used by this Image object.</div>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAccelerationPriority()">getAccelerationPriority</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current value of the acceleration priority hint.</div>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="ImageCapabilities.html" title="class in java.awt">ImageCapabilities</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCapabilities(java.awt.GraphicsConfiguration)">getCapabilities</a></span>&#8203;(<a href="GraphicsConfiguration.html" title="class in java.awt">GraphicsConfiguration</a>&nbsp;gc)</code></th>
<td class="colLast">
<div class="block">Returns an ImageCapabilities object which can be
 inquired as to the capabilities of this
 Image on the specified GraphicsConfiguration.</div>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>abstract <a href="Graphics.html" title="class in java.awt">Graphics</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGraphics()">getGraphics</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a graphics context for drawing to an off-screen image.</div>
<tr class="altColor" id="i4">
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeight(java.awt.image.ImageObserver)">getHeight</a></span>&#8203;(<a href="image/ImageObserver.html" title="interface in java.awt.image">ImageObserver</a>&nbsp;observer)</code></th>
<td class="colLast">
<div class="block">Determines the height of the image.</div>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>abstract <a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String,java.awt.image.ImageObserver)">getProperty</a></span>&#8203;(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;name,
           <a href="image/ImageObserver.html" title="interface in java.awt.image">ImageObserver</a>&nbsp;observer)</code></th>
<td class="colLast">
<div class="block">Gets a property of this image by name.</div>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="Image.html" title="class in java.awt">Image</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScaledInstance(int,int,int)">getScaledInstance</a></span>&#8203;(int&nbsp;width,
                 int&nbsp;height,
                 int&nbsp;hints)</code></th>
<td class="colLast">
<div class="block">Creates a scaled version of this image.</div>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>abstract <a href="image/ImageProducer.html" title="interface in java.awt.image">ImageProducer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSource()">getSource</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the object that produces the pixels for the image.</div>
<tr class="altColor" id="i8">
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWidth(java.awt.image.ImageObserver)">getWidth</a></span>&#8203;(<a href="image/ImageObserver.html" title="interface in java.awt.image">ImageObserver</a>&nbsp;observer)</code></th>
<td class="colLast">
<div class="block">Determines the width of the image.</div>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAccelerationPriority(float)">setAccelerationPriority</a></span>&#8203;(float&nbsp;priority)</code></th>
<td class="colLast">
<div class="block">Sets a hint for this image about how important acceleration is.</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<h3>Methods declared in class&nbsp;java.lang.<a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></h3>
<code><a href="../../../java.base/java/lang/Object.html#clone()">clone</a>, <a href="../../../java.base/java/lang/Object.html#equals(java.lang.Object)">equals</a>, <a href="../../../java.base/java/lang/Object.html#finalize()">finalize</a>, <a href="../../../java.base/java/lang/Object.html#getClass()">getClass</a>, <a href="../../../java.base/java/lang/Object.html#hashCode()">hashCode</a>, <a href="../../../java.base/java/lang/Object.html#notify()">notify</a>, <a href="../../../java.base/java/lang/Object.html#notifyAll()">notifyAll</a>, <a href="../../../java.base/java/lang/Object.html#toString()">toString</a>, <a href="../../../java.base/java/lang/Object.html#wait()">wait</a>, <a href="../../../java.base/java/lang/Object.html#wait(long)">wait</a>, <a href="../../../java.base/java/lang/Object.html#wait(long,int)">wait</a></code></li>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<h3>Field Detail</h3>
<a id="accelerationPriority">
<ul class="blockList">
<li class="blockList">
<h4>accelerationPriority</h4>
<pre>protected&nbsp;float accelerationPriority</pre>
<div class="block">Priority for accelerating this image.  Subclasses are free to
 set different default priorities and applications are free to
 set the priority for specific images via the
 <code>setAccelerationPriority(float)</code> method.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<a id="UndefinedProperty">
<ul class="blockList">
<li class="blockList">
<h4>UndefinedProperty</h4>
<pre>public static final&nbsp;<a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a> UndefinedProperty</pre>
<div class="block">The <code>UndefinedProperty</code> object should be returned whenever a
 property which was not defined for a particular image is fetched.</div>
<a id="SCALE_DEFAULT">
<ul class="blockList">
<li class="blockList">
<h4>SCALE_DEFAULT</h4>
<pre>public static final&nbsp;int SCALE_DEFAULT</pre>
<div class="block">Use the default image-scaling algorithm.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.awt.Image.SCALE_DEFAULT">Constant Field Values</a></dd>
<a id="SCALE_FAST">
<ul class="blockList">
<li class="blockList">
<h4>SCALE_FAST</h4>
<pre>public static final&nbsp;int SCALE_FAST</pre>
<div class="block">Choose an image-scaling algorithm that gives higher priority
 to scaling speed than smoothness of the scaled image.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.awt.Image.SCALE_FAST">Constant Field Values</a></dd>
<a id="SCALE_SMOOTH">
<ul class="blockList">
<li class="blockList">
<h4>SCALE_SMOOTH</h4>
<pre>public static final&nbsp;int SCALE_SMOOTH</pre>
<div class="block">Choose an image-scaling algorithm that gives higher priority
 to image smoothness than scaling speed.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.awt.Image.SCALE_SMOOTH">Constant Field Values</a></dd>
<a id="SCALE_REPLICATE">
<ul class="blockList">
<li class="blockList">
<h4>SCALE_REPLICATE</h4>
<pre>public static final&nbsp;int SCALE_REPLICATE</pre>
<div class="block">Use the image scaling algorithm embodied in the
 <code>ReplicateScaleFilter</code> class.
 The <code>Image</code> object is free to substitute a different filter
 that performs the same algorithm yet integrates more efficiently
 into the imaging infrastructure supplied by the toolkit.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="image/ReplicateScaleFilter.html" title="class in java.awt.image"><code>ReplicateScaleFilter</code></a>, 
<a href="../../../constant-values.html#java.awt.Image.SCALE_REPLICATE">Constant Field Values</a></dd>
<a id="SCALE_AREA_AVERAGING">
<ul class="blockListLast">
<li class="blockList">
<h4>SCALE_AREA_AVERAGING</h4>
<pre>public static final&nbsp;int SCALE_AREA_AVERAGING</pre>
<div class="block">Use the Area Averaging image scaling algorithm.  The
 image object is free to substitute a different filter that
 performs the same algorithm yet integrates more efficiently
 into the image infrastructure supplied by the toolkit.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="image/AreaAveragingScaleFilter.html" title="class in java.awt.image"><code>AreaAveragingScaleFilter</code></a>, 
<a href="../../../constant-values.html#java.awt.Image.SCALE_AREA_AVERAGING">Constant Field Values</a></dd>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<ul class="blockListLast">
<li class="blockList">
<h4>Image</h4>
<pre>public&nbsp;Image()</pre>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<h3>Method Detail</h3>
<a id="getWidth(java.awt.image.ImageObserver)">
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre class="methodSignature">public abstract&nbsp;int&nbsp;getWidth&#8203;(<a href="image/ImageObserver.html" title="interface in java.awt.image">ImageObserver</a>&nbsp;observer)</pre>
<div class="block">Determines the width of the image. If the width is not yet known,
 this method returns <code>-1</code> and the specified
 <code>ImageObserver</code> object is notified later.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>observer</code> - an object waiting for the image to be loaded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the width of this image, or <code>-1</code>
                   if the width is not yet known.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getHeight(java.awt.image.ImageObserver)"><code>getHeight(java.awt.image.ImageObserver)</code></a>, 
<a href="image/ImageObserver.html" title="interface in java.awt.image"><code>ImageObserver</code></a></dd>
<a id="getHeight(java.awt.image.ImageObserver)">
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre class="methodSignature">public abstract&nbsp;int&nbsp;getHeight&#8203;(<a href="image/ImageObserver.html" title="interface in java.awt.image">ImageObserver</a>&nbsp;observer)</pre>
<div class="block">Determines the height of the image. If the height is not yet known,
 this method returns <code>-1</code> and the specified
 <code>ImageObserver</code> object is notified later.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>observer</code> - an object waiting for the image to be loaded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the height of this image, or <code>-1</code>
                   if the height is not yet known.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getWidth(java.awt.image.ImageObserver)"><code>getWidth(java.awt.image.ImageObserver)</code></a>, 
<a href="image/ImageObserver.html" title="interface in java.awt.image"><code>ImageObserver</code></a></dd>
<a id="getSource()">
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="image/ImageProducer.html" title="interface in java.awt.image">ImageProducer</a>&nbsp;getSource()</pre>
<div class="block">Gets the object that produces the pixels for the image.
 This method is called by the image filtering classes and by
 methods that perform image conversion and scaling.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the image producer that produces the pixels
                                  for this image.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="image/ImageProducer.html" title="interface in java.awt.image"><code>ImageProducer</code></a></dd>
<a id="getGraphics()">
<ul class="blockList">
<li class="blockList">
<h4>getGraphics</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Graphics.html" title="class in java.awt">Graphics</a>&nbsp;getGraphics()</pre>
<div class="block">Creates a graphics context for drawing to an off-screen image.
 This method can only be called for off-screen images.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a graphics context to draw to the off-screen image.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - if called for a
            non-off-screen image.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Graphics.html" title="class in java.awt"><code>Graphics</code></a>, 
<a href="Component.html#createImage(int,int)"><code>Component.createImage(int, int)</code></a></dd>
<a id="getProperty(java.lang.String,java.awt.image.ImageObserver)">
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;getProperty&#8203;(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;name,
                                   <a href="image/ImageObserver.html" title="interface in java.awt.image">ImageObserver</a>&nbsp;observer)</pre>
<div class="block">Gets a property of this image by name.
 Individual property names are defined by the various image
 formats. If a property is not defined for a particular image, this
 method returns the <code>UndefinedProperty</code> object.
 If the properties for this image are not yet known, this method
 returns <code>null</code>, and the <code>ImageObserver</code>
 object is notified later.
 The property name <code>"comment"</code> should be used to store
 an optional comment which can be presented to the application as a
 description of the image, its source, or its author.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a property name.</dd>
<dd><code>observer</code> - an object waiting for this image to be loaded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the named property.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the property name is null.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="image/ImageObserver.html" title="interface in java.awt.image"><code>ImageObserver</code></a>, 
<a href="#UndefinedProperty"><code>UndefinedProperty</code></a></dd>
<a id="getScaledInstance(int,int,int)">
<ul class="blockList">
<li class="blockList">
<h4>getScaledInstance</h4>
<pre class="methodSignature">public&nbsp;<a href="Image.html" title="class in java.awt">Image</a>&nbsp;getScaledInstance&#8203;(int&nbsp;width,
                               int&nbsp;height,
                               int&nbsp;hints)</pre>
<div class="block">Creates a scaled version of this image.
 A new <code>Image</code> object is returned which will render
 the image at the specified <code>width</code> and
 <code>height</code> by default.  The new <code>Image</code> object
 may be loaded asynchronously even if the original source image
 has already been loaded completely.
 If either <code>width</code>
 or <code>height</code> is a negative number then a value is
 substituted to maintain the aspect ratio of the original image
 dimensions. If both <code>width</code> and <code>height</code>
 are negative, then the original image dimensions are used.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>width</code> - the width to which to scale the image.</dd>
<dd><code>height</code> - the height to which to scale the image.</dd>
<dd><code>hints</code> - flags to indicate the type of algorithm to use
 for image resampling.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a scaled version of the image.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - if <code>width</code>
             or <code>height</code> is zero.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#SCALE_DEFAULT"><code>SCALE_DEFAULT</code></a>, 
<a href="#SCALE_FAST"><code>SCALE_FAST</code></a>, 
<a href="#SCALE_SMOOTH"><code>SCALE_SMOOTH</code></a>, 
<a href="#SCALE_REPLICATE"><code>SCALE_REPLICATE</code></a>, 
<a href="#SCALE_AREA_AVERAGING"><code>SCALE_AREA_AVERAGING</code></a></dd>
<a id="flush()">
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flush()</pre>
<div class="block">Flushes all reconstructable resources being used by this Image object.
 This includes any pixel data that is being cached for rendering to
 the screen as well as any system resources that are being used
 to store data or pixels for the image if they can be recreated.
 The image is reset to a state similar to when it was first created
 so that if it is again rendered, the image data will have to be
 recreated or fetched again from its source.
 Examples of how this method affects specific types of Image object:
 BufferedImage objects leave the primary Raster which stores their
 pixels untouched, but flush any information cached about those
 pixels such as copies uploaded to the display hardware for
 accelerated blits.
 Image objects created by the Component methods which take a
 width and height leave their primary buffer of pixels untouched,
 but have all cached information released much like is done for
 BufferedImage objects.
 VolatileImage objects release all of their pixel resources
 including their primary copy which is typically stored on
 the display hardware where resources are scarce.
 These objects can later be restored using their
 <a href="image/VolatileImage.html#validate(java.awt.GraphicsConfiguration)"><code>validate</code></a>
 Image objects created by the Toolkit and Component classes which are
 loaded from files, URLs or produced by an <a href="image/ImageProducer.html" title="interface in java.awt.image"><code>ImageProducer</code></a>
 are unloaded and all local resources are released.
 These objects can later be reloaded from their original source
 as needed when they are rendered, just as when they were first
 </ul></div>
<a id="getCapabilities(java.awt.GraphicsConfiguration)">
<ul class="blockList">
<li class="blockList">
<h4>getCapabilities</h4>
<pre class="methodSignature">public&nbsp;<a href="ImageCapabilities.html" title="class in java.awt">ImageCapabilities</a>&nbsp;getCapabilities&#8203;(<a href="GraphicsConfiguration.html" title="class in java.awt">GraphicsConfiguration</a>&nbsp;gc)</pre>
<div class="block">Returns an ImageCapabilities object which can be
 inquired as to the capabilities of this
 Image on the specified GraphicsConfiguration.
 This allows programmers to find
 out more runtime information on the specific Image
 object that they have created.  For example, the user
 might create a BufferedImage but the system may have
 no video memory left for creating an image of that
 size on the given GraphicsConfiguration, so although the object
 may be acceleratable in general, it
 does not have that capability on this GraphicsConfiguration.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gc</code> - a <code>GraphicsConfiguration</code> object.  A value of null
 for this parameter will result in getting the image capabilities
 for the default <code>GraphicsConfiguration</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>ImageCapabilities</code> object that contains
 the capabilities of this <code>Image</code> on the specified
 GraphicsConfiguration.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="image/VolatileImage.html#getCapabilities()"><code>VolatileImage.getCapabilities()</code></a></dd>
<a id="setAccelerationPriority(float)">
<ul class="blockList">
<li class="blockList">
<h4>setAccelerationPriority</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAccelerationPriority&#8203;(float&nbsp;priority)</pre>
<div class="block">Sets a hint for this image about how important acceleration is.
 This priority hint is used to compare to the priorities of other
 Image objects when determining how to use scarce acceleration
 resources such as video memory.  When and if it is possible to
 accelerate this Image, if there are not enough resources available
 to provide that acceleration but enough can be freed up by
 de-accelerating some other image of lower priority, then that other
 Image may be de-accelerated in deference to this one.  Images
 that have the same priority take up resources on a first-come,
 first-served basis.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>priority</code> - a value between 0 and 1, inclusive, where higher
 values indicate more importance for acceleration.  A value of 0
 means that this Image should never be accelerated.  Other values
 are used simply to determine acceleration priority relative to other
 Images.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../java.base/java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - if <code>priority</code> is less
 than zero or greater than 1.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<a id="getAccelerationPriority()">
<ul class="blockListLast">
<li class="blockList">
<h4>getAccelerationPriority</h4>
<pre class="methodSignature">public&nbsp;float&nbsp;getAccelerationPriority()</pre>
<div class="block">Returns the current value of the acceleration priority hint.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value between 0 and 1, inclusive, which represents the current
 priority value</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setAccelerationPriority(float)"><code>setAccelerationPriority</code></a></dd>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Image.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 &amp; JDK 12</strong> </div></div>
<div class="subNav">
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
<a id="skip.navbar.bottom">
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&amp;id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> &copy; 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. <!-- Version 12.0.2+10 --></small></p>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Image.html

Latest commit

History

Image.html

File metadata and controls
