LowLatencyCanvasView


@RequiresApi(value = 29)
public final class LowLatencyCanvasView extends ViewGroup


View implementation that leverages a "front buffered" rendering system. This allows for lower latency graphics by leveraging a combination of front buffered alongside multi-buffered content layers. This class provides similar functionality to CanvasFrontBufferedRenderer, however, leverages the traditional View system for implementing the multi buffered content instead of a separate SurfaceControlCompat instance and entirely abstracts all SurfaceView usage for simplicity.

Drawing of this View's content is handled by a consumer specified LowLatencyCanvasView.Callback implementation instead of View.onDraw. Rendering here is done with a Canvas into a single buffer that is presented on screen above the rest of the View hierarchy content. This overlay is transient and will only be visible after LowLatencyCanvasView.renderFrontBufferedLayer is called and hidden after LowLatencyCanvasView.commit is invoked. After LowLatencyCanvasView.commit is invoked, this same buffer is wrapped into a bitmap and drawn within this View's View.onDraw implementation.

Calls to LowLatencyCanvasView.renderFrontBufferedLayer will trigger LowLatencyCanvasView.Callback.onDrawFrontBufferedLayer to be invoked to handle drawing of content with the provided Canvas.

After LowLatencyCanvasView.commit is called, the overlay is hidden and the buffer is drawn within the View hierarchy, similar to traditional View implementations.

A common use case would be a drawing application that intends to minimize the amount of latency when content is drawn with a stylus. In this case, touch events between MotionEvent.ACTION_DOWN and MotionEvent.ACTION_MOVE can trigger calls to LowLatencyCanvasView.renderFrontBufferedLayer which will minimize the delay between then the content is visible on screen. Finally when the gesture is complete on MotionEvent.ACTION_UP, a call to LowLatencyCanvasView.commit would be invoked to hide the transient overlay and render the scene within the View hierarchy like a traditional View. This helps provide a balance of low latency guarantees while mitigating potential tearing artifacts.

This helps support low latency rendering for simpler use cases at the expensive of configuration customization of the multi buffered layer content.

import androidx.annotation.WorkerThread
import androidx.graphics.lowlatency.LowLatencyCanvasView

LowLatencyCanvasView(context).apply {
    setBackgroundColor(Color.WHITE)

    data class Line(
        val x1: Float,
        val y1: Float,
        val x2: Float,
        val y2: Float,
    )
    // Thread safe collection to support creation of new lines from the UI thread as well as
    // consumption of lines from the background drawing thread
    val lines = Collections.synchronizedList(ArrayList<Line>())
    setRenderCallback(object : LowLatencyCanvasView.Callback {

        val mAllLines = ArrayList<Line>()

        private val mPaint = Paint(Paint.ANTI_ALIAS_FLAG).apply {
            strokeWidth = 15f
            color = Color.CYAN
            alpha = 128
        }

        @WorkerThread
        override fun onRedrawRequested(
            canvas: Canvas,
            width: Int,
            height: Int
        ) {
            for (line in mAllLines) {
                canvas.drawLine(line.x1, line.y1, line.x2, line.y2, mPaint)
            }
        }

        @WorkerThread
        override fun onDrawFrontBufferedLayer(
            canvas: Canvas,
            width: Int,
            height: Int
        ) {
            lines.removeFirstOrNull()?.let { line ->
                mAllLines.add(line)
                canvas.drawLine(line.x1, line.y1, line.x2, line.y2, mPaint)
            }
        }
    })
    setOnTouchListener(object : View.OnTouchListener {

        var mCurrentX = -1f
        var mCurrentY = -1f
        var mPreviousX = -1f
        var mPreviousY = -1f

        override fun onTouch(v: View?, event: MotionEvent?): Boolean {
            if (event == null) return false
            when (event.action) {
                MotionEvent.ACTION_DOWN -> {
                    requestUnbufferedDispatch(event)
                    mCurrentX = event.x
                    mCurrentY = event.y
                }
                MotionEvent.ACTION_MOVE -> {
                    mPreviousX = mCurrentX
                    mPreviousY = mCurrentY
                    mCurrentX = event.x
                    mCurrentY = event.y

                    val line = Line(mPreviousX, mPreviousY, mCurrentX, mCurrentY)
                    lines.add(line)
                    renderFrontBufferedLayer()
                }
                MotionEvent.ACTION_CANCEL -> {
                    cancel()
                }
                MotionEvent.ACTION_UP -> {
                    commit()
                }
            }
            return true
        }
    })
}

Summary

Nested types

Provides callbacks for consumers to draw into the front buffered overlay as well as provide opportunities to synchronize SurfaceControlCompat.Transactions to submit the layers to the hardware compositor

Public constructors

LowLatencyCanvasView(
    @NonNull Context context,
    AttributeSet attrs,
    int defStyle
)

Public methods

void
addView(View child)
void
addView(View child, int index)
void
void
addView(View child, int index, ViewGroup.LayoutParams params)
void
addView(View child, int width, int height)
final void

Cancels any in progress request to render to the front buffer and hides the front buffered overlay.

final void

Clears the content of the buffer and hides the front buffered overlay.

final void

Invalidates this View and draws the buffer within View#onDraw.

final void

