java.awt.image
インタフェース ImageConsumer

既知の実装クラスの一覧:

ImageFilter, PixelGrabber

public interface ImageConsumer

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

関連項目:

ImageProducer

フィールドの概要

static int	COMPLETESCANLINES ピクセルは、1 度に (複数の) 完全な走査線単位で転送されます。
static int	IMAGEABORTED イメージ生成が故意に中断されました。
static int	IMAGEERROR イメージの生成中にエラーが発生しました。
static int	RANDOMPIXELORDER ピクセルの転送順序はランダムです。
static int	SINGLEFRAME イメージデータは、1 枚の静止画像を含んでいます。
static int	SINGLEFRAMEDONE イメージの 1 フレームの転送が完了しましたが、まだ転送対象のフレームがあります。
static int	SINGLEPASS ピクセルは 1 つのパスで転送されます。
static int	STATICIMAGEDONE イメージの転送が完了し、転送対象のピクセルもフレームも残っていません。
static 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 回以上の setPixels メソッド呼び出しによって転送します。
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

public static final int RANDOMPIXELORDER

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

関連項目:

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

TOPDOWNLEFTRIGHT

public static final int TOPDOWNLEFTRIGHT

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

関連項目:

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

COMPLETESCANLINES

public static final int COMPLETESCANLINES

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

関連項目:

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

SINGLEPASS

public static final int SINGLEPASS

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

関連項目:

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

SINGLEFRAME

public static final int SINGLEFRAME

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

関連項目:

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

IMAGEERROR

public static final int IMAGEERROR

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

関連項目:

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

SINGLEFRAMEDONE

public static final int SINGLEFRAMEDONE

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

関連項目:

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

STATICIMAGEDONE

public static final int STATICIMAGEDONE

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

関連項目:

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

IMAGEABORTED

public static final int IMAGEABORTED

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

関連項目:

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

メソッドの詳細

setDimensions

public void setDimensions(int width,
                          int height)

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

パラメータ:

width - ソースイメージの幅

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

setProperties

public void setProperties(Hashtable props)

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

パラメータ:

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

setColorModel

public void setColorModel(ColorModel model)

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

パラメータ:

model - 指定された ColorModel

関連項目:

ColorModel

setHints

public void setHints(int hintflags)

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

パラメータ:

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

setPixels

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

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

パラメータ:

w - ピクセル領域の幅

h - ピクセル領域の高さ

model - 指定された ColorModel

pixels - ピクセルの配列

off - pixels 配列のオフセット

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

関連項目:

ColorModel

setPixels

public 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 で格納されています。

パラメータ:

w - ピクセル領域の幅

h - ピクセル領域の高さ

model - 指定された ColorModel

pixels - ピクセルの配列

off - pixels 配列のオフセット

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

関連項目:

ColorModel

imageComplete

public void imageComplete(int status)

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

パラメータ:

status - イメージロードの状態

関連項目:

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