モジュール java.desktop

パッケージ java.awt.image

インタフェースImageConsumer

既知のすべての実装クラス:

AreaAveragingScaleFilter, BufferedImageFilter, CropImageFilter, GrayFilter, ImageFilter, PixelGrabber, ReplicateScaleFilter, RGBImageFilter

public interface ImageConsumer

ImageProducerインタフェース経由でイメージ・データを表示するオブジェクトのためのインタフェースです。 コンシューマがイメージ・プロデューサに追加されると、プロデューサはこのインタフェースで定義されたメソッドを呼び出すことによってイメージ・データを転送します。

関連項目:

• ImageProducer

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final int	COMPLETESCANLINES	ピクセルは、1度に(複数の)完全な走査線単位で転送されます。
static final int	IMAGEABORTED	イメージ生成が故意に中断されました。
static final int	IMAGEERROR	イメージの生成中にエラーが発生しました。
static final int	RANDOMPIXELORDER	ピクセルの転送順序はランダムです。
static final int	SINGLEFRAME	イメージ・データは、1枚の静止画像を含んでいます。
static final int	SINGLEFRAMEDONE	イメージの1フレームの転送が完了しましたが、まだ転送対象のフレームがあります。
static final int	SINGLEPASS	ピクセルは1つのパスで転送されます。
static final int	STATICIMAGEDONE	イメージの転送が完了し、転送対象のピクセルもフレームも残っていません。
static final int	TOPDOWNLEFTRIGHT	ピクセルは上から下、左から右の順で転送されます。

メソッドのサマリー

修飾子と型	メソッド	説明
void	imageComplete(int status)	imageCompleteメソッドは、ImageProducerがソース・イメージのすべてのピクセルを転送し終えたとき、マルチフレーム・アニメーションの1フレームを転送し終えたとき、またはイメージの生成中およびローディング中にエラーが発生したときに呼び出されます。
void	setColorModel(ColorModel model)	setPixelsメソッドを使って報告されるピクセルの大部分に対して使用されるColorModelオブジェクトを設定します。
void	setDimensions(int width, int height)	setDimensionsメソッド呼出しを使って、ソース・イメージの大きさを報告します。
void	setHints(int hintflags)	ImageConsumerがImageProducerから転送されるピクセルを処理するために使用されるヒントを設定します。
void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)	イメージのピクセルを1回以上のこのメソッド呼出しによって転送します。
void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)	イメージのピクセルは、1回以上のsetPixelsメソッドの呼出しによって転送されます。
void	setProperties(Hashtable<?,?> props)	このイメージに関して、拡張可能なプロパティのリストを設定します。

フィールド詳細

RANDOMPIXELORDER

static final int RANDOMPIXELORDER

ピクセルの転送順序はランダムです。 つまり、ImageConsumerではピクセルの転送順序の最適化を行いません。setHintsメソッドが呼び出されていないときは、このランダム転送がデフォルトとなります。

関連項目:

• setHints(int)
• 定数フィールド値

TOPDOWNLEFTRIGHT

static final int TOPDOWNLEFTRIGHT

ピクセルは上から下、左から右の順で転送されます。

関連項目:

• setHints(int)
• 定数フィールド値

COMPLETESCANLINES

static final int COMPLETESCANLINES

ピクセルは、1度に(複数の)完全な走査線単位で転送されます。

関連項目:

• setHints(int)
• 定数フィールド値

SINGLEPASS

static final int SINGLEPASS

ピクセルは1つのパスで転送されます。 各ピクセルは、setPixelsメソッドの呼出しで1度だけ転送されます。 この基準と異なるイメージ形式の例として、プログレッシブJPEGイメージがあります。この形式は、複数のパスでピクセルを定義し、より洗練されたイメージを構成します。

関連項目:

• setHints(int)
• 定数フィールド値

SINGLEFRAME

static final int SINGLEFRAME

イメージ・データは、1枚の静止画像を含んでいます。 ピクセルをsetPixelsメソッドの呼出しで定義したあと、転送すべきデータがなくなると、imageCompleteメソッドをSTATICIMAGEDONEフラグ付きで呼び出します。 この基準と異なるイメージの例は、ユーザーが操作する3Dレンダリングの表示やビデオ出力です。 これらの各フレームの終りには、SINGLEFRAMEDONEフラグを使用するimageCompleteの呼出しが指示されています。

関連項目:

• setHints(int)
• imageComplete(int)
• 定数フィールド値

IMAGEERROR

static final int IMAGEERROR

イメージの生成中にエラーが発生しました。

関連項目:

• imageComplete(int)
• 定数フィールド値

SINGLEFRAMEDONE

static final int SINGLEFRAMEDONE

イメージの1フレームの転送が完了しましたが、まだ転送対象のフレームがあります。

関連項目:

