ContextQMD
Back to Fresco

WebPImage

docs/javadoc/reference/com/facebook/animated/webp/WebPImage.html

3.6.022.1 KB
Original Source

Fresco

|

|

Packages | Classes

Classes

Packages | Classes

Summary: Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

WebPImage

extends Object
implements AnimatedImageAnimatedImageDecoder

| java.lang.Object | | ↳ | com.facebook.animated.webp.WebPImage |

Class Overview

A representation of a WebP image. An instance of this class will hold a copy of the encoded data in memory along with the parsed header data. Frames are decoded on demand via WebPFrame.

Summary

| [Expand] Inherited Constants | | --- | | From interface com.facebook.imagepipeline.animated.base.AnimatedImage

| int | LOOP_COUNT_INFINITE | |

|

Public Constructors
Public Methods
static WebPImage
Creates a WebPImage from the specified encoded data.
static WebPImage
Creates a WebPImage from a ByteBuffer containing the image.
static WebPImage
AnimatedImage
Factory method to create the AnimatedImage from a ByteBuffer
AnimatedImage
Factory method to create the AnimatedImage from a native pointer
void
Disposes the instance.
boolean
Returns whether renderFrame(int, int, Bitmap) supports scaling to arbitrary sizes or whether scaling must be done externally.
int
Gets the duration of the animated image.
WebPFrame
Creates an AnimatedImageFrame at the specified index.
int
Gets the number of frames in the image.
int[]
Gets the duration of each frame of the animated image.
AnimatedDrawableFrameInfo
Gets the frame info for the specified frame.
int
Gets the height of the image (also known as the canvas in WebP nomenclature).
int
Gets the number of loops to run the animation for.
int
Gets the size of bytes of the encoded image data (which is the data kept in memory for the image).
int
Gets the width of the image (also known as the canvas in WebP nomenclature).
Protected Methods
void

| [Expand] Inherited Methods | | --- | | From class java.lang.Object

| Object | clone() | | boolean | equals(Object arg0) | | void | finalize() | | final Class<?> | getClass() | | int | hashCode() | | final void | notify() | | final void | notifyAll() | | String | toString() | | final void | wait(long arg0, int arg1) | | final void | wait(long arg0) | | final void | wait() |

| | From interface com.facebook.imagepipeline.animated.base.AnimatedImage

| abstract void | dispose() Disposes the instance. | | abstract boolean | doesRenderSupportScaling() Returns whether renderFrame(int, int, Bitmap) supports scaling to arbitrary sizes or whether scaling must be done externally. | | abstract int | getDuration() Gets the duration of the animated image. | | abstract AnimatedImageFrame | getFrame(int frameNumber) Creates an AnimatedImageFrame at the specified index. | | abstract int | getFrameCount() Gets the number of frames in the image. | | abstract int[] | getFrameDurations() Gets the duration of each frame of the animated image. | | abstract AnimatedDrawableFrameInfo | getFrameInfo(int frameNumber) Gets the frame info for the specified frame. | | abstract int | getHeight() Gets the height of the image (also known as the canvas in WebP nomenclature). | | abstract int | getLoopCount() Gets the number of loops to run the animation for. | | abstract int | getSizeInBytes() Gets the size of bytes of the encoded image data (which is the data kept in memory for the image). | | abstract int | getWidth() Gets the width of the image (also known as the canvas in WebP nomenclature). |

| | From interface com.facebook.imagepipeline.animated.factory.AnimatedImageDecoder

| abstract AnimatedImage | decodeFromByteBuffer(ByteBuffer byteBuffer, ImageDecodeOptions options) Factory method to create the AnimatedImage from a ByteBuffer | | abstract AnimatedImage | decodeFromNativeMemory(long nativePtr, int sizeInBytes, ImageDecodeOptions options) Factory method to create the AnimatedImage from a native pointer |

|

Public Constructors

public WebPImage()

Public Methods

public static WebPImage createFromByteArray(byte[] source)

Creates a WebPImage from the specified encoded data. This will throw if it fails to create. This is meant to be called on a worker thread.

Parameters

| source | the data to the image (a copy will be made) |

public static WebPImage createFromByteBuffer(ByteBuffer byteBuffer)

Creates a WebPImage from a ByteBuffer containing the image. This will throw if it fails to create.

Parameters

| byteBuffer | the ByteBuffer containing the image |

public static WebPImage createFromNativeMemory(long nativePtr, int sizeInBytes)

public AnimatedImage decodeFromByteBuffer(ByteBuffer byteBuffer, ImageDecodeOptions options)

Factory method to create the AnimatedImage from a ByteBuffer

Parameters

| byteBuffer | The ByteBuffer containing the image | | options | The options for decoding |

Returns
  • The AnimatedImage allocation

public AnimatedImage decodeFromNativeMemory(long nativePtr, int sizeInBytes, ImageDecodeOptions options)

Factory method to create the AnimatedImage from a native pointer

Parameters

| nativePtr | The native pointer | | sizeInBytes | The size in byte to allocate | | options | The options for decoding |

Returns
  • The AnimatedImage allocation

public void dispose()

Disposes the instance. This will free native resources held by this instance. Once called, other methods on this instance may throw. Note, the underlying native resources may not actually be freed until all associated instances of AnimatedImageFrame are disposed or finalized as well.

public boolean doesRenderSupportScaling()

Returns whether renderFrame(int, int, Bitmap) supports scaling to arbitrary sizes or whether scaling must be done externally.

Returns
  • whether rendering supports scaling

public int getDuration()

Gets the duration of the animated image.

Returns
  • the duration of the animated image in milliseconds

public WebPFrame getFrame(int frameNumber)

Creates an AnimatedImageFrame at the specified index.

Parameters

| frameNumber | the index of the frame |

Returns
  • a newly created AnimatedImageFrame

public int getFrameCount()

Gets the number of frames in the image.

Returns
  • the number of frames in the image

public int[] getFrameDurations()

Gets the duration of each frame of the animated image.

Returns
  • an array that is the size of the number of frames containing the duration of each frame in milliseconds

public AnimatedDrawableFrameInfo getFrameInfo(int frameNumber)

Gets the frame info for the specified frame.

Parameters

| frameNumber | the frame to get the info for |

Returns
  • the frame info

public int getHeight()

Gets the height of the image (also known as the canvas in WebP nomenclature).

Returns
  • the height of the image

public int getLoopCount()

Gets the number of loops to run the animation for.

Returns
  • the number of loops, or 0 to indicate infinite

public int getSizeInBytes()

Gets the size of bytes of the encoded image data (which is the data kept in memory for the image).

Returns
  • the size in bytes of the encoded image data

public int getWidth()

Gets the width of the image (also known as the canvas in WebP nomenclature).

Returns
  • the width of the image

Protected Methods

protected void finalize()

+Generated by Doclava. +