jp.co.cyberagent.android.gpuimage

Class GPUImage

java.lang.Object

jp.co.cyberagent.android.gpuimage.GPUImage

public class GPUImage
extends java.lang.Object

The main accessor for GPUImage functionality. This class helps to do common tasks through a simple interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GPUImage.OnPictureSavedListener
static interface	GPUImage.ResponseListener<T>
static class	GPUImage.ScaleType

Constructor Summary

Constructors

Constructor and Description
GPUImage(android.content.Context context) Instantiates a new GPUImage object.

Method Summary

Modifier and Type	Method and Description
void	deleteImage() Deletes the current image.
static void	getBitmapForMultipleFilters(android.graphics.Bitmap bitmap, java.util.List<GPUImageFilter> filters, GPUImage.ResponseListener<android.graphics.Bitmap> listener) Gets the images for multiple filters on a image.
android.graphics.Bitmap	getBitmapWithFilterApplied() Gets the current displayed image with applied filter as a Bitmap.
android.graphics.Bitmap	getBitmapWithFilterApplied(android.graphics.Bitmap bitmap) Gets the given bitmap with current filter applied as a Bitmap.
android.graphics.Bitmap	getBitmapWithFilterApplied(android.graphics.Bitmap bitmap, boolean recycle) Gets the given bitmap with current filter applied as a Bitmap.
GPUImageRenderer	getRenderer()
int[]	getScaleSize() This gets the size of the image.
void	requestRender() Request the preview to be rendered again.
void	saveToPictures(android.graphics.Bitmap bitmap, java.lang.String folderName, java.lang.String fileName, GPUImage.OnPictureSavedListener listener) Apply and save the given bitmap with applied filter to Pictures.
void	saveToPictures(java.lang.String folderName, java.lang.String fileName, GPUImage.OnPictureSavedListener listener) Save current image with applied filter to Pictures.
void	setBackgroundColor(float red, float green, float blue) Sets the background color
void	setFilter(GPUImageFilter filter) Sets the filter which should be applied to the image which was (or will be) set by setImage(...).
void	setGLSurfaceView(android.opengl.GLSurfaceView view) Sets the GLSurfaceView which will display the preview.
void	setGLTextureView(GLTextureView view) Sets the GLTextureView which will display the preview.
void	setImage(android.graphics.Bitmap bitmap) Sets the image on which the filter should be applied.
void	setImage(java.io.File file) Sets the image on which the filter should be applied from a File.
void	setImage(android.net.Uri uri) Sets the image on which the filter should be applied from a Uri.
void	setRotation(Rotation rotation) Sets the rotation of the displayed image.
void	setRotation(Rotation rotation, boolean flipHorizontal, boolean flipVertical) Sets the rotation of the displayed image with flip options.
void	setScaleType(GPUImage.ScaleType scaleType) This sets the scale type of GPUImage.
void	setUpCamera(android.hardware.Camera camera) Deprecated.
void	setUpCamera(android.hardware.Camera camera, int degrees, boolean flipHorizontal, boolean flipVertical) Deprecated.
void	updatePreviewFrame(byte[] data, int width, int height) Update camera preview frame with YUV format data.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPUImage

public GPUImage(android.content.Context context)

Instantiates a new GPUImage object.

Parameters:

context - the context

Method Detail

setGLSurfaceView

public void setGLSurfaceView(android.opengl.GLSurfaceView view)

Sets the GLSurfaceView which will display the preview.

Parameters:

view - the GLSurfaceView

setGLTextureView

public void setGLTextureView(GLTextureView view)

Sets the GLTextureView which will display the preview.

Parameters:

view - the GLTextureView

setBackgroundColor

public void setBackgroundColor(float red,
                               float green,
                               float blue)

Sets the background color

Parameters:

red - red color value

green - green color value

blue - red color value

requestRender

public void requestRender()

Request the preview to be rendered again.

setUpCamera

@Deprecated
public void setUpCamera(android.hardware.Camera camera)

Deprecated.

Deprecated: Please call updatePreviewFrame(byte[], int, int) frame by frame

Sets the up camera to be connected to GPUImage to get a filtered preview.

Parameters:

camera - the camera

setUpCamera

@Deprecated
public void setUpCamera(android.hardware.Camera camera,
                                    int degrees,
                                    boolean flipHorizontal,
                                    boolean flipVertical)

Deprecated.

