程序包 ohos.media.image

类 Image.Component

java.lang.Object

ohos.media.image.Image.Component

封闭类:

Image

public static class Image.Component
extends Object

Describes image color components.

This class provides methods for obtaining image color component attributes, and reading and writing color component data.

从以下版本开始:

1

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	Image.Component.OperationResult	Describes results of color component–related operations.

字段概要

字段

限定符和类型	字段	说明
ImageFormat.ComponentType	componentType	Indicates the color component type defined in ImageFormat.ComponentType.
int	pixelStride	Indicates the distance in bytes between adjacent pixels in a row.
int	rowStride	Indicates the distance in bytes between adjacent pixel rows.

方法概要

限定符和类型	方法	说明
ByteBuffer	getBuffer()	Obtains the ByteBuffer object of the current color component.
int	read()	Reads color component data of one byte.
int	read(byte[] dstArray)	Reads color component data of multiple consecutive bytes.
int	read(byte[] dstArray, int offset, int length)	Reads color component data of multiple consecutive bytes and write the data in an array with specified offsets and length.
void	release()	Releases native resources associated with the color component.
int	remaining()	Obtains the remaining data size (in bytes) of the color component.
int	seek(int newPosition)	Sets a position of the current color component data to read.
int	tell()	Obtains the position of the current color component data to read.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

componentType

public final ImageFormat.ComponentType componentType

Indicates the color component type defined in ImageFormat.ComponentType.

从以下版本开始:

1

pixelStride

public final int pixelStride

Indicates the distance in bytes between adjacent pixels in a row.

从以下版本开始:

1

rowStride

public final int rowStride

Indicates the distance in bytes between adjacent pixel rows.

从以下版本开始:

1

方法详细资料

read

public int read()

Reads color component data of one byte.

返回:

Returns the data if the reading is successful; returns OperationResult#FAILURE constant if the reading fails; returns the OperationResult#RELEASED constant if the image or component data is released.

从以下版本开始:

1

read

public int read(byte[] dstArray)

Reads color component data of multiple consecutive bytes.

参数:

dstArray - Indicates an array to store the data.

返回:

Returns the OperationResult#SUCCESS constant if the reading is successful; returns the OperationResult#FAILURE constant if the reading fails; returns the OperationResult#RELEASED constant if the image or component data is released.

从以下版本开始:

1

read

public int read(byte[] dstArray,
                int offset,
                int length)

Reads color component data of multiple consecutive bytes and write the data in an array with specified offsets and length.

参数:

dstArray - Indicates an array to store the data.

offset - Indicates where to write the data in the target array.

length - Indicates the maximum length allowed to write data into the target array.

返回:

Returns the OperationResult#SUCCESS constant if the reading is successful; returns the OperationResult#FAILURE constant if the reading fails; returns the OperationResult#RELEASED constant if the image or component data is released.

从以下版本开始:

1

tell

public int tell()

Obtains the position of the current color component data to read.

返回:

Returns the position of the current color component data if obtained; returns the OperationResult#RELEASED if the image or component data is released.

从以下版本开始:

1

seek

public int seek(int newPosition)

Sets a position of the current color component data to read.

参数:

newPosition - Indicates a new position of the current color component data to read.

返回:

Returns the OperationResult#SUCCESS constant if the reading position is set; returns the OperationResult#FAILURE constant if the setting fails; returns the OperationResult#RELEASED constant if the image or component data is released.

从以下版本开始:

1

remaining

public int remaining()

Obtains the remaining data size (in bytes) of the color component.

返回:

Returns the bytes of the remaining data if obtained; returns the OperationResult#RELEASED if the image or component data is released.

从以下版本开始:

1

getBuffer

public ByteBuffer getBuffer()

Obtains the ByteBuffer object of the current color component. Note that the object directly maps to the native resource buffer. After the receiver or image resource is released, the object should not be used to read or write data.

返回:

Returns the ByteBuffer object of the current color component.

抛出:

IllegalStateException - Throws this exception if the operation is not supported, for example, if native resources associated with the receiver or image are released.

从以下版本开始:

1

release

public void release()

Releases native resources associated with the color component.

After this method is called, color component-related operations will no longer be supported.

从以下版本开始:

1