Dispatches a runnable to be executed on the background rendering thread.

final void

Render content to the front buffered layer.

final void

Configures the Callback used to render contents to the front buffered overlay as well as optionally configuring the SurfaceControlCompat.Transaction used to update contents on screen.

Protected methods

void
void
void
onLayout(boolean changed, int l, int t, int r, int b)

Inherited methods

From android.view.accessibility.AccessibilityEventSource
From android.graphics.drawable.Drawable.Callback
void
void
scheduleDrawable(@NonNull Drawable who, @NonNull Runnable what, long when)
void
From android.view.KeyEvent.Callback
boolean
onKeyDown(int keyCode, @NonNull KeyEvent event)
boolean
onKeyLongPress(int keyCode, @NonNull KeyEvent event)
boolean
onKeyMultiple(int keyCode, int repeatCount, @NonNull KeyEvent event)
boolean
onKeyUp(int keyCode, @NonNull KeyEvent event)
From android.view.View
void
void
addExtraDataToAccessibilityNodeInfo(
    @NonNull AccessibilityNodeInfo info,
    @NonNull String extraDataKey,
    @Nullable Bundle arguments
)
void
addFocusables(@NonNull ArrayList<@NonNull View> views, int direction)
void
addFocusables(
    @NonNull ArrayList<@NonNull View> views,
    int direction,
    int focusableMode
)
void
addKeyboardNavigationClusters(
    @NonNull Collection<@NonNull View> views,
    int direction
)
void
void
void
void
@NonNull ViewPropertyAnimator
void

This method is deprecated. Deprecated in Java

void
void
boolean
boolean
awakenScrollBars(int startDelay)
boolean
awakenScrollBars(int startDelay, boolean invalidate)
void
void

This method is deprecated. Deprecated in Java

void
buildDrawingCache(boolean autoScale)

This method is deprecated. Deprecated in Java

void
boolean
boolean
boolean
boolean
boolean
canScrollHorizontally(int direction)
boolean
canScrollVertically(int direction)
final void
void
final void
boolean
void
void
void
void
int
int
int
void
@NonNull WindowInsets
computeSystemWindowInsets(
    @NonNull WindowInsets in,
    @NonNull Rect outLocalInsets
)
int
int
int
@NonNull AccessibilityNodeInfo
void
void

This method is deprecated. Deprecated in Java

@NonNull WindowInsets
boolean
void
void
dispatchCreateViewTranslationRequest(
    @NonNull Map<@NonNull AutofillId, @NonNull long[]> viewIds,
    @NonNull int[] supportedFormats,
    @Nullable TranslationCapability capability,
    @NonNull List<@NonNull ViewTranslationRequest> requests
)
void
boolean
void
void
dispatchDrawableHotspotChanged(float x, float y)
void
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
dispatchNestedFling(float velocityX, float velocityY, boolean consumed)
boolean
dispatchNestedPreFling(float velocityX, float velocityY)
boolean
dispatchNestedPrePerformAccessibilityAction(
    int action,
    @Nullable Bundle arguments
)
boolean
dispatchNestedPreScroll(
    int dx,
    int dy,
    @Nullable int[] consumed,
    @Nullable int[] offsetInWindow
)
boolean
dispatchNestedScroll(
    int dxConsumed,
    int dyConsumed,
    int dxUnconsumed,
    int dyUnconsumed,
    @Nullable int[] offsetInWindow
)
void
dispatchPointerCaptureChanged(boolean hasCapture)
boolean
void
dispatchProvideAutofillStructure(
    @NonNull ViewStructure structure,
    int flags
)
void
void
void
void
dispatchScrollCaptureSearch(
    @NonNull Rect localVisibleRect,
    @NonNull Point windowOffset,
    @NonNull Consumer<@NonNull ScrollCaptureTarget> targets
)
void
dispatchSetActivated(boolean activated)
void
dispatchSetPressed(boolean pressed)
void
dispatchSetSelected(boolean selected)
void
void

This method is deprecated. Deprecated in Java

boolean
boolean
boolean
dispatchUnhandledMove(@NonNull View focused, int direction)
void
dispatchVisibilityChanged(@NonNull View changedView, int visibility)
void
dispatchWindowFocusChanged(boolean hasFocus)
void
void
@NonNull WindowInsets
@NonNull WindowInsetsAnimation.Bounds
void

This method is deprecated. Deprecated in Java

void
void
draw(@NonNull Canvas canvas)
void
drawableHotspotChanged(float x, float y)
void
@NonNull View
final @Nullable OnBackInvokedDispatcher
final @NonNull T
<T extends View> findViewById(int id)
final @NonNull T
<T extends View> findViewWithTag(@NonNull Object tag)
void
findViewsWithText(
    @NonNull ArrayList<@NonNull View> outViews,
    @NonNull CharSequence text,
    int flags
)
boolean

This method is deprecated. Deprecated in Java

