Интерфейс ImageConsumer

Все известные реализующие классы:: AreaAveragingScaleFilter, BufferedImageFilter, CropImageFilter, GrayFilter, ImageFilter, PixelGrabber, ReplicateScaleFilter, RGBImageFilter

public interface ImageConsumer

Интерфейс для объектов, проявляющих интерес к данным изображения через интерфейсы ImageProducer. Когда потребитель добавляется к производителю изображения, производитель предоставляет все данные об изображении с использованием методов, определенных в этом интерфейсе.

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`COMPLETESCANLINES`	Пиксели будут переданы (кратными) полными строками сканирования за раз.
`static final int`	`IMAGEABORTED`	Процесс создания изображения был преднамеренно прерван.
`static final int`	`IMAGEERROR`	Возникла ошибка при создании изображения.
`static final int`	`RANDOMPIXELORDER`	Пиксели будут переданы в случайном порядке.
`static final int`	`SINGLEFRAME`	Изображение содержит одно статическое изображение.
`static final int`	`SINGLEFRAMEDONE`	Один кадр изображения завершён, но необходимо передать дополнительные кадры.
`static final int`	`SINGLEPASS`	Пиксели будут переданы за один проход.
`static final int`	`STATICIMAGEDONE`	Изображение завершено, и больше пикселей или кадров передавать не нужно.
`static final int`	`TOPDOWNLEFTRIGHT`	Пиксели будут переданы сверху вниз, слева направо.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`imageComplete(int status)`	Метод imageComplete вызывается, когда ImageProducer завершает передачу всех пикселей исходного изображения, или когда завершён один кадр многокадровой анимации, или когда произошла ошибка при загрузке или создании изображения.
`void`	`setColorModel(ColorModel model)`	Устанавливает объект ColorModel, используемый для большинства пикселей, сообщаемых с помощью вызовов метода setPixels.
`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)`	Передает пиксели изображения с помощью одного или нескольких вызовов этого метода.
`void`	`setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)`	Пиксели изображения передаются с помощью одного или нескольких вызовов метода setPixels.
`void`	`setProperties(Hashtable<?,?> props)`	Устанавливает расширяемый список свойств, связанных с этим изображением.

Подробное описание полей

RANDOMPIXELORDER

static final int RANDOMPIXELORDER

Пиксели будут переданы в случайном порядке. Это сообщает ImageConsumer не использовать оптимизации, зависящие от порядка доставки пикселей, что должно быть стандартным предположением при отсутствии вызова метода setHints.

См. также:

TOPDOWNLEFTRIGHT

static final int TOPDOWNLEFTRIGHT

Пиксели будут переданы сверху вниз, слева направо.

См. также:

COMPLETESCANLINES

static final int COMPLETESCANLINES

Пиксели будут переданы (кратными) полными строками сканирования за раз.

См. также:

SINGLEPASS

static final int SINGLEPASS

Пиксели будут переданы за один проход. Каждый пиксель появится только в одном вызове любого из методов setPixels. Примером формата изображения, не соответствующего этому критерию, является прогрессивное JPEG-изображение, которое определяет пиксели несколькими проходами, каждый из которых более детализирован, чем предыдущий.

См. также:

SINGLEFRAME

static final int SINGLEFRAME

Изображение содержит одно статическое изображение. Пиксели будут определены в вызовах методов setPixels, а затем метод imageComplete будет вызван со флагом STATICIMAGEDONE, после чего больше данных изображения не будет передано. Примером типа изображения, который не будет соответствовать этим критериям, является вывод видеопотока или представление 3D-рендеринга, манипулируемого пользователем. Конец каждого кадра в таких типах изображений будет обозначен вызовом imageComplete со флагом SINGLEFRAMEDONE.

См. также:

IMAGEERROR

static final int IMAGEERROR

При создании изображения возникла ошибка.

См. также:

SINGLEFRAMEDONE

static final int SINGLEFRAMEDONE

Один кадр изображения завершен, но есть дополнительные кадры для передачи.

См. также:

STATICIMAGEDONE

static final int STATICIMAGEDONE

Изображение завершено, и больше пикселей или кадров передаваться не будут.

См. также:

IMAGEABORTED

static final int IMAGEABORTED

