PixelMap

java.lang.Object
- ohos.media.image.PixelMap

所有已实现的接口:

Sequenceable
```
public class PixelMap
extends Object
implements Sequenceable
```
Provides images in forms of pixel matrices.
Applications can use methods, such as getImageInfo(), to obtain basic image information.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#IMAGE

嵌套类概要

嵌套类
限定符和类型类说明

static class PixelMap.InitializationOptions
Represents pixel map initialization options, including the image size, pixel format, and alpha type.
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

嵌套类
限定符和类型	类	说明
`static class`	`PixelMap.InitializationOptions`	Represents pixel map initialization options, including the image size, pixel format, and alpha type.

字段概要

字段
限定符和类型字段说明

static Sequenceable.Producer<PixelMap> PRODUCER
Creates a PixelMap instance from a Parcel.

字段
限定符和类型	字段	说明
`static Sequenceable.Producer<PixelMap>`	`PRODUCER`	Creates a `PixelMap` instance from a `Parcel`.

构造器概要

构造器
限定符构造器说明

protected PixelMap(long nativeImagePixelMap, long nativeAllocBytes)
A constructor used to create a PixelMap instance.

构造器
限定符	构造器	说明
`protected`	`PixelMap(long nativeImagePixelMap, long nativeAllocBytes)`	A constructor used to create a `PixelMap` instance.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static PixelMap`	`create(int[] colors, int offset, int stride, PixelMap.InitializationOptions opts)`	Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a pixel color array, start offset, and number of pixels in a row.
`static PixelMap`	`create(int[] colors, PixelMap.InitializationOptions opts)`	Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a pixel color array.
`static PixelMap`	`create(PixelMap.InitializationOptions opts)`	Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type).
`static PixelMap`	`create(PixelMap source, Rect srcRegion, PixelMap.InitializationOptions opts)`	Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a source pixel map and the expected area on it.
`static PixelMap`	`create(PixelMap source, PixelMap.InitializationOptions opts)`	Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a source pixel map.
`PixelMap`	`createFromAlpha()`	Creates a `PixelMap` using the alpha channel of this `PixelMap`.
`protected void`	`finalize()`	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`int`	`getBaseDensity()`	Obtains the base pixel density of this `PixelMap`.
`int`	`getBytesNumberPerRow()`	Obtains the number of bytes in each row of pixels.
`Size`	`getFitDensitySize(int targetDensity)`	Obtains the image size that fits the specified pixel density.
`ImageInfo`	`getImageInfo()`	Obtains basic image information.
`byte[]`	`getNinePatchChunk()`	Obtains 9 patch chunk data of this `PixelMap`.
`long`	`getPixelBytesCapacity()`	Obtains the memory capacity for storing the pixels of this `PixelMap`.
`long`	`getPixelBytesNumber()`	Obtains the pixel data size in bytes.
`boolean`	`isEditable()`	Checks whether this `PixelMap` can be edited.
`boolean`	`isReleased()`	Checks whether native resources have been released.
`boolean`	`isSameImage(PixelMap other)`	Checks whether this `PixelMap` is the same as the specified one, including the attribute information described by the `ImageInfo` instance and pixel data.
`boolean`	`marshalling(Parcel out)`	Writes a `PixelMap` object into a `Parcel`.
`int`	`readPixel(Position pos)`	Reads the color value at the specified position.
`void`	`readPixels(int[] pixels, int offset, int stride, Rect region)`	Reads the color values of a specified region and writes them into a `pixels` array with the specified start offset and stride.
`void`	`readPixels(Buffer dst)`	Reads a copy of color values of this `PixelMap` instance and stores it to the specified buffer.
`void`	`release()`	Releases native resources associated with an object.
`void`	`resetConfig(Size size, PixelFormat pixelFormat)`	Resets the size and pixel format of this `PixelMap`.
`void`	`setAlphaType(AlphaType alphaType)`	Sets the alpha type of this `PixelMap`.
`void`	`setBaseDensity(int baseDensity)`	Sets the base pixel density of this `PixelMap`.
`void`	`setUseMipmap(boolean useMipmap)`	Sets whether MIP mapping will be used for rendering this `PixelMap`.
`boolean`	`unmarshalling(Parcel in)`	Restores a `PixelMap` object from a `Parcel`.
`boolean`	`useMipmap()`	Checks whether MIP mapping will be used for rendering this `PixelMap`.
`void`	`writePixel(Position pos, int color)`	Writes the color value into the specified position.
`void`	`writePixels(int color)`	Writes the specified color value into this `PixelMap`.
`void`	`writePixels(int[] pixels, int offset, int stride, Rect region)`	Writes data from the specified color data array (based on the start offset and stride) into the specified region of this `PixelMap`.
`void`	`writePixels(Buffer src)`	Writes the pixel data in the specified buffer into this `PixelMap`.

从类继承的方法 java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - PRODUCER
```
public static final Sequenceable.Producer<PixelMap> PRODUCER
```
    Creates a PixelMap instance from a Parcel. If the class has a final member variable whose value cannot be changed by Sequenceable#unmarshalling.
    
    从以下版本开始:
    
    1
- 构造器详细资料
  - PixelMap
```
protected PixelMap(long nativeImagePixelMap,
                   long nativeAllocBytes)