@NonNull View
focusSearch(int direction)
void
forceHasOverlappingRendering(boolean hasOverlappingRendering)
void
boolean
void
generateDisplayHash(
    @NonNull String hashAlgorithm,
    @Nullable Rect bounds,
    @NonNull Executor executor,
    @NonNull DisplayHashResultCallback callback
)
@NonNull View.AccessibilityDelegate
int
@NonNull AccessibilityNodeProvider
@Nullable CharSequence
int
int
@Nullable String
@Nullable String
float
@ViewDebug.ExportedProperty(category = "drawing")
getAlpha()
@NonNull Animation
@Nullable Matrix
@NonNull IBinder
@NonNull int[]
@NonNull Map<@NonNull Integer, @NonNull Integer>
@Nullable String[]
final @NonNull AutofillId
int
@Nullable AutofillValue
@NonNull Drawable
@Nullable BlendMode
@Nullable ColorStateList
@Nullable PorterDuff.Mode
int
@ViewDebug.ExportedProperty(category = "layout")
getBaseline()
final int
float
int
float
@NonNull Rect
final boolean
final @Nullable ContentCaptureSession
@NonNull CharSequence
@ViewDebug.ExportedProperty(category = "accessibility")
getContentDescription()
final int
final @NonNull Context
@NonNull ContextMenu.ContextMenuInfo
final boolean
@NonNull Display
final @NonNull int[]
@NonNull Bitmap

This method is deprecated. Deprecated in Java

int

This method is deprecated. Deprecated in Java

int

This method is deprecated. Deprecated in Java

void
long
float
@ViewDebug.ExportedProperty(category = "drawing")
getElevation()
int
boolean
boolean
int
@ViewDebug.ExportedProperty(mapping = [@ViewDebug.IntToString(from = 0, to = "NOT_FOCUSABLE"), @ViewDebug.IntToString(from = 1, to = "FOCUSABLE"), @ViewDebug.IntToString(from = 16, to = "FOCUSABLE_AUTO")], category = "focus")
getFocusable()
@NonNull ArrayList<@NonNull View>
getFocusables(int direction)
void
@NonNull Drawable
int
@Nullable BlendMode
@Nullable ColorStateList
@Nullable PorterDuff.Mode
float
final boolean
boolean
@NonNull Handler
float
float
float
float
int
@Nullable Runnable
final boolean
final int
@ViewDebug.ExportedProperty(category = "layout")
getHeight()
void
int
int
@Nullable Drawable
@Nullable Drawable
int
int
@ViewDebug.ExportedProperty(category = "accessibility", mapping = [@ViewDebug.IntToString(from = 0, to = "auto"), @ViewDebug.IntToString(from = 1, to = "yes"), @ViewDebug.IntToString(from = 2, to = "no"), @ViewDebug.IntToString(from = 4, to = "noHideDescendants")])
getImportantForAccessibility()
int
@ViewDebug.ExportedProperty(mapping = [@ViewDebug.IntToString(from = 0, to = "auto"), @ViewDebug.IntToString(from = 1, to = "yes"), @ViewDebug.IntToString(from = 2, to = "no"), @ViewDebug.IntToString(from = 4, to = "yesExcludeDescendants"), @ViewDebug.IntToString(from = 8, to = "noExcludeDescendants")])
getImportantForAutofill()
int
@ViewDebug.ExportedProperty(mapping = [@ViewDebug.IntToString(from = 0, to = "auto"), @ViewDebug.IntToString(from = 1, to = "yes"), @ViewDebug.IntToString(from = 2, to = "no"), @ViewDebug.IntToString(from = 4, to = "yesExcludeDescendants"), @ViewDebug.IntToString(from = 8, to = "noExcludeDescendants")])
getImportantForContentCapture()
boolean
@NonNull KeyEvent.DispatcherState
int
@ViewDebug.ExportedProperty(category = "accessibility")
getLabelFor()
int
@ViewDebug.ExportedProperty(category = "drawing", mapping = [@ViewDebug.IntToString(from = 0, to = "NONE"), @ViewDebug.IntToString(from = 1, to = "SOFTWARE"), @ViewDebug.IntToString(from = 2, to = "HARDWARE")])
getLayerType()
int
@ViewDebug.ExportedProperty(category = "layout", mapping = [@ViewDebug.IntToString(from = 0, to = "RESOLVED_DIRECTION_LTR"), @ViewDebug.IntToString(from = 1, to = "RESOLVED_DIRECTION_RTL")])
getLayoutDirection()
@NonNull ViewGroup.LayoutParams
@ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
getLayoutParams()
final int
float
int
final boolean
void
getLocationInSurface(@NonNull int[] location)
void
getLocationInWindow(@NonNull int[] outLocation)
void
getLocationOnScreen(@NonNull int[] outLocation)
@NonNull Matrix
final int
final int
@ViewDebug.ExportedProperty(category = "measurement", flagMapping = [@ViewDebug.FlagToString(mask = -16777216, equals = 16777216, name = "MEASURED_STATE_TOO_SMALL")])
getMeasuredHeightAndState()
final int
final int
final int
@ViewDebug.ExportedProperty(category = "measurement", flagMapping = [@ViewDebug.FlagToString(mask = -16777216, equals = 16777216, name = "MEASURED_STATE_TOO_SMALL")])
getMeasuredWidthAndState()
int
int
int
int
int
int
int
int
@NonNull View.OnFocusChangeListener
int
@NonNull ViewOutlineProvider
int
int
int
int
int
int
int
int
final @NonNull ViewParent
@NonNull ViewParent
final @Nullable OutcomeReceiver<@NonNull GetCredentialResponse, @NonNull GetCredentialException>
final @Nullable GetCredentialRequest
float
@ViewDebug.ExportedProperty(category = "drawing")
getPivotX()
float
@ViewDebug.ExportedProperty(category = "drawing")
getPivotY()
@NonNull PointerIcon
final @NonNull List<@NonNull Rect>
@Nullable String[]
float
@NonNull Resources
final boolean
final int
float
int
@Nullable AttachedSurfaceControl
@NonNull View
@NonNull WindowInsets
float
@ViewDebug.ExportedProperty(category = "drawing")
getRotation()
float
@ViewDebug.ExportedProperty(category = "drawing")
getRotationX()
float
@ViewDebug.ExportedProperty(category = "drawing")
getRotationY()
float
@ViewDebug.ExportedProperty(category = "drawing")
getScaleX()
float
@ViewDebug.ExportedProperty(category = "drawing")
getScaleY()
int
int
int
int
@ViewDebug.ExportedProperty(mapping = [@ViewDebug.IntToString(from = 0, to = "INSIDE_OVERLAY"), @ViewDebug.IntToString(from = 16777216, to = "INSIDE_INSET"), @ViewDebug.IntToString(from = 33554432, to = "OUTSIDE_OVERLAY"), @ViewDebug.IntToString(from = 50331648, to = "OUTSIDE_INSET")])
getScrollBarStyle()
int
int
final int
final int
int
@ViewDebug.ExportedProperty(category = "drawing")
getSolidColor()
int
final @Nullable CharSequence
@ViewDebug.ExportedProperty(category = "accessibility")
getStateDescription()
@NonNull StateListAnimator
int
int
@Nullable CharSequence
@NonNull List<@NonNull Rect>
int

