Package com.google.android.filament.android

Class DisplayHelper

java.lang.Object

com.google.android.filament.android.DisplayHelper

public class DisplayHelper
extends java.lang.Object

DisplayHelper is here to help managing a Display, for instance being notified when its resolution or refresh rate changes.

Constructor Summary

Constructors

Constructor	Description
DisplayHelper(android.content.Context context)	Creates a DisplayHelper which helps managing a Display.
DisplayHelper(android.content.Context context, android.os.Handler handler)	Creates a DisplayHelper which helps manage a Display and provides a Handler where callbacks can execute filament code.

Method Summary

Modifier and Type	Method	Description
void	attach(Renderer renderer, android.view.Display display)	Sets the filament Renderer associated to the Display, from this point on, Renderer.DisplayInfo will be automatically updated when the Display properties change.
void	detach()	Disconnect the previously set Renderer from Display This is typically called from UiHelper.RendererCallback.onDetachedFromSurface().
protected void	finalize()
static long	getAppVsyncOffsetNanos(android.view.Display display)
android.view.Display	getDisplay()	Returns the Display currently monitored
static Renderer.DisplayInfo	getDisplayInfo(android.view.Display display, Renderer.DisplayInfo info)	Populate a Renderer.DisplayInfo with properties from the given Display
static long	getPresentationDeadlineNanos(android.view.Display display)
static long	getRefreshPeriodNanos(android.view.Display display)	Returns a Display's refresh period in nanoseconds
static float	getRefreshRate(android.view.Display display)

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayHelper

public DisplayHelper(@NonNull
                     android.content.Context context)

Creates a DisplayHelper which helps managing a Display. The Display to manage is specified with attach(com.google.android.filament.Renderer, android.view.Display)

Parameters:

context - a Context to used to retrieve the DisplayManager

DisplayHelper

public DisplayHelper(@NonNull
                     android.content.Context context,
                     @NonNull
                     android.os.Handler handler)

Creates a DisplayHelper which helps manage a Display and provides a Handler where callbacks can execute filament code. Use this method if filament is executing on another thread.

Parameters:

context - a Context to used to retrieve teh DisplayManager

handler - a Handler used to run callbacks accessing filament

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

attach

public void attach(@NonNull
                   Renderer renderer,
                   @NonNull
                   android.view.Display display)

Sets the filament Renderer associated to the Display, from this point on, Renderer.DisplayInfo will be automatically updated when the Display properties change. This is typically called from UiHelper.RendererCallback.onNativeWindowChanged(android.view.Surface).

Parameters:

renderer - a filament Renderer instance

display - a Display to be associated with the Renderer

detach

public void detach()

Disconnect the previously set Renderer from Display This is typically called from UiHelper.RendererCallback.onDetachedFromSurface().

getDisplay

public android.view.Display getDisplay()

Returns the Display currently monitored

Returns:

the Display set in attach(com.google.android.filament.Renderer, android.view.Display) or null

getDisplayInfo

@NonNull
public static Renderer.DisplayInfo getDisplayInfo(@NonNull
                                                  android.view.Display display,
                                                  @Nullable
                                                  Renderer.DisplayInfo info)

Populate a Renderer.DisplayInfo with properties from the given Display

Parameters:

display - Display to get Renderer.DisplayInfo from

info - an instance of Renderer.DisplayInfo or null

Returns:

an populated instance of Renderer.DisplayInfo

getAppVsyncOffsetNanos

public static long getAppVsyncOffsetNanos(@NonNull
                                          android.view.Display display)

Returns:

the Display application vsync offset 0 if not supported

See Also:

Display.getAppVsyncOffsetNanos()

getPresentationDeadlineNanos

public static long getPresentationDeadlineNanos(@NonNull
                                                android.view.Display display)

Returns:

the Display presentation deadline before the h/w vsync event in nanoseconds

See Also:

Display.getPresentationDeadlineNanos()

getRefreshRate

public static float getRefreshRate(@NonNull
                                   android.view.Display display)

Returns:

the Display refresh rate in Hz

See Also:

Display.getRefreshRate()

getRefreshPeriodNanos

public static long getRefreshPeriodNanos(@NonNull
                                         android.view.Display display)

Returns a Display's refresh period in nanoseconds

Parameters:

display - the Display to get the refresh period from

Returns:

the Display refresh period in nanoseconds