• imageComplete(int)
• 定数フィールド値

STATICIMAGEDONE

static final int STATICIMAGEDONE

イメージの転送が完了し、転送対象のピクセルもフレームも残っていません。

関連項目:

• imageComplete(int)
• 定数フィールド値

IMAGEABORTED

static final int IMAGEABORTED

イメージ生成が故意に中断されました。

関連項目:

• imageComplete(int)
• 定数フィールド値

メソッドの詳細

setDimensions

void setDimensions(int width, int height)

setDimensionsメソッド呼出しを使って、ソース・イメージの大きさを報告します。

パラメータ:

width - ソース・イメージの幅

height - ソース・イメージの高さ

setProperties

void setProperties(Hashtable<?,?> props)

このイメージに関して、拡張可能なプロパティのリストを設定します。

パラメータ:

props - このイメージに関連付けるプロパティのリスト

setColorModel

void setColorModel(ColorModel model)

setPixelsメソッドを使って報告されるピクセルの大部分に対して使用されるColorModelオブジェクトを設定します。 setPixelsメソッドによって転送されるピクセルのセットは、それぞれColorModelオブジェクトを含んでいるので、ピクセル値の転送時に指定されたColorModelだけが使われるわけではないことに注意してください。 複数のColorModelオブジェクトが使われる例としては、フィルタ処理されるイメージがあります。フィルタ処理対象のピクセルに修正を行うかどうかを決定し、修正不要の場合は元のColorModelを使い、修正する場合はよりフィルタ処理に適したColorModelを使います。

パラメータ:

model - 指定されたColorModel

関連項目:

• ColorModel

setHints

void setHints(int hintflags)

ImageConsumerがImageProducerから転送されるピクセルを処理するために使用されるヒントを設定します。 ImageProducerはどのような順序でもピクセルを転送することができますが、ピクセルの転送についての情報をImageConsumerに渡すことができれば、ImageConsumerはColorModelへのピクセルのスケーリングや変換をより能率的かつ高品質に行うことができます。 setHintsメソッドの引数が、ピクセルの転送方法に関する情報のビット・マスクを持つので、setPixelsメソッドよりも前にsetHintsメソッドを呼び出します。 ImageProducerが、このガイドラインに従っていない場合の結果は保証されません。

パラメータ:

hintflags - ImageConsumerがピクセル処理に使用するヒントのセット

setPixels

void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)

イメージのピクセルを1回以上のこのメソッド呼出しによって転送します。 各呼出しは、ピクセル配列に含まれるソース・ピクセルの位置と矩形の大きさを指定します。 ピクセルを適切な色とアルファ成分に変換するには、指定されたColorModelオブジェクトを使用します。 (m, nの位置の)ピクセルは、インデックス(n * scansize+m+off)のpixels配列に置かれます。 このメソッドで転送されるピクセルは、すべてbyteで格納されます。

パラメータ:

x - 設定されるピクセルの領域の左上隅のX座標

y - 設定されるピクセルの領域の左上隅のY座標

w - ピクセル領域の幅

h - ピクセル領域の高さ

model - 指定されたColorModel

pixels - ピクセルの配列

off - pixels配列へのオフセット

scansize - pixels配列内のあるピクセル行から次のピクセル行までの距離

関連項目:

• ColorModel

setPixels

void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)

イメージのピクセルは、1回以上のsetPixelsメソッドの呼出しによって転送されます。 各呼出しは、ピクセル配列に含まれるソース・ピクセルの位置と矩形の大きさを指定します。 ピクセルを適切な色とアルファ成分に変換するには、指定されたColorModelオブジェクトを使用します。 (m, nの位置の)ピクセルは、インデックス(n * scansize+m+off)のpixels配列に置かれます。 このメソッドで転送されるピクセルは、すべてintで格納されています。

パラメータ:

x - 設定されるピクセルの領域の左上隅のX座標

y - 設定されるピクセルの領域の左上隅のY座標

w - ピクセル領域の幅

h - ピクセル領域の高さ

model - 指定されたColorModel

pixels - ピクセルの配列

off - pixels配列へのオフセット

scansize - pixels配列内のあるピクセル行から次のピクセル行までの距離

関連項目:

• ColorModel

imageComplete

void imageComplete(int status)

imageCompleteメソッドは、ImageProducerがソース・イメージのすべてのピクセルを転送し終えたとき、マルチフレーム・アニメーションの1フレームを転送し終えたとき、またはイメージの生成中およびローディング中にエラーが発生したときに呼び出されます。 連続しているフレーム側でImageConsumerが不要であれば、ImageProducerで登録されたコンシューマ・リストからImageConsumer自体を削除します。

パラメータ:

status - イメージ・ロードのステータス

関連項目:

• ImageProducer.removeConsumer(java.awt.image.ImageConsumer)