File	Doc	Category	Size	Date	Package
RenderNode.java	API Doc	Android 5.1 API	33478	Thu Mar 12 22:22:10 GMT 2015	android.view

RenderNode

• java.lang.Object

HardwareRenderer renderer = myView.getHardwareRenderer();
if (renderer != null) {
DisplayList displayList = renderer.createDisplayList();
HardwareCanvas canvas = displayList.start(width, height);
try {
// Draw onto the canvas
// For instance: canvas.drawBitmap(...);
} finally {
displayList.end();
}
}

protected void onDraw(Canvas canvas) {
if (canvas.isHardwareAccelerated()) {
HardwareCanvas hardwareCanvas = (HardwareCanvas) canvas;
hardwareCanvas.drawDisplayList(mDisplayList);
}
}

// Mark this display list invalid, it cannot be used for drawing anymore,
// and release resources held by this display list
displayList.clear();

private void createDisplayList() {
mDisplayList = DisplayList.create("MyDisplayList");
HardwareCanvas canvas = mDisplayList.start(width, height);
try {
for (Bitmap b : mBitmaps) {
canvas.drawBitmap(b, 0.0f, 0.0f, null);
canvas.translate(0.0f, b.getHeight());
}
} finally {
displayList.end();
}
}

protected void onDraw(Canvas canvas) {
if (canvas.isHardwareAccelerated()) {
HardwareCanvas hardwareCanvas = (HardwareCanvas) canvas;
hardwareCanvas.drawDisplayList(mDisplayList);
}
}

private void moveContentBy(int x) {
// This will move all the bitmaps recorded inside the display list
// by x pixels to the right and redraw this view. All the commands
// recorded in createDisplayList() won't be re-issued, only onDraw()
// will be invoked and will execute very quickly
mDisplayList.offsetLeftAndRight(x);
invalidate();
}