This method is deprecated. Deprecated in Java

@NonNull Object
int
@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "GRAVITY"), @ViewDebug.IntToString(from = 2, to = "TEXT_START"), @ViewDebug.IntToString(from = 3, to = "TEXT_END"), @ViewDebug.IntToString(from = 4, to = "CENTER"), @ViewDebug.IntToString(from = 5, to = "VIEW_START"), @ViewDebug.IntToString(from = 6, to = "VIEW_END")])
getTextAlignment()
int
@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "FIRST_STRONG"), @ViewDebug.IntToString(from = 2, to = "ANY_RTL"), @ViewDebug.IntToString(from = 3, to = "LTR"), @ViewDebug.IntToString(from = 4, to = "RTL"), @ViewDebug.IntToString(from = 5, to = "LOCALE"), @ViewDebug.IntToString(from = 6, to = "FIRST_STRONG_LTR"), @ViewDebug.IntToString(from = 7, to = "FIRST_STRONG_RTL")])
getTextDirection()
@Nullable CharSequence
final int
float
int
@NonNull TouchDelegate
@NonNull ArrayList<@NonNull View>
float
@NonNull String
float
float
float
long
int
int
@Nullable Drawable
@Nullable Drawable
int
@Nullable ViewTranslationResponse
@NonNull ViewTreeObserver
int
@ViewDebug.ExportedProperty(mapping = [@ViewDebug.IntToString(from = 0, to = "VISIBLE"), @ViewDebug.IntToString(from = 4, to = "INVISIBLE"), @ViewDebug.IntToString(from = 8, to = "GONE")])
getVisibility()
final int
@ViewDebug.ExportedProperty(category = "layout")
getWidth()
int
@NonNull WindowId
@Nullable WindowInsetsController
int

This method is deprecated. Deprecated in Java

@NonNull IBinder
int
void
float
@ViewDebug.ExportedProperty(category = "drawing")
getX()
float
@ViewDebug.ExportedProperty(category = "drawing")
getY()
float
@ViewDebug.ExportedProperty(category = "drawing")
getZ()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
void

This method is deprecated. Deprecated in Java

void
invalidate(int l, int t, int r, int b)

This method is deprecated. Deprecated in Java

void
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
boolean
boolean
boolean
boolean

This method is deprecated. Deprecated in Java

boolean
boolean
final boolean
@ViewDebug.ExportedProperty(category = "focus")
isFocusable()
final boolean
boolean
@ViewDebug.ExportedProperty(category = "focus")
isFocused()
final boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
final boolean
boolean
boolean
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
boolean
@ViewDebug.ExportedProperty(category = "drawing")
isOpaque()
boolean
boolean
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
boolean
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
void
@NonNull View
keyboardNavigationClusterSearch(
    @NonNull View currentCluster,
    int direction
)
final void
layout(int l, int t, int r, int b)
final void
measure(int widthMeasureSpec, int heightMeasureSpec)
void
offsetLeftAndRight(int offset)
void
offsetTopAndBottom(int offset)
void
void
@NonNull WindowInsets
void
boolean
boolean
void
void
@NonNull int[]
onCreateDrawableState(int extraSpace)
@NonNull InputConnection
void
onCreateViewTranslationRequest(
    @NonNull int[] supportedFormats,
    @NonNull Consumer<@NonNull ViewTranslationRequest> requestsCollector
)
void
onCreateVirtualViewTranslationRequests(
    @NonNull long[] virtualIds,
    @NonNull int[] supportedFormats,
    @NonNull Consumer<@NonNull ViewTranslationRequest> requestsCollector
)
void
void
onDisplayHint(int hint)
boolean
void
final void
boolean
void
void
void
onFocusChanged(
    boolean gainFocus,
    int direction,
    @Nullable Rect previouslyFocusedRect
)
boolean
void
onHoverChanged(boolean hovered)
boolean
void
void
boolean
onKeyPreIme(int keyCode, @NonNull KeyEvent event)
boolean
onKeyShortcut(int keyCode, @NonNull KeyEvent event)
void
onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void
onOverScrolled(
    int scrollX,
    int scrollY,
    boolean clampedX,
    boolean clampedY
)
void
onPointerCaptureChange(boolean hasCapture)
void
void
void
onProvideAutofillVirtualStructure(
    @NonNull ViewStructure structure,
    int flags
)
void
onProvideContentCaptureStructure(
    @NonNull ViewStructure structure,
    int flags
)
void
void
@Nullable ContentInfo
@NonNull PointerIcon
onResolvePointerIcon(@NonNull MotionEvent event, int pointerIndex)
void
void
onRtlPropertiesChanged(int layoutDirection)
@Nullable Parcelable
void
onScreenStateChanged(int screenState)
void
onScrollCaptureSearch(
    @NonNull Rect localVisibleRect,
    @NonNull Point windowOffset,
    @NonNull Consumer<@NonNull ScrollCaptureTarget> targets
)
void
onScrollChanged(int l, int t, int oldl, int oldt)
boolean
onSetAlpha(int alpha)
void
onSizeChanged(int w, int h, int oldw, int oldh)
void
boolean
boolean
void
void
void
onVisibilityAggregated(boolean isVisible)
void
onVisibilityChanged(@NonNull View changedView, int visibility)
void
onWindowFocusChanged(boolean hasWindowFocus)
void

This method is deprecated. Deprecated in Java

void
onWindowVisibilityChanged(int visibility)
boolean
overScrollBy(
    int deltaX,
    int deltaY,
    int scrollX,
    int scrollY,
    int scrollRangeX,
    int scrollRangeY,
    int maxOverScrollX,
    int maxOverScrollY,
    boolean isTouchEvent
)
boolean
performAccessibilityAction(int action, @Nullable Bundle arguments)
boolean
boolean
boolean
performContextClick(float x, float y)
boolean
performHapticFeedback(int feedbackConstant)
boolean
performHapticFeedback(int feedbackConstant, int flags)
boolean
boolean
performLongClick(float x, float y)
@Nullable ContentInfo
void
playSoundEffect(int soundConstant)
boolean
boolean
postDelayed(@NonNull Runnable action, long delayMillis)
void
void
postInvalidate(int left, int top, int right, int bottom)
void
postInvalidateDelayed(long delayMilliseconds)
void
postInvalidateDelayed(
    long delayMilliseconds,
    int left,
    int top,
    int right,
    int bottom
)
void
void
postInvalidateOnAnimation(int left, int top, int right, int bottom)
void
void
postOnAnimationDelayed(@NonNull Runnable action, long delayMillis)
void
void
boolean
void
void
void
void
void
void

This method is deprecated. Deprecated in Java

final boolean
final boolean
requestFocus(int direction)
boolean
requestFocus(int direction, @NonNull Rect previouslyFocusedRect)
final boolean
void
void
boolean
boolean
requestRectangleOnScreen(@NonNull Rect rectangle, boolean immediate)
final void
final void
final @NonNull T
<T extends View> requireViewById(int id)
void
boolean
void
final void
saveAttributeDataForStyleable(
    @NonNull Context context,
    @NonNull int[] styleable,
    @Nullable AttributeSet attrs,
    @NonNull TypedArray t,
    int defStyleAttr,
    int defStyleRes
)
void
void
scrollBy(int x, int y)
void
scrollTo(int x, int y)
void
setAccessibilityDataSensitive(int accessibilityDataSensitive)
void
void
setAccessibilityHeading(boolean isHeading)
void
void
void
void
void
setActivated(boolean activated)
void
setAllowClickWhenDisabled(boolean clickableWhenDisabled)
void
void
void
setAlpha(float alpha)
void
void
void
setAutoHandwritingEnabled(boolean enabled)
void
setAutofillHints(@Nullable String... autofillHints)
void
void
void
setBackgroundColor(int color)
void

This method is deprecated. Deprecated in Java

void
void
void
void
final void
setBottom(int bottom)
void
setCameraDistance(float distance)
void
setClickable(boolean clickable)
void
setClipBounds(@NonNull Rect clipBounds)
void
setClipToOutline(boolean clipToOutline)
void
void
final void
void
setContextClickable(boolean contextClickable)
void
setDefaultFocusHighlightEnabled(boolean defaultFocusHighlightEnabled)
void

This method is deprecated. Deprecated in Java

void
setDrawingCacheEnabled(boolean enabled)

This method is deprecated. Deprecated in Java

void

This method is deprecated. Deprecated in Java

void
void
setElevation(float elevation)
void
setEnabled(boolean enabled)
void
setFadingEdgeLength(int length)
void
void
setFitsSystemWindows(boolean fitSystemWindows)
void
setFocusable(boolean focusable)
void
setFocusable(int focusable)
void
setFocusableInTouchMode(boolean focusableInTouchMode)
void
setFocusedByDefault(boolean isFocusedByDefault)
void
setForceDarkAllowed(boolean allow)
void
void
setForegroundGravity(int gravity)
void
void
void
void
setFrameContentVelocity(float pixelsPerSecond)
void
setHandwritingBoundsOffsets(
    float offsetLeft,
    float offsetTop,
    float offsetRight,
    float offsetBottom
)
void
void
void
setHapticFeedbackEnabled(boolean hapticFeedbackEnabled)
void
setHasTransientState(boolean hasTransientState)
void
setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled)
void
setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled)
void
void
void
setHovered(boolean hovered)
void
setId(int id)
void
void
void
void
setIsCredential(boolean isCredential)
void
setIsHandwritingDelegate(boolean isHandwritingDelegate)
void
setKeepScreenOn(boolean keepScreenOn)
void
setKeyboardNavigationCluster(boolean isCluster)
void
setLabelFor(int id)
void
void
setLayerType(int layerType, @Nullable Paint paint)
void
setLayoutDirection(int layoutDirection)
void
final void
setLeft(int left)
final void
setLeftTopRightBottom(int left, int top, int right, int bottom)
void
setLongClickable(boolean longClickable)
final void
setMeasuredDimension(int measuredWidth, int measuredHeight)
void
setMinimumHeight(int minHeight)
void
setMinimumWidth(int minWidth)
void
setNestedScrollingEnabled(boolean enabled)
void
setNextClusterForwardId(int nextClusterForwardId)
void
setNextFocusDownId(int nextFocusDownId)
void
setNextFocusForwardId(int nextFocusForwardId)
void
setNextFocusLeftId(int nextFocusLeftId)
void
setNextFocusRightId(int nextFocusRightId)
void
setNextFocusUpId(int nextFocusUpId)
void
void
void
void
void
void
void
void
void
void
void
void
setOnReceiveContentListener(
    @Nullable String[] mimeTypes,
    @Nullable OnReceiveContentListener listener
)
void
void

This method is deprecated. Deprecated in Java

void
void
void
void
void
setOverScrollMode(int overScrollMode)
void
setPadding(int left, int top, int right, int bottom)
void
setPaddingRelative(int start, int top, int end, int bottom)
void
void
setPivotX(float pivotX)
void
setPivotY(float pivotY)
void
final void
setPreferKeepClear(boolean preferKeepClear)
final void
void
setPressed(boolean pressed)
void
final void
setRevealOnFocusHint(boolean revealOnFocus)
final void
setRight(int right)
void
setRotation(float rotation)
void
setRotationX(float rotationX)
void
setRotationY(float rotationY)
void
setSaveEnabled(boolean enabled)
void
setSaveFromParentEnabled(boolean enabled)
void
setScaleX(float scaleX)
void
setScaleY(float scaleY)
void
setScreenReaderFocusable(boolean screenReaderFocusable)
void
setScrollBarDefaultDelayBeforeFade(
    int scrollBarDefaultDelayBeforeFade
)
void
setScrollBarFadeDuration(int scrollBarFadeDuration)
void
setScrollBarSize(int scrollBarSize)
void
setScrollBarStyle(int style)
final void
void
void
setScrollContainer(boolean isScrollContainer)
void
setScrollIndicators(int indicators)
void
setScrollX(int value)
void
setScrollY(int value)
void
setScrollbarFadingEnabled(boolean fadeScrollbars)
void
setSelected(boolean selected)
void
setSoundEffectsEnabled(boolean soundEffectsEnabled)
void
void
void
setSupplementalDescription(
    @Nullable CharSequence supplementalDescription
)
void
void
setSystemUiVisibility(int visibility)

This method is deprecated. Deprecated in Java

void
void
setTextAlignment(int textAlignment)
void
setTextDirection(int textDirection)
void
final void
setTop(int top)
void
void
setTransitionAlpha(float alpha)
final void
setTransitionName(@NonNull String transitionName)
void
setTransitionVisibility(int visibility)
void
setTranslationX(float translationX)
void
setTranslationY(float translationY)
void
setTranslationZ(float translationZ)
void
setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled)
void
setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled)
void
void
void
void
void
setVisibility(int visibility)
void
setWillNotCacheDrawing(boolean willNotCacheDrawing)

This method is deprecated. Deprecated in Java

void
setWillNotDraw(boolean willNotDraw)
void
void
setX(float x)
void
setY(float y)
void
setZ(float z)
boolean
boolean
showContextMenu(float x, float y)
@NonNull ActionMode
@NonNull ActionMode
void
final boolean
startDrag(
    @NonNull ClipData data,
    @NonNull View.DragShadowBuilder shadowBuilder,
    @NonNull Object myLocalState,
    int flags
)

This method is deprecated. Deprecated in Java

final boolean
startDragAndDrop(
    @NonNull ClipData data,
    @NonNull View.DragShadowBuilder shadowBuilder,
    @NonNull Object myLocalState,
    int flags
)
boolean
void
void
void
void
final void
boolean
boolean

This method is deprecated. Deprecated in Java

boolean
@ViewDebug.ExportedProperty(category = "drawing")
willNotDraw()
From android.view.ViewGroup
boolean
boolean
addViewInLayout(
    @NonNull View child,
    int index,
    @NonNull ViewGroup.LayoutParams params
)
boolean
addViewInLayout(
    @NonNull View child,
    int index,
    @NonNull ViewGroup.LayoutParams params,
    boolean preventRequestLayout
)
void
attachLayoutAnimationParameters(
    @NonNull View child,
    @NonNull ViewGroup.LayoutParams params,
    int index,
    int count
)
void
attachViewToParent(
    @NonNull View child,
    int index,
    @NonNull ViewGroup.LayoutParams params
)
boolean
boolean
void
void
void
debug(int depth)
void
void
void
void
detachViewsFromParent(int start, int count)
void
void
boolean
drawChild(@NonNull Canvas canvas, @NonNull View child, long drawingTime)
void
@NonNull ViewGroup.LayoutParams
@NonNull ViewGroup.LayoutParams
@NonNull ViewGroup.LayoutParams
@NonNull CharSequence
@NonNull View
getChildAt(int index)
int
final int
getChildDrawingOrder(int drawingPosition)
int
getChildDrawingOrder(int childCount, int drawingPosition)
boolean
boolean
boolean
int
@ViewDebug.ExportedProperty(category = "focus", mapping = [@ViewDebug.IntToString(from = 131072, to = "FOCUS_BEFORE_DESCENDANTS"), @ViewDebug.IntToString(from = 262144, to = "FOCUS_AFTER_DESCENDANTS"), @ViewDebug.IntToString(from = 393216, to = "FOCUS_BLOCK_DESCENDANTS")])
getDescendantFocusability()
@NonNull View
@NonNull LayoutAnimationController
@NonNull Animation.AnimationListener
int
@ViewDebug.ExportedProperty(category = "layout", mapping = [@ViewDebug.IntToString(from = 0, to = "RESOLVED_DIRECTION_LTR"), @ViewDebug.IntToString(from = 1, to = "RESOLVED_DIRECTION_RTL")])
getLayoutDirection()
int
@NonNull LayoutTransition
int
@NonNull ViewGroupOverlay
final @NonNull ViewParent
@NonNull ViewParent
int
@ViewDebug.ExportedProperty(category = "drawing", mapping = [@ViewDebug.IntToString(from = 0, to = "NONE"), @ViewDebug.IntToString(from = 1, to = "ANIMATION"), @ViewDebug.IntToString(from = 2, to = "SCROLLING"), @ViewDebug.IntToString(from = 3, to = "ALL")])
getPersistentDrawingCache()

This method is deprecated. Deprecated in Java

int
@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "GRAVITY"), @ViewDebug.IntToString(from = 2, to = "TEXT_START"), @ViewDebug.IntToString(from = 3, to = "TEXT_END"), @ViewDebug.IntToString(from = 4, to = "CENTER"), @ViewDebug.IntToString(from = 5, to = "VIEW_START"), @ViewDebug.IntToString(from = 6, to = "VIEW_END")])
getTextAlignment()
int
@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "FIRST_STRONG"), @ViewDebug.IntToString(from = 2, to = "ANY_RTL"), @ViewDebug.IntToString(from = 3, to = "LTR"), @ViewDebug.IntToString(from = 4, to = "RTL"), @ViewDebug.IntToString(from = 5, to = "LOCALE"), @ViewDebug.IntToString(from = 6, to = "FIRST_STRONG_LTR"), @ViewDebug.IntToString(from = 7, to = "FIRST_STRONG_RTL")])
getTextDirection()
boolean
int
boolean

This method is deprecated. Deprecated in Java

boolean

This method is deprecated. Deprecated in Java

boolean
boolean

This method is deprecated. Deprecated in Java

boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
measureChild(
    @NonNull View child,
    int parentWidthMeasureSpec,
    int parentHeightMeasureSpec
)
void
measureChildWithMargins(
    @NonNull View child,
    int parentWidthMeasureSpec,
    int widthUsed,
    int parentHeightMeasureSpec,
    int heightUsed
)
void
measureChildren(int widthMeasureSpec, int heightMeasureSpec)
final void
offsetDescendantRectToMyCoords(
    @NonNull View descendant,
    @NonNull Rect rect
)
final void
offsetRectIntoDescendantCoords(
    @NonNull View descendant,
    @NonNull Rect rect
)
boolean
boolean
boolean
onRequestFocusInDescendants(
    int direction,
    @NonNull Rect previouslyFocusedRect
)
boolean
void
void
void
propagateRequestedFrameRate(float frameRate, boolean forceOverride)
void
void
void
removeDetachedView(@NonNull View child, boolean animate)
void
removeViewAt(int index)
void
void
removeViews(int start, int count)
void
removeViewsInLayout(int start, int count)
void
void
setAddStatesFromChildren(boolean addsStates)
void

This method is deprecated. Deprecated in Java

void
setAnimationCacheEnabled(boolean enabled)

This method is deprecated. Deprecated in Java

void

This method is deprecated. Deprecated in Java

void
void

This method is deprecated. Deprecated in Java