Deprecated: Please call updatePreviewFrame(byte[], int, int) frame by frame

Sets the up camera to be connected to GPUImage to get a filtered preview.

Parameters:

camera - the camera

degrees - by how many degrees the image should be rotated

flipHorizontal - if the image should be flipped horizontally

flipVertical - if the image should be flipped vertically

setFilter

public void setFilter(GPUImageFilter filter)

Sets the filter which should be applied to the image which was (or will be) set by setImage(...).

Parameters:

filter - the new filter

setImage

public void setImage(android.graphics.Bitmap bitmap)

Sets the image on which the filter should be applied.

Parameters:

bitmap - the new image

updatePreviewFrame

public void updatePreviewFrame(byte[] data,
                               int width,
                               int height)

Update camera preview frame with YUV format data.

Parameters:

data - Camera preview YUV data for frame.

width - width of camera preview

height - height of camera preview

setScaleType

public void setScaleType(GPUImage.ScaleType scaleType)

This sets the scale type of GPUImage. This has to be run before setting the image. If image is set and scale type changed, image needs to be reset.

Parameters:

scaleType - The new ScaleType

getScaleSize

public int[] getScaleSize()

This gets the size of the image. This makes it easier to adjust the size of your imagePreview to the the size of the scaled image.

Returns:

array with width and height of bitmap image

setRotation

public void setRotation(Rotation rotation)

Sets the rotation of the displayed image.

Parameters:

rotation - new rotation

setRotation

public void setRotation(Rotation rotation,
                        boolean flipHorizontal,
                        boolean flipVertical)

Sets the rotation of the displayed image with flip options.

Parameters:

rotation - new rotation

deleteImage

public void deleteImage()

Deletes the current image.

setImage

public void setImage(android.net.Uri uri)

Sets the image on which the filter should be applied from a Uri.

Parameters:

uri - the uri of the new image

setImage

public void setImage(java.io.File file)

Sets the image on which the filter should be applied from a File.

Parameters:

file - the file of the new image

getBitmapWithFilterApplied

public android.graphics.Bitmap getBitmapWithFilterApplied()

Gets the current displayed image with applied filter as a Bitmap.

Returns:

the current image with filter applied

getBitmapWithFilterApplied

public android.graphics.Bitmap getBitmapWithFilterApplied(android.graphics.Bitmap bitmap)

Gets the given bitmap with current filter applied as a Bitmap.

Parameters:

bitmap - the bitmap on which the current filter should be applied

Returns:

the bitmap with filter applied

getBitmapWithFilterApplied

public android.graphics.Bitmap getBitmapWithFilterApplied(android.graphics.Bitmap bitmap,
                                                          boolean recycle)

Gets the given bitmap with current filter applied as a Bitmap.

Parameters:

bitmap - the bitmap on which the current filter should be applied

recycle - recycle the bitmap or not.

Returns:

the bitmap with filter applied

getBitmapForMultipleFilters

public static void getBitmapForMultipleFilters(android.graphics.Bitmap bitmap,
                                               java.util.List<GPUImageFilter> filters,
                                               GPUImage.ResponseListener<android.graphics.Bitmap> listener)

Gets the images for multiple filters on a image. This can be used to quickly get thumbnail images for filters.
Whenever a new Bitmap is ready, the listener will be called with the bitmap. The order of the calls to the listener will be the same as the filter order.

Parameters:

bitmap - the bitmap on which the filters will be applied

filters - the filters which will be applied on the bitmap

listener - the listener on which the results will be notified

saveToPictures

public void saveToPictures(java.lang.String folderName,
                           java.lang.String fileName,
                           GPUImage.OnPictureSavedListener listener)

Save current image with applied filter to Pictures. It will be stored on the default Picture folder on the phone below the given folderName and fileName.
This method is async and will notify when the image was saved through the listener.

Parameters:

folderName - the folder name

fileName - the file name

listener - the listener

saveToPictures

public void saveToPictures(android.graphics.Bitmap bitmap,
                           java.lang.String folderName,
                           java.lang.String fileName,
                           GPUImage.OnPictureSavedListener listener)

Apply and save the given bitmap with applied filter to Pictures. It will be stored on the default Picture folder on the phone below the given folerName and fileName.
This method is async and will notify when the image was saved through the listener.

Parameters:

bitmap - the bitmap

folderName - the folder name

fileName - the file name

listener - the listener

getRenderer

public GPUImageRenderer getRenderer()