org.andengine.opengl.texture.render

Class RenderTexture

java.lang.Object

org.andengine.opengl.texture.Texture

org.andengine.opengl.texture.render.RenderTexture

All Implemented Interfaces:

ITexture

public class RenderTexture
extends Texture

The general workflow with a RenderTexture is: init(GLState) -> begin(GLState) -> end(GLState) -> destroy(GLState). (c) Zynga 2011

Since:

07:13:05 - 24.08.2011

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mFramebufferObjectID
protected int	mHeight
protected PixelFormat	mPixelFormat
protected int	mWidth

Fields inherited from class org.andengine.opengl.texture.Texture

HARDWARE_TEXTURE_ID_INVALID, mHardwareTextureID, mTextureManager, mTextureOptions, mTextureStateListener, mUpdateOnHardwareNeeded

Constructor Summary

Constructors

Constructor and Description
RenderTexture(TextureManager pTextureManager, int pWidth, int pHeight)
RenderTexture(TextureManager pTextureManager, int pWidth, int pHeight, PixelFormat pPixelFormat)
RenderTexture(TextureManager pTextureManager, int pWidth, int pHeight, PixelFormat pPixelFormat, TextureOptions pTextureOptions)
RenderTexture(TextureManager pTextureManager, int pWidth, int pHeight, PixelFormat pPixelFormat, TextureOptions pTextureOptions, ITextureStateListener pTextureStateListener)
RenderTexture(TextureManager pTextureManager, int pWidth, int pHeight, TextureOptions pTextureOptions)

Method Summary

Modifier and Type	Method and Description
void	begin(GLState pGLState)
void	begin(GLState pGLState, boolean pFlipX, boolean pFlipY)
void	begin(GLState pGLState, boolean pFlipX, boolean pFlipY, Color pColor)
void	begin(GLState pGLState, boolean pFlipX, boolean pFlipY, float pRed, float pGreen, float pBlue, float pAlpha)
void	begin(GLState pGLState, Color pColor)
void	begin(GLState pGLState, float pRed, float pGreen, float pBlue, float pAlpha)
void	destroy(GLState pGLState)
void	end(GLState pGLState)
void	end(GLState pGLState, boolean pFlush, boolean pFinish)
void	finish(GLState pGLState)
void	flush(GLState pGLState)
android.graphics.Bitmap	getBitmap(GLState pGLState)
android.graphics.Bitmap	getBitmap(GLState pGLState, int pX, int pY, int pWidth, int pHeight)
int	getHeight()
int[]	getPixelsARGB_8888(GLState pGLState)
int[]	getPixelsARGB_8888(GLState pGLState, int pX, int pY, int pWidth, int pHeight)
int	getWidth()
void	init(GLState pGLState)
boolean	isInitialized()
protected void	resotorePreviousViewport()
protected void	restorePreviousFramebufferObjectID(GLState pGLState)
protected void	savePreviousFramebufferObjectID(GLState pGLState)
protected void	savePreviousViewport()
protected void	writeTextureToHardware(GLState pGLState)

Methods inherited from class org.andengine.opengl.texture.Texture

bind, bind, getHardwareTextureID, getPixelFormat, getTextureOptions, getTextureStateListener, hasTextureStateListener, isLoadedToHardware, isUpdateOnHardwareNeeded, load, load, loadToHardware, reloadToHardware, setNotLoadedToHardware, setTextureStateListener, setUpdateOnHardwareNeeded, unload, unload, unloadFromHardware

Methods inherited from class java.lang.Object

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

Field Detail

mPixelFormat

protected final PixelFormat mPixelFormat

mWidth

protected final int mWidth

mHeight

protected final int mHeight

mFramebufferObjectID

protected int mFramebufferObjectID

Constructor Detail

RenderTexture

public RenderTexture(TextureManager pTextureManager,
                     int pWidth,
                     int pHeight)

RenderTexture

public RenderTexture(TextureManager pTextureManager,
                     int pWidth,
                     int pHeight,
                     PixelFormat pPixelFormat)

RenderTexture

public RenderTexture(TextureManager pTextureManager,
                     int pWidth,
                     int pHeight,
                     TextureOptions pTextureOptions)

RenderTexture

public RenderTexture(TextureManager pTextureManager,
                     int pWidth,
                     int pHeight,
                     PixelFormat pPixelFormat,
                     TextureOptions pTextureOptions)

RenderTexture

public RenderTexture(TextureManager pTextureManager,
                     int pWidth,
                     int pHeight,
                     PixelFormat pPixelFormat,
                     TextureOptions pTextureOptions,
                     ITextureStateListener pTextureStateListener)

Method Detail

getWidth

public int getWidth()

getHeight

public int getHeight()

