pl.droidsonroids.gif

Class GifTexImage2D

java.lang.Object

pl.droidsonroids.gif.GifTexImage2D

@Beta
public class GifTexImage2D
extends Object

Provides support for animated GIFs in OpenGL. There are 2 possible usages:

1. Rendering GIF automatically according to its timing to internal frame buffer in the background thread, and requesting frame to be copied to 2D texture when needed. See glTexImage2D(int, int) and glTexImage2D(int, int)
2. Manual frame advancing. See seekToFrame(int) (int)}

Constructor Summary

Constructors

Constructor and Description
GifTexImage2D(InputSource inputSource, GifOptions options) Constructs new GifTexImage2D.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
int	getDuration() See GifDrawable.getDuration()
int	getFrameDuration(int index) See GifDrawable.getFrameDuration(int)
int	getHeight()
int	getNumberOfFrames()
int	getWidth()
void	glTexImage2D(int target, int level) Equivalent of GLES20.glTexImage2D(int, int, int, int, int, int, int, int, Buffer).
void	glTexSubImage2D(int target, int level) Equivalent of GLES20.glTexSubImage2D(int, int, int, int, int, int, int, int, Buffer).
void	recycle() See GifDrawable.recycle().
void	seekToFrame(int index) Seeks to given frame
void	startDecoderThread() Creates frame buffer and starts decoding thread.
void	stopDecoderThread() Stops decoder thread and releases frame buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

GifTexImage2D

public GifTexImage2D(InputSource inputSource,
                     @Nullable
                     GifOptions options)
              throws IOException

Constructs new GifTexImage2D. Decoder thread is initially stopped, use startDecoderThread() to start it.

Parameters:

inputSource - source

options - null-ok; options controlling parameters like subsampling and opacity

Throws:

IOException - when creation fails

Method Detail

getFrameDuration

public int getFrameDuration(int index)

See GifDrawable.getFrameDuration(int)

Parameters:

index - index of the frame

Returns:

duration of the given frame in milliseconds

Throws:

IndexOutOfBoundsException - if index < 0 || index >= <number of frames>

seekToFrame

public void seekToFrame(int index)

Seeks to given frame

Parameters:

index - index of the frame

Throws:

IndexOutOfBoundsException - if index < 0 || index >= <number of frames>

getNumberOfFrames

public int getNumberOfFrames()

Returns:

number of frames in GIF, at least one

glTexImage2D

public void glTexImage2D(int target,
                         int level)

Equivalent of GLES20.glTexImage2D(int, int, int, int, int, int, int, int, Buffer). Where Buffer contains pixels of the current frame.

Parameters:

level - level-of-detail number

target - target texture

glTexSubImage2D

public void glTexSubImage2D(int target,
                            int level)

Equivalent of GLES20.glTexSubImage2D(int, int, int, int, int, int, int, int, Buffer). Where Buffer contains pixels of the current frame.

Parameters:

level - level-of-detail number

target - target texture

startDecoderThread

public void startDecoderThread()

Creates frame buffer and starts decoding thread. Does nothing if already started.

stopDecoderThread

public void stopDecoderThread()

Stops decoder thread and releases frame buffer. Does nothing if already stopped.

recycle

public void recycle()

See GifDrawable.recycle(). Decoder thread is stopped automatically.

getWidth

public int getWidth()

Returns:

width of the GIF canvas, 0 if recycled

getHeight

public int getHeight()

Returns:

height of the GIF canvas, 0 if recycled

getDuration

public int getDuration()

See GifDrawable.getDuration()

Returns:

duration of of one loop the animation in milliseconds. Result is always multiple of 10.

finalize

protected final void finalize()
                       throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable