Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "add javadoc for SurfaceView {unL|l}ockCanvas{AndPost}()" into jb-mr2-dev

Browse Source
This commit is contained in:
Mathias Agopian
2013-04-18 01:29:07 +00:00
committed by Android (Google) Code Review
parent 18455c307d 9ddf32aa8a
commit bb7b315cdd
2 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
core/java/android/view/Surface.java
View File

@@ -220,14 +220,14 @@ public class Surface implements Parcelable {
/** /**
* Gets a {@link Canvas} for drawing into this surface. * Gets a {@link Canvas} for drawing into this surface.
* *
* After drawing into the provided {@link Canvas}, the caller should * After drawing into the provided {@link Canvas}, the caller must
* invoke {@link #unlockCanvasAndPost} to post the new contents to the surface. * invoke {@link #unlockCanvasAndPost} to post the new contents to the surface.
* *
* @param inOutDirty A rectangle that represents the dirty region that the caller wants * @param inOutDirty A rectangle that represents the dirty region that the caller wants
* to redraw. This function may choose to expand the dirty rectangle if for example * to redraw. This function may choose to expand the dirty rectangle if for example
* the surface has been resized or if the previous contents of the surface were * the surface has been resized or if the previous contents of the surface were
* not available. The caller should redraw the entire dirty region as represented * not available. The caller must redraw the entire dirty region as represented
* by the contents of the dirty rect upon return from this function. * by the contents of the inOutDirty rectangle upon return from this function.
* The caller may also pass <code>null</code> instead, in the case where the * The caller may also pass <code>null</code> instead, in the case where the
* entire surface should be redrawn. * entire surface should be redrawn.
* @return A canvas for drawing into the surface. * @return A canvas for drawing into the surface.

34
core/java/android/view/SurfaceView.java
View File

@@ -755,12 +755,36 @@ public class SurfaceView extends View {
mHandler.sendMessage(msg); mHandler.sendMessage(msg);
} }
/**
* Gets a {@link Canvas} for drawing into the SurfaceView's Surface
*
* After drawing into the provided {@link Canvas}, the caller must
* invoke {@link #unlockCanvasAndPost} to post the new contents to the surface.
*
* The caller must redraw the entire surface.
* @return A canvas for drawing into the surface.
*/
public Canvas lockCanvas() { public Canvas lockCanvas() {
return internalLockCanvas(null); return internalLockCanvas(null);
} }
public Canvas lockCanvas(Rect dirty) { /**
return internalLockCanvas(dirty); * Gets a {@link Canvas} for drawing into the SurfaceView's Surface
*
* After drawing into the provided {@link Canvas}, the caller must
* invoke {@link #unlockCanvasAndPost} to post the new contents to the surface.
*
* @param inOutDirty A rectangle that represents the dirty region that the caller wants
* to redraw. This function may choose to expand the dirty rectangle if for example
* the surface has been resized or if the previous contents of the surface were
* not available. The caller must redraw the entire dirty region as represented
* by the contents of the inOutDirty rectangle upon return from this function.
* The caller may also pass <code>null</code> instead, in the case where the
* entire surface should be redrawn.
* @return A canvas for drawing into the surface.
*/
public Canvas lockCanvas(Rect inOutDirty) {
return internalLockCanvas(inOutDirty);
} }
private final Canvas internalLockCanvas(Rect dirty) { private final Canvas internalLockCanvas(Rect dirty) {
@@ -810,6 +834,12 @@ public class SurfaceView extends View {
return null; return null;
} }
/**
* Posts the new contents of the {@link Canvas} to the surface and
* releases the {@link Canvas}.
*
* @param canvas The canvas previously obtained from {@link #lockCanvas}.
*/
public void unlockCanvasAndPost(Canvas canvas) { public void unlockCanvasAndPost(Canvas canvas) {
mSurface.unlockCanvasAndPost(canvas); mSurface.unlockCanvasAndPost(canvas);
mSurfaceLock.unlock(); mSurfaceLock.unlock();