Fields Summary
public static final int	FLAG_CLIP_CHILDREN Flag used when calling {@link HardwareCanvas#drawRenderNode(RenderNode, android.graphics.Rect, int)} When this flag is set, draw operations lying outside of the bounds of the display list will be culled early. It is recommeneded to always set this flag.
public static final int	STATUS_DONE Indicates that the display list is done drawing.
public static final int	STATUS_DRAW Indicates that the display list needs another drawing pass.
public static final int	STATUS_INVOKE Indicates that the display list needs to re-execute its GL functors.
public static final int	STATUS_DREW Indicates that the display list performed GL drawing operations.
private boolean	mValid
final long	mNativeRenderNode
private final View	mOwningView

Constructors Summary
private RenderNode(String name, View owningView) mNativeRenderNode = nCreate(name); mOwningView = owningView;
private RenderNode(long nativePtr) see RenderNode#adopt(long) mNativeRenderNode = nativePtr; mOwningView = null;

Methods Summary
public void	addAnimator(RenderNodeAnimator animator) if (mOwningView == null || mOwningView.mAttachInfo == null) { throw new IllegalStateException("Cannot start this animator on a detached view!"); } nAddAnimator(mNativeRenderNode, animator.getNativeAnimator()); mOwningView.mAttachInfo.mViewRootImpl.registerAnimatingRenderNode(this);
public static android.view.RenderNode	adopt(long nativePtr) Adopts an existing native render node. Note: This will *NOT* incRef() on the native object, however it will decRef() when it is destroyed. The caller should have already incRef'd it return new RenderNode(nativePtr);
public static android.view.RenderNode	create(java.lang.String name, View owningView) Creates a new RenderNode that can be used to record batches of drawing operations, and store / apply render properties when drawn. param name The name of the RenderNode, used for debugging purpose. May be null. return A new RenderNode. return new RenderNode(name, owningView);
public void	destroyDisplayListData() Reset native resources. This is called when cleaning up the state of display lists during destruction of hardware resources, to ensure that we do not hold onto obsolete resources after related resources are gone. if (!mValid) return; nSetDisplayListData(mNativeRenderNode, 0); mValid = false;
public void	end(HardwareCanvas endCanvas) Ends the recording for this display list. A display list cannot be replayed if recording is not finished. Calling this method marks the display list valid and {@link #isValid()} will return true. see #start(int, int) see #isValid() if (!(endCanvas instanceof GLES20RecordingCanvas)) { throw new IllegalArgumentException("Passed an invalid canvas to end!"); } GLES20RecordingCanvas canvas = (GLES20RecordingCanvas) endCanvas; canvas.onPostDraw(); long renderNodeData = canvas.finishRecording(); nSetDisplayListData(mNativeRenderNode, renderNodeData); canvas.recycle(); mValid = true;
public void	endAllAnimators() nEndAllAnimators(mNativeRenderNode);
protected void	finalize() try { nDestroyRenderNode(mNativeRenderNode); } finally { super.finalize(); }
public float	getAlpha() Returns the translucency level of this display list. return A value between 0.0f and 1.0f see #setAlpha(float) return nGetAlpha(mNativeRenderNode);
public float	getCameraDistance() Returns the distance in Z of the camera of the display list. see #setCameraDistance(float) return nGetCameraDistance(mNativeRenderNode);
public boolean	getClipToOutline() return nGetClipToOutline(mNativeRenderNode);
public int	getDebugSize() Gets the size of the DisplayList for debug purposes. return nGetDebugSize(mNativeRenderNode);
public float	getElevation() return nGetElevation(mNativeRenderNode);
public void	getInverseMatrix(android.graphics.Matrix outMatrix) nGetInverseTransformMatrix(mNativeRenderNode, outMatrix.native_instance);
public void	getMatrix(android.graphics.Matrix outMatrix) nGetTransformMatrix(mNativeRenderNode, outMatrix.native_instance);
long	getNativeDisplayList() if (!mValid) { throw new IllegalStateException("The display list is not valid."); } return mNativeRenderNode;
public float	getPivotX() Returns the pivot value for this display list on the X axis, in pixels. see #setPivotX(float) return nGetPivotX(mNativeRenderNode);
public float	getPivotY() Returns the pivot value for this display list on the Y axis, in pixels. see #setPivotY(float) return nGetPivotY(mNativeRenderNode);
public float	getRotation() Returns the rotation value for this display list around the Z axis, in degrees. see #setRotation(float) return nGetRotation(mNativeRenderNode);
public float	getRotationX() Returns the rotation value for this display list around the X axis, in degrees. see #setRotationX(float) return nGetRotationX(mNativeRenderNode);
public float	getRotationY() Returns the rotation value for this display list around the Y axis, in degrees. see #setRotationY(float) return nGetRotationY(mNativeRenderNode);
public float	getScaleX() Returns the scale value for this display list on the X axis. see #setScaleX(float) return nGetScaleX(mNativeRenderNode);
public float	getScaleY() Returns the scale value for this display list on the Y axis. see #setScaleY(float) return nGetScaleY(mNativeRenderNode);
public float	getTranslationX() Returns the translation value for this display list on the X axis, in pixels. see #setTranslationX(float) return nGetTranslationX(mNativeRenderNode);
public float	getTranslationY() Returns the translation value for this display list on the Y axis, in pixels. see #setTranslationY(float) return nGetTranslationY(mNativeRenderNode);
public float	getTranslationZ() Returns the translation value for this display list on the Z axis. see #setTranslationZ(float) return nGetTranslationZ(mNativeRenderNode);
public boolean	hasIdentityMatrix() return nHasIdentityMatrix(mNativeRenderNode);
public boolean	hasOverlappingRendering() Indicates whether the content of this display list overlaps. return True if this display list renders content which overlaps, false otherwise. see #setHasOverlappingRendering(boolean) //noinspection SimplifiableIfStatement return nHasOverlappingRendering(mNativeRenderNode);
public boolean	hasShadow() return nHasShadow(mNativeRenderNode);
public boolean	isPivotExplicitlySet() return nIsPivotExplicitlySet(mNativeRenderNode);
public boolean	isValid() Returns whether the RenderNode's display list content is currently usable. If this returns false, the display list should be re-recorded prior to replaying it. return boolean true if the display list is able to be replayed, false otherwise. return mValid;
private static native void	nAddAnimator(long renderNode, long animatorPtr)
private static native long	nCreate(java.lang.String name)
private static native void	nDestroyRenderNode(long renderNode)
private static native void	nEndAllAnimators(long renderNode)
private static native float	nGetAlpha(long renderNode)
private static native float	nGetCameraDistance(long renderNode)
private static native boolean	nGetClipToOutline(long renderNode)
private static native int	nGetDebugSize(long renderNode)
private static native float	nGetElevation(long renderNode)
private static native void	nGetInverseTransformMatrix(long renderNode, long nativeMatrix)
private static native float	nGetPivotX(long renderNode)
private static native float	nGetPivotY(long renderNode)
private static native float	nGetRotation(long renderNode)
private static native float	nGetRotationX(long renderNode)
private static native float	nGetRotationY(long renderNode)
private static native float	nGetScaleX(long renderNode)
private static native float	nGetScaleY(long renderNode)
private static native void	nGetTransformMatrix(long renderNode, long nativeMatrix)
private static native float	nGetTranslationX(long renderNode)
private static native float	nGetTranslationY(long renderNode)
private static native float	nGetTranslationZ(long renderNode)
private static native boolean	nHasIdentityMatrix(long renderNode)
private static native boolean	nHasOverlappingRendering(long renderNode)
private static native boolean	nHasShadow(long renderNode)
private static native boolean	nIsPivotExplicitlySet(long renderNode)
private static native boolean	nOffsetLeftAndRight(long renderNode, int offset)
private static native boolean	nOffsetTopAndBottom(long renderNode, int offset)
private static native void	nOutput(long renderNode)
private static native boolean	nSetAlpha(long renderNode, float alpha)
private static native boolean	nSetAnimationMatrix(long renderNode, long animationMatrix)
private static native boolean	nSetBottom(long renderNode, int bottom)
private static native boolean	nSetCameraDistance(long renderNode, float distance)
private static native boolean	nSetClipBounds(long renderNode, int left, int top, int right, int bottom)
private static native boolean	nSetClipBoundsEmpty(long renderNode)
private static native boolean	nSetClipToBounds(long renderNode, boolean clipToBounds)
private static native boolean	nSetClipToOutline(long renderNode, boolean clipToOutline)
private static native void	nSetDisplayListData(long renderNode, long newData)
private static native boolean	nSetElevation(long renderNode, float lift)
private static native boolean	nSetHasOverlappingRendering(long renderNode, boolean hasOverlappingRendering)
private static native boolean	nSetLayerPaint(long renderNode, long paint)
private static native boolean	nSetLayerType(long renderNode, int layerType)
private static native boolean	nSetLeft(long renderNode, int left)
private static native boolean	nSetLeftTopRightBottom(long renderNode, int left, int top, int right, int bottom)
private static native boolean	nSetOutlineConvexPath(long renderNode, long nativePath, float alpha)
private static native boolean	nSetOutlineEmpty(long renderNode)
private static native boolean	nSetOutlineNone(long renderNode)
private static native boolean	nSetOutlineRoundRect(long renderNode, int left, int top, int right, int bottom, float radius, float alpha)
private static native boolean	nSetPivotX(long renderNode, float pivotX)
private static native boolean	nSetPivotY(long renderNode, float pivotY)
private static native boolean	nSetProjectBackwards(long renderNode, boolean shouldProject)
private static native boolean	nSetProjectionReceiver(long renderNode, boolean shouldRecieve)
private static native boolean	nSetRevealClip(long renderNode, boolean shouldClip, float x, float y, float radius)
private static native boolean	nSetRight(long renderNode, int right)
private static native boolean	nSetRotation(long renderNode, float rotation)
private static native boolean	nSetRotationX(long renderNode, float rotationX)
private static native boolean	nSetRotationY(long renderNode, float rotationY)
private static native boolean	nSetScaleX(long renderNode, float scaleX)
private static native boolean	nSetScaleY(long renderNode, float scaleY)
private static native boolean	nSetStaticMatrix(long renderNode, long nativeMatrix)
private static native boolean	nSetTop(long renderNode, int top)
private static native boolean	nSetTranslationX(long renderNode, float translationX)
private static native boolean	nSetTranslationY(long renderNode, float translationY)
private static native boolean	nSetTranslationZ(long renderNode, float translationZ)
public boolean	offsetLeftAndRight(int offset) Offsets the left and right positions for the display list param offset The amount that the left and right positions of the display list are offset, in pixels see View#offsetLeftAndRight(int) return nOffsetLeftAndRight(mNativeRenderNode, offset);
public boolean	offsetTopAndBottom(int offset) Offsets the top and bottom values for the display list param offset The amount that the top and bottom positions of the display list are offset, in pixels see View#offsetTopAndBottom(int) return nOffsetTopAndBottom(mNativeRenderNode, offset);
public void	output() Outputs the display list to the log. This method exists for use by tools to output display lists for selected nodes to the log. nOutput(mNativeRenderNode);
public boolean	setAlpha(float alpha) Sets the translucency level for the display list. param alpha The translucency of the display list, must be a value between 0.0f and 1.0f see View#setAlpha(float) see #getAlpha() return nSetAlpha(mNativeRenderNode, alpha);
public boolean	setAnimationMatrix(android.graphics.Matrix matrix) Set the Animation matrix on the display list. This matrix exists if an Animation is currently playing on a View, and is set on the display list during at draw() time. When the Animation finishes, the matrix should be cleared by sending null for the matrix parameter. param matrix The matrix, null indicates that the matrix should be cleared. return nSetAnimationMatrix(mNativeRenderNode, (matrix != null) ? matrix.native_instance : 0);
public boolean	setBottom(int bottom) Sets the bottom position for the display list. param bottom The bottom position, in pixels, of the display list see View#setBottom(int) return nSetBottom(mNativeRenderNode, bottom);
public boolean	setCameraDistance(float distance) Sets the camera distance for the display list. Refer to {@link View#setCameraDistance(float)} for more information on how to use this property. param distance The distance in Z of the camera of the display list see View#setCameraDistance(float) see #getCameraDistance() return nSetCameraDistance(mNativeRenderNode, distance);
public boolean	setClipBounds(android.graphics.Rect rect) if (rect == null) { return nSetClipBoundsEmpty(mNativeRenderNode); } else { return nSetClipBounds(mNativeRenderNode, rect.left, rect.top, rect.right, rect.bottom); }
public boolean	setClipToBounds(boolean clipToBounds) Set whether the Render node should clip itself to its bounds. This property is controlled by the view's parent. param clipToBounds true if the display list should clip to its bounds return nSetClipToBounds(mNativeRenderNode, clipToBounds);
public boolean	setClipToOutline(boolean clipToOutline) Enables or disables clipping to the outline. param clipToOutline true if clipping to the outline. return nSetClipToOutline(mNativeRenderNode, clipToOutline);
public boolean	setElevation(float lift) return nSetElevation(mNativeRenderNode, lift);
public boolean	setHasOverlappingRendering(boolean hasOverlappingRendering) Sets whether the display list renders content which overlaps. Non-overlapping rendering can use a fast path for alpha that avoids rendering to an offscreen buffer. By default display lists consider they do not have overlapping content. param hasOverlappingRendering False if the content is guaranteed to be non-overlapping, true otherwise. see android.view.View#hasOverlappingRendering() see #hasOverlappingRendering() return nSetHasOverlappingRendering(mNativeRenderNode, hasOverlappingRendering);
public boolean	setLayerPaint(android.graphics.Paint paint) return nSetLayerPaint(mNativeRenderNode, paint != null ? paint.mNativePaint : 0);
public boolean	setLayerType(int layerType) return nSetLayerType(mNativeRenderNode, layerType);
public boolean	setLeft(int left) Sets the left position for the display list. param left The left position, in pixels, of the display list see View#setLeft(int) return nSetLeft(mNativeRenderNode, left);
public boolean	setLeftTopRightBottom(int left, int top, int right, int bottom) Sets the left and top positions for the display list param left The left position of the display list, in pixels param top The top position of the display list, in pixels param right The right position of the display list, in pixels param bottom The bottom position of the display list, in pixels see View#setLeft(int) see View#setTop(int) see View#setRight(int) see View#setBottom(int) return nSetLeftTopRightBottom(mNativeRenderNode, left, top, right, bottom);
public boolean	setOutline(android.graphics.Outline outline) Sets the outline, defining the shape that casts a shadow, and the path to be clipped if setClipToOutline is set. Deep copies the data into native to simplify reference ownership. if (outline == null) { return nSetOutlineNone(mNativeRenderNode); } else if (outline.isEmpty()) { return nSetOutlineEmpty(mNativeRenderNode); } else if (outline.mRect != null) { return nSetOutlineRoundRect(mNativeRenderNode, outline.mRect.left, outline.mRect.top, outline.mRect.right, outline.mRect.bottom, outline.mRadius, outline.mAlpha); } else if (outline.mPath != null) { return nSetOutlineConvexPath(mNativeRenderNode, outline.mPath.mNativePath, outline.mAlpha); } throw new IllegalArgumentException("Unrecognized outline?");
public boolean	setPivotX(float pivotX) Sets the pivot value for the display list on the X axis param pivotX The pivot value of the display list on the X axis, in pixels see View#setPivotX(float) see #getPivotX() return nSetPivotX(mNativeRenderNode, pivotX);
public boolean	setPivotY(float pivotY) Sets the pivot value for the display list on the Y axis param pivotY The pivot value of the display list on the Y axis, in pixels see View#setPivotY(float) see #getPivotY() return nSetPivotY(mNativeRenderNode, pivotY);
public boolean	setProjectBackwards(boolean shouldProject) Sets whether the display list should be drawn immediately after the closest ancestor display list containing a projection receiver. param shouldProject true if the display list should be projected onto a containing volume. return nSetProjectBackwards(mNativeRenderNode, shouldProject);
public boolean	setProjectionReceiver(boolean shouldRecieve) Sets whether the display list is a projection receiver - that its parent DisplayList should draw any descendent DisplayLists with ProjectBackwards=true directly on top of it. Default value is false. return nSetProjectionReceiver(mNativeRenderNode, shouldRecieve);
public boolean	setRevealClip(boolean shouldClip, float x, float y, float radius) Controls the RenderNode's circular reveal clip. return nSetRevealClip(mNativeRenderNode, shouldClip, x, y, radius);
public boolean	setRight(int right) Sets the right position for the display list. param right The right position, in pixels, of the display list see View#setRight(int) return nSetRight(mNativeRenderNode, right);
public boolean	setRotation(float rotation) Sets the rotation value for the display list around the Z axis. param rotation The rotation value of the display list, in degrees see View#setRotation(float) see #getRotation() return nSetRotation(mNativeRenderNode, rotation);
public boolean	setRotationX(float rotationX) Sets the rotation value for the display list around the X axis. param rotationX The rotation value of the display list, in degrees see View#setRotationX(float) see #getRotationX() return nSetRotationX(mNativeRenderNode, rotationX);
public boolean	setRotationY(float rotationY) Sets the rotation value for the display list around the Y axis. param rotationY The rotation value of the display list, in degrees see View#setRotationY(float) see #getRotationY() return nSetRotationY(mNativeRenderNode, rotationY);
public boolean	setScaleX(float scaleX) Sets the scale value for the display list on the X axis. param scaleX The scale value of the display list see View#setScaleX(float) see #getScaleX() return nSetScaleX(mNativeRenderNode, scaleX);
public boolean	setScaleY(float scaleY) Sets the scale value for the display list on the Y axis. param scaleY The scale value of the display list see View#setScaleY(float) see #getScaleY() return nSetScaleY(mNativeRenderNode, scaleY);
public boolean	setStaticMatrix(android.graphics.Matrix matrix) Set the static matrix on the display list. The specified matrix is combined with other transforms (such as {@link #setScaleX(float)}, {@link #setRotation(float)}, etc.) param matrix A transform matrix to apply to this display list return nSetStaticMatrix(mNativeRenderNode, matrix.native_instance);
public boolean	setTop(int top) Sets the top position for the display list. param top The top position, in pixels, of the display list see View#setTop(int) return nSetTop(mNativeRenderNode, top);
public boolean	setTranslationX(float translationX) Sets the translation value for the display list on the X axis. param translationX The X axis translation value of the display list, in pixels see View#setTranslationX(float) see #getTranslationX() return nSetTranslationX(mNativeRenderNode, translationX);
public boolean	setTranslationY(float translationY) Sets the translation value for the display list on the Y axis. param translationY The Y axis translation value of the display list, in pixels see View#setTranslationY(float) see #getTranslationY() return nSetTranslationY(mNativeRenderNode, translationY);
public boolean	setTranslationZ(float translationZ) Sets the translation value for the display list on the Z axis. see View#setTranslationZ(float) see #getTranslationZ() return nSetTranslationZ(mNativeRenderNode, translationZ);
public HardwareCanvas	start(int width, int height) Starts recording a display list for the render node. All operations performed on the returned canvas are recorded and stored in this display list. Calling this method will mark the render node invalid until {@link #end(HardwareCanvas)} is called. Only valid render nodes can be replayed. param width The width of the recording viewport param height The height of the recording viewport return A canvas to record drawing operations. see #end(HardwareCanvas) see #isValid() HardwareCanvas canvas = GLES20RecordingCanvas.obtain(this); canvas.setViewport(width, height); // The dirty rect should always be null for a display list canvas.onPreDraw(null); return canvas;