```
    A constructor used to create a PixelMap instance.
    
    参数:
    
    nativeImagePixelMap - the native object pointer.
    
    nativeAllocBytes - the native object size.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - create
```
public static PixelMap create(int[] colors,
                              PixelMap.InitializationOptions opts)
```
    Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a pixel color array.
    参数:
    
    colors - Indicates an int array of pixel colors. Each element in the array is in PixelFormat#ARGB_8888 format.
    
    opts - Indicates initialization options of the pixel map.
    
    返回:
    
    Returns the PixelMap instance if the creation is successful; returns null otherwise.
    
    抛出:
    IllegalArgumentException - Throws this exception if any of the following occurs:
    The image size is null.
    
    The width and height are less than or equal to 0.
    
    The length of the pixel color array is less than the number of image pixels.
    从以下版本开始:
    
    3
  - create
```
public static PixelMap create(int[] colors,
                              int offset,
                              int stride,
                              PixelMap.InitializationOptions opts)
```
    Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a pixel color array, start offset, and number of pixels in a row.
    参数:
    
    colors - Indicates an int array of color values. Each element in the array is in PixelFormat#ARGB_8888 format.
    
    offset - Indicates the offset from where to read pixel color data in the array.
    
    stride - Indicates the number of pixel color elements in each row of the array. The value must be greater than or equal to the width of the pixel map to be created.
    
    opts - Indicates initialization options of the pixel map.
    
    返回:
    
    Returns the PixelMap instance if the creation is successful; returns null otherwise.
    
    抛出:
    IllegalArgumentException - Throws this exception if any of the following occurs:
    The image size is null.
    
    The width and height are less than or equal to 0.
    
    The number of available elements in the array is less than the number of image pixels.
    
    The value of stride is smaller than the width of the pixel map.
    从以下版本开始:
    
    3
  - create
```
public static PixelMap create(PixelMap.InitializationOptions opts)
```
    Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type).
    
    参数:
    
    opts - Indicates initialization options of the pixel map.
    
    返回:
    
    Returns the PixelMap instance if the creation is successful; returns null otherwise.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the image size is null, or the width and height are less than or equal to 0.
    
    从以下版本开始:
    
    3
  - create
```
public static PixelMap create(PixelMap source,
                              PixelMap.InitializationOptions opts)
```
    Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a source pixel map.
    参数:
    
    source - Indicates the PixelMap instance as the data source.
    
    opts - Indicates initialization options of the pixel map. If the value is null, the target pixel map will be created from a copy of the source pixel map.
    
    返回:
    
    Returns the new PixelMap instance if the creation is successful; returns null otherwise.
    
    抛出:
    IllegalArgumentException - Throws this exception if any of the following occurs:
    The source pixel map is null.
    
    Native resources associated with the source pixel map have been released.
    
    The image width or height specified in opts is less than 0.
    从以下版本开始:
    
    3
  - create
```
public static PixelMap create(PixelMap source,
                              Rect srcRegion,
                              PixelMap.InitializationOptions opts)
```
    Creates a pixel map based on initialization options (such as the image size, pixel format, and alpha type) and the data source described by a source pixel map and the expected area on it.
    参数:
    
    source - Indicates the source PixelMap.
    
    srcRegion - Indicates the expected region on the source pixel map.
    
    opts - Indicates initialization options of the pixel map. If this parameter is null, the new pixel map will be a copy of the source pixel map.
    
    返回:
    
    Returns the new PixelMap instance if the creation is successful; returns null otherwise.
    
    抛出:
    IllegalArgumentException - Throws this exception if any of the following occurs:
    The source pixel map is null.
    
    Native resources associated with the source pixel map have been released.
    
    The srcRegion is out of the source pixel map.
    
    The image width or height specified in opts is less than 0.
    从以下版本开始:
    
    3
  - getImageInfo
```
public ImageInfo getImageInfo()
```
    Obtains basic image information.
    Basic image information is provided by ImageInfo, including the image size, pixel format, and color space.
    
    返回:
    
    Returns an ImageInfo object.
    
    从以下版本开始:
    
    1
  - release
```
public void release()
```
    Releases native resources associated with an object.
    
    从以下版本开始:
    
    1
  - finalize
```
protected void finalize()
                 throws Throwable