isInitialized

public boolean isInitialized()

writeTextureToHardware

protected void writeTextureToHardware(GLState pGLState)

Specified by:

writeTextureToHardware in class Texture

init

public void init(GLState pGLState)
          throws GLFrameBufferException,
                 GLException

Parameters:

pGLState -

Throws:

RenderTextureInitializationException - when this RenderTexture could not be initialized. The GLException contains the error code. When this exception is throw, all cleanup will be automatically performed through destroy(GLState).

GLFrameBufferException

GLException

begin

public void begin(GLState pGLState)

See Also:

RenderTexture#end(GLState)}, {@link RenderTexture#end(GLState, boolean, boolean}}.

begin

public void begin(GLState pGLState,
                  Color pColor)

Parameters:

pColor - the Color to clear this RenderTexture.

See Also:

RenderTexture#end(GLState)}, {@link RenderTexture#end(GLState, boolean, boolean}}.

begin

public void begin(GLState pGLState,
                  float pRed,
                  float pGreen,
                  float pBlue,
                  float pAlpha)

Parameters:

pRed - the red portion of the color to clear this RenderTexture.

pGreen - the green portion of the color to clear this RenderTexture.

pBlue - the blue portion of the color to clear this RenderTexture.

pAlpha - the alpha portion of the color to clear this RenderTexture.

See Also:

RenderTexture#end(GLState)}, {@link RenderTexture#end(GLState, boolean, boolean}}.

begin

public void begin(GLState pGLState,
                  boolean pFlipX,
                  boolean pFlipY,
                  Color pColor)

Parameters:

pColor - the Color to clear this RenderTexture.

See Also:

RenderTexture#end(GLState)}, {@link RenderTexture#end(GLState, boolean, boolean}}.

begin

public void begin(GLState pGLState,
                  boolean pFlipX,
                  boolean pFlipY,
                  float pRed,
                  float pGreen,
                  float pBlue,
                  float pAlpha)

Parameters:

pRed - the red portion of the color to clear this RenderTexture.

pGreen - the green portion of the color to clear this RenderTexture.

pBlue - the blue portion of the color to clear this RenderTexture.

pAlpha - the alpha portion of the color to clear this RenderTexture.

See Also:

RenderTexture#end(GLState)}, {@link RenderTexture#end(GLState, boolean, boolean}}.

begin

public void begin(GLState pGLState,
                  boolean pFlipX,
                  boolean pFlipY)

See Also:

RenderTexture#end(GLState)}, {@link RenderTexture#end(GLState, boolean, boolean}}.

flush

public void flush(GLState pGLState)

See Also:

GLState#flush()}.

finish

public void finish(GLState pGLState)

See Also:

GLState#finish()}.

end

public void end(GLState pGLState)

See Also:

RenderTexture#begin(GLState)}, {@link RenderTexture#begin(GLState, boolean, boolean)}, {@link RenderTexture#begin(GLState, Color)}, {@link RenderTexture#begin(GLState, float, float, float, float)}, {@link RenderTexture#begin(GLState, boolean, boolean, Color)}. {@link RenderTexture#begin(GLState, boolean, boolean, float, float, float, float)}.

end

public void end(GLState pGLState,
                boolean pFlush,
                boolean pFinish)

Parameters:

pGLState -

pFlush - GLState.flush() has lower preference than pFinish.

pFinish - GLState.finish() had higher preference than pFlush.

See Also:

RenderTexture#begin(GLState)}, {@link RenderTexture#begin(GLState, boolean, boolean)}, {@link RenderTexture#begin(GLState, Color)}, {@link RenderTexture#begin(GLState, float, float, float, float)}, {@link RenderTexture#begin(GLState, boolean, boolean, Color)}. {@link RenderTexture#begin(GLState, boolean, boolean, float, float, float, float)}.

destroy

public void destroy(GLState pGLState)

savePreviousFramebufferObjectID

protected void savePreviousFramebufferObjectID(GLState pGLState)

restorePreviousFramebufferObjectID

protected void restorePreviousFramebufferObjectID(GLState pGLState)

savePreviousViewport

protected void savePreviousViewport()

resotorePreviousViewport

protected void resotorePreviousViewport()

getPixelsARGB_8888

public int[] getPixelsARGB_8888(GLState pGLState)

getPixelsARGB_8888

public int[] getPixelsARGB_8888(GLState pGLState,
                                int pX,
                                int pY,
                                int pWidth,
                                int pHeight)

getBitmap

public android.graphics.Bitmap getBitmap(GLState pGLState)

getBitmap

public android.graphics.Bitmap getBitmap(GLState pGLState,
                                         int pX,
                                         int pY,
                                         int pWidth,
                                         int pHeight)