Процесс создания изображения был преднамеренно прерван.

См. также:

Подробное описание методов

setDimensions

void setDimensions(int width, int height)

Размеры исходного изображения сообщаются с помощью вызова метода setDimensions.

Параметры:: width - ширина исходного изображения; height - высота исходного изображения

setProperties

void setProperties(Hashtable<?,?> props)

Устанавливает расширяемый список свойств, связанных с этим изображением.

Параметры:: props - список свойств, которые должны быть связаны с этим изображением

setColorModel

void setColorModel(ColorModel model)

Устанавливает объект ColorModel, используемый для большинства пикселей, сообщенных с помощью вызовов метода setPixels. Обратите внимание, что каждый набор пикселей, передаваемый с помощью setPixels, содержит свой объект ColorModel, поэтому не следует делать предположение, что эта модель будет единственной, используемой для передачи значений пикселей. Заметный случай, когда могут встречаться несколько объектов ColorModel, — это отфильтрованное изображение, когда для каждого набора пикселей, который он фильтрует, фильтр определяет, можно ли передать пиксели без изменений, используя исходный ColorModel, или пиксели должны быть изменены (отфильтрованы) и переданы с использованием ColorModel, более удобным для процесса фильтрации.

Параметры:

model - указанный ColorModel

См. также:

setHints

void setHints(int hintflags)

Устанавливает подсказки, которые ImageConsumer использует для обработки пикселей, передаваемых ImageProducer. ImageProducer может передавать пиксели в любом порядке, но ImageConsumer может иметь возможность масштабировать или преобразовывать пиксели в целевой ColorModel более эффективно или с более высоким качеством, если он знает некоторые сведения о том, как пиксели будут переданы заранее. Метод setHints должен вызываться перед любыми вызовами методов setPixels с маской битов подсказок о способе передачи пикселей. Если ImageProducer не следует указаниям для указанной подсказки, результаты не определены.

Параметры:: hintflags - набор подсказок, которые ImageConsumer использует для обработки пикселей

setPixels

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

Передает пиксели изображения с помощью одного или нескольких вызовов этого метода. Каждый вызов определяет положение и размер прямоугольника исходных пикселей, которые содержатся в массиве пикселей. Указанный объект ColorModel должен использоваться для преобразования пикселей в соответствующие цветные и альфа-компоненты. Пиксель (m,n) хранится в массиве pixels в индексе (n * scansize + m + off). Все пиксели, передаваемые с помощью этого метода, хранятся как байты.

Параметры:

x - координата X верхнего левого угла области пикселей для установки

y - координата Y верхнего левого угла области пикселей для установки

w - ширина области пикселей

h - высота области пикселей

model - указанный ColorModel

pixels - массив пикселей

off - смещение в массиве pixels

scansize - расстояние от одной строки пикселей до следующей в массиве pixels

См. также:

setPixels

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

Пиксели изображения передаются с помощью одного или нескольких вызовов метода setPixels. Каждый вызов определяет расположение и размер прямоугольника исходных пикселей, содержащихся в массиве пикселей. Указанный объект ColorModel должен использоваться для преобразования пикселей в соответствующие цветовые и альфа-компоненты. Пиксель (m,n) хранится в массиве pixels по индексу (n * scansize + m + off). Все пиксели, передаваемые с помощью этого метода, хранятся как целые числа.

Параметры:

x - координата X левого верхнего угла области пикселей, которые нужно установить

y - координата Y левого верхнего угла области пикселей, которые нужно установить

w - ширина области пикселей

h - высота области пикселей

model - указанный ColorModel

pixels - массив пикселей

off - смещение в массиве pixels

scansize - расстояние между строками пикселей в массиве pixels

См. также:

imageComplete

void imageComplete(int status)

Метод imageComplete вызывается, когда ImageProducer завершил передачу всех пикселей, содержащихся в исходном изображении, или когда был завершён один кадр многокадровой анимации, или когда произошла ошибка при загрузке или создании изображения. В это время ImageConsumer должен удалить себя из списка потребителей, зарегистрированных в ImageProducer, если он не заинтересован в последующих кадрах.

Параметры:

status - статус загрузки изображения

См. также:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/image/ImageConsumer.html