```
    从类复制的说明: Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    覆盖:
    
    finalize 在类中 Object
    
    抛出:
    
    Throwable - the Exception raised by this method
    
    另请参阅:
    
    WeakReference, PhantomReference
  - getNinePatchChunk
```
public byte[] getNinePatchChunk()
```
    Obtains 9 patch chunk data of this PixelMap.
    
    返回:
    
    Returns the 9 patch chunk data if any; returns null otherwise.
    
    从以下版本开始:
    
    3
  - isReleased
```
public boolean isReleased()
```
    Checks whether native resources have been released.
    
    返回:
    
    Returns true if resources are released; returns false otherwise.
    
    从以下版本开始:
    
    1
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Writes a PixelMap object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object to which the PixelMap object will be written.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Restores a PixelMap object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object into which the PixelMap object has been written.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getBytesNumberPerRow
```
public int getBytesNumberPerRow()
```
    Obtains the number of bytes in each row of pixels.
    
    返回:
    
    Returns the number of bytes.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - getPixelBytesNumber
```
public long getPixelBytesNumber()
```
    Obtains the pixel data size in bytes.
    
    返回:
    
    Returns the number of bytes of all the pixel data.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - getPixelBytesCapacity
```
public long getPixelBytesCapacity()
```
    Obtains the memory capacity for storing the pixels of this PixelMap.
    
    返回:
    
    Returns the memory capacity.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - isEditable
```
public boolean isEditable()
```
    Checks whether this PixelMap can be edited.
    
    返回:
    
    Returns true if the pixel map is editable; returns false otherwise.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - isSameImage
```
public boolean isSameImage(PixelMap other)
```
    Checks whether this PixelMap is the same as the specified one, including the attribute information described by the ImageInfo instance and pixel data.
    
    参数:
    
    other - Indicates the specified PixelMap to compare.
    
    返回:
    
    Returns true if the two images are the same; returns false otherwise.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the specified PixelMap is empty.
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - readPixel
```
public int readPixel(Position pos)
```
    Reads the color value at the specified position.
    
    参数:
    
    pos - Indicates the coordinate of the pixel.
    
    返回:
    
    Returns the color value, which is of the AlphaType#UNPREMUL type and in PixelFormat#ARGB_8888 format.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the passed coordinate position is null or out of the valid range of the image.
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - readPixels
```
public void readPixels(int[] pixels,
                       int offset,
                       int stride,
                       Rect region)
```
    Reads the color values of a specified region and writes them into a pixels array with the specified start offset and stride. The color values are of the AlphaType#UNPREMUL type and in PixelFormat#ARGB_8888 format.
    参数:
    
    pixels - Indicates the array storing the color value copies.
    
    offset - Indicates the offset into which the color values will be written.
    
    stride - Indicates the number of color values stored in each row of the array. The parameter value must be greater than or equal to the width of the specified source region.
    
    region - Indicates the source region to obtain the color values.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    IllegalArgumentException - Throws this exception if any of the following occurs:
    The pixels array is null.
    
    The offset value is less than 0 or larger than the pixels array length.
    
    The stride value is less than 0.
    
    The region value is null or out of the valid range of the image.
    ArrayIndexOutOfBoundsException - Throws this exception if the pixels array is too small to accommodate the color values.
    
    从以下版本开始:
    
    3
  - readPixels
```
public void readPixels(Buffer dst)
```
    Reads a copy of color values of this PixelMap instance and stores it to the specified buffer.
    
    参数:
    
    dst - Indicates the buffer storing the color value copies.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    IllegalArgumentException - Throws this exception if the buffer is null or the format is not supported.
    
    ArrayIndexOutOfBoundsException - Throws this exception if the size of the color values exceeds the buffer capacity.
    
    从以下版本开始:
    
    3
  - resetConfig
```
public void resetConfig(Size size,
                        PixelFormat pixelFormat)
```
    Resets the size and pixel format of this PixelMap. This method does not change the original pixel data, or reallocate the memory for storing the pixel data.
    
    参数:
    
    size - Indicates the target image size after the reset, in bytes. The value must not exceed the memory occupied by this PixelMap.
    
    pixelFormat - Indicates pixel format to reset.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released, or the PixelMap cannot be edited.
    
    IllegalArgumentException - Throws this exception if the memory capacity required by the target image size and pixel format exceeds the available capacity.
    
    从以下版本开始:
    
    3
  - setAlphaType
```
public void setAlphaType(AlphaType alphaType)
```
    Sets the alpha type of this PixelMap.
    
    参数:
    
    alphaType - Indicates the AlphaType to set.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released, or the PixelMap cannot be edited.
    
    IllegalArgumentException - Throws this exception if the input AlphaType is invalid.
    
    从以下版本开始:
    
    3
  - writePixel
```
public void writePixel(Position pos,
                       int color)