void
setClipChildren(boolean clipChildren)
void
setClipToPadding(boolean clipToPadding)
void
setDescendantFocusability(int focusability)
void
void
void
setLayoutMode(int layoutMode)
void
void
void
void
setPersistentDrawingCache(int drawingCacheToKeep)

This method is deprecated. Deprecated in Java

void
setRequestedFrameRate(float frameRate)
void
void
setTouchscreenBlocksFocus(boolean touchscreenBlocksFocus)
void
setTransitionGroup(boolean isTransitionGroup)
boolean
void
void
void
suppressLayout(boolean suppress)
From android.view.ViewManager
void
void
From android.view.ViewParent
void
void
void
childHasTransientStateChanged(
    @NonNull View child,
    boolean childHasTransientState
)
void
@Nullable OnBackInvokedDispatcher
findOnBackInvokedDispatcherForChild(
    @NonNull View child,
    @NonNull View requester
)
@NonNull View
focusSearch(@NonNull View focused, int direction)
void
boolean
getChildVisibleRect(
    @NonNull View child,
    @NonNull Rect r,
    @NonNull Point offset
)
final void

This method is deprecated. Deprecated in Java

@NonNull ViewParent
invalidateChildInParent(@NonNull int[] location, @NonNull Rect dirty)

This method is deprecated. Deprecated in Java

void
notifySubtreeAccessibilityStateChanged(
    @NonNull View child,
    @NonNull View source,
    int changeType
)
void
boolean
onNestedFling(
    @NonNull View target,
    float velocityX,
    float velocityY,
    boolean consumed
)
boolean
onNestedPreFling(@NonNull View target, float velocityX, float velocityY)
boolean
onNestedPrePerformAccessibilityAction(
    @NonNull View target,
    int action,
    Bundle args
)
void
onNestedPreScroll(
    @NonNull View target,
    int dx,
    int dy,
    @NonNull int[] consumed
)
void
onNestedScroll(
    @NonNull View target,
    int dxConsumed,
    int dyConsumed,
    int dxUnconsumed,
    int dyUnconsumed
)
void
onNestedScrollAccepted(@NonNull View child, @NonNull View target, int axes)
boolean
onStartNestedScroll(
    @NonNull View child,
    @NonNull View target,
    int nestedScrollAxes
)
void
void
void
boolean
requestChildRectangleOnScreen(
    @NonNull View child,
    @NonNull Rect rectangle,
    boolean immediate
)
void
requestDisallowInterceptTouchEvent(boolean disallowIntercept)
boolean
void
boolean
boolean
showContextMenuForChild(@NonNull View originalView, float x, float y)
@NonNull ActionMode
startActionModeForChild(
    @NonNull View originalView,
    @NonNull ActionMode.Callback callback
)
@NonNull ActionMode
startActionModeForChild(
    @NonNull View originalView,
    @NonNull ActionMode.Callback callback,
    int type
)

Public constructors

LowLatencyCanvasView

Added in 1.0.4
public LowLatencyCanvasView(
    @NonNull Context context,
    AttributeSet attrs,
    int defStyle
)

Public methods

addView

public void addView(View child)

addView

public void addView(View child, int index)

addView

public void addView(View child, ViewGroup.LayoutParams params)

addView

public void addView(View child, int index, ViewGroup.LayoutParams params)

addView

public void addView(View child, int width, int height)

cancel

Added in 1.0.4
public final void cancel()

Cancels any in progress request to render to the front buffer and hides the front buffered overlay. Cancellation is a "best-effort" approach and any in progress rendering will still be applied.

clear

Added in 1.0.4
public final void clear()

Clears the content of the buffer and hides the front buffered overlay. This will cancel all pending requests to render. This is similar to cancel, however in addition to cancelling the pending render requests, this also clears the contents of the buffer. Similar to commit this will also hide the front buffered overlay.

commit

Added in 1.0.4
public final void commit()

Invalidates this View and draws the buffer within View#onDraw. This will synchronously hide the front buffered overlay when drawing the buffer to this View. Consumers are encouraged to invoke this method when a user gesture that requires low latency rendering is complete. For example in response to a MotionEvent.ACTION_UP event in an implementation of View.onTouchEvent.

execute

Added in 1.0.4
public final void execute(@NonNull Runnable runnable)

Dispatches a runnable to be executed on the background rendering thread. This is useful for updating data structures used to issue drawing instructions on the same thread that Callback.onDrawFrontBufferedLayer is invoked on.

renderFrontBufferedLayer

Added in 1.0.4
public final void renderFrontBufferedLayer()

Render content to the front buffered layer. This triggers a call to Callback.onDrawFrontBufferedLayer. Callback implementations can also configure the corresponding SurfaceControlCompat.Transaction that updates the contents on screen by implementing the optional Callback.onFrontBufferedLayerRenderComplete callback

setRenderCallback

Added in 1.0.4
public final void setRenderCallback(LowLatencyCanvasView.Callback callback)

Configures the Callback used to render contents to the front buffered overlay as well as optionally configuring the SurfaceControlCompat.Transaction used to update contents on screen.

Protected methods

onAttachedToWindow

protected void onAttachedToWindow()

onDraw

protected void onDraw(@NonNull Canvas canvas)

onLayout

protected void onLayout(boolean changed, int l, int t, int r, int b)