```
    Writes the color value into the specified position.
    
    参数:
    
    pos - Indicates the coordinate position to write the pixel value.
    
    color - Indicates the color value to write, which is of the AlphaType#UNPREMUL type and in PixelFormat#ARGB_8888 format.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released, or the PixelMap cannot be edited.
    
    IllegalArgumentException - Throws this exception if the coordinate position is null or out of the valid range of the image.
    
    从以下版本开始:
    
    3
  - writePixels
```
public void writePixels(int[] pixels,
                        int offset,
                        int stride,
                        Rect region)
```
    Writes data from the specified color data array (based on the start offset and stride) into the specified region of this PixelMap. The color data to write is of the AlphaType#UNPREMUL type and in PixelFormat#ARGB_8888 format.
    参数:
    
    pixels - Indicates the array of color data.
    
    offset - Indicates the offset from which the color data will be read.
    
    stride - Indicates the number of pixels in each row of the array. The value must be greater than or equal to the width of the target region in this PixelMap.
    
    region - Indicates the target pixel map region into which the data will be written.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released, or the PixelMap cannot be edited.
    IllegalArgumentException - Throws this exception if any of the following occurs:
    The pixels array is null.
    
    The offset value is less than 0 or larger than the pixels array length.
    
    The stride value is less than 0.
    
    The region value is out of the valid range of the image.
    从以下版本开始:
    
    3
  - writePixels
```
public void writePixels(Buffer src)
```
    Writes the pixel data in the specified buffer into this PixelMap. The buffer data will overwrite the PixelMap data, so the color format of the source data must be compatible with this PixelMap.
    
    参数:
    
    src - Indicates the buffer whose pixel data will be written.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released, or the PixelMap cannot be edited.
    
    IllegalArgumentException - Throws this exception if the buffer is null or the format is not supported.
    
    ArrayIndexOutOfBoundsException - Throws this exception if the data in the buffer is insufficient to fill the PixelMap.
    
    从以下版本开始:
    
    3
  - writePixels
```
public void writePixels(int color)
```
    Writes the specified color value into this PixelMap.
    
    参数:
    
    color - Indicates the color value to write, which is of the AlphaType#UNPREMUL type and in PixelFormat#ARGB_8888 format.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released, or the PixelMap cannot be edited.
    
    从以下版本开始:
    
    3
  - setBaseDensity
```
public void setBaseDensity(int baseDensity)
```
    Sets the base pixel density of this PixelMap.
    
    参数:
    
    baseDensity - Indicates the base pixel density to set.
    
    从以下版本开始:
    
    3
  - getBaseDensity
```
public int getBaseDensity()
```
    Obtains the base pixel density of this PixelMap.
    
    返回:
    
    Returns the base pixel density.
    
    从以下版本开始:
    
    3
  - setUseMipmap
```
public final void setUseMipmap(boolean useMipmap)
```
    Sets whether MIP mapping will be used for rendering this PixelMap.
    
    参数:
    
    useMipmap - Specifies whether to use MIP mapping. Set it to true if the renderer will use MIP mapping and to false otherwise.
    
    从以下版本开始:
    
    3
  - useMipmap
```
public final boolean useMipmap()
```
    Checks whether MIP mapping will be used for rendering this PixelMap.
    
    返回:
    
    Returns true if the renderer will try MIP mapping; returns false otherwise.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - getFitDensitySize
```
public Size getFitDensitySize(int targetDensity)
```
    Obtains the image size that fits the specified pixel density.
    
    参数:
    
    targetDensity - Indicates the pixel density.
    
    返回:
    
    Returns the image size fitting the specified pixel density.
    
    抛出:
    
    IllegalStateException - Throws this exception if native resources associated with this PixelMap have been released.
    
    从以下版本开始:
    
    3
  - createFromAlpha
```
public PixelMap createFromAlpha()
```
    Creates a PixelMap using the alpha channel of this PixelMap.
    
    返回:
    
    Returns the new PixelMap containing only the alpha channel.
    
    从以下版本开始:
    
    4

类 PixelMap

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

构造器概要

方法概要

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

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

PRODUCER

构造器详细资料

PixelMap

方法详细资料

create

create

create

create

create

getImageInfo

release

finalize

getNinePatchChunk

isReleased

marshalling

unmarshalling

getBytesNumberPerRow

getPixelBytesNumber

getPixelBytesCapacity

isEditable

isSameImage

readPixel

readPixels

readPixels

resetConfig

setAlphaType

writePixel

writePixels

writePixels

writePixels

setBaseDensity

getBaseDensity

setUseMipmap

useMipmap

getFitDensitySize

createFromAlpha