程序包 ohos.agp.render.render3d

类 RenderLoop

java.lang.Object

ohos.agp.render.render3d.RenderLoop

public class RenderLoop
extends Object

Auxiliary class used to manage rendering.

This class provides methods to start, stop, pause, or resume rendering loops, and to add or cancel tasks in the rendering loops.

从以下版本开始:

3

嵌套类概要

嵌套类

限定符和类型	类	说明
static interface	RenderLoop.FrameListener	Provides the listener for frame rendering events.

构造器概要

构造器

构造器	说明
RenderLoop(ViewHolder viewHolder, Engine engine)	Creates a rendering loop.

方法概要

限定符和类型	方法	说明
void	cancelAllTasks()	Cancels all tasks that are being executed.
boolean	cancelTask(Task task)	Cancels a task in the queue.
int	getVsyncCount()	Obtains the V-Sync based on rendering restrictions.
void	pause()	Pause rendering.
void	release()	Releases the rendering loop.
void	requestRender()	Requests rendering on a frame.
void	resume()	Resumes the rendering that has been paused.
void	setFrameListener(RenderLoop.FrameListener frameListener)	Sets the listener for frame events.
void	setRenderNodeGraph(Engine.RenderNodeGraph renderNodeGraph)	Sets the rendering node graph.
void	setRenderNodeGraph(Engine.RenderNodeGraphType renderNodeGraphType)	Sets the rendering node graph using a set of predefined options.
void	setVsyncCount(int vsyncCount)	Sets the vertical synchronization (VSync) based on the rendering frequency.
void	startRendering()	Starts the rendering loop.
void	stopRendering()	Stops the rendering loop.
void	submitTask(Task task)	Add a task that is to be executed in the rendering loop.

从类继承的方法 java.lang.Object

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

构造器详细资料

RenderLoop

public RenderLoop(ViewHolder viewHolder,
                  Engine engine)

Creates a rendering loop.

参数:

viewHolder - Indicates the view holder used as the rendering target.

engine - Indicates the rendering engine.

方法详细资料

setRenderNodeGraph

public void setRenderNodeGraph(Engine.RenderNodeGraph renderNodeGraph)

Sets the rendering node graph.

This method is used to configure the rendering pipeline. You can also use setRenderNodeGraph(ohos.agp.render.render3d.Engine.RenderNodeGraphType) to apply the default configuration.

参数:

renderNodeGraph - Indicates the rendering node graph.

抛出:

NullPointerException - Throws this exception if the parameter is null.

setRenderNodeGraph

public void setRenderNodeGraph(Engine.RenderNodeGraphType renderNodeGraphType)

Sets the rendering node graph using a set of predefined options.

参数:

renderNodeGraphType - Indicates the rendering node graph used for rendering.

抛出:

NullPointerException - Throws this exception if the parameter is null.

startRendering

public void startRendering()

Starts the rendering loop.

submitTask

public void submitTask(Task task)

Add a task that is to be executed in the rendering loop.

参数:

task - Indicates the task to execute.

cancelTask

public boolean cancelTask(Task task)

Cancels a task in the queue.

参数:

task - Indicates the task to cancel.

返回:

Returns true if the task is cleared from the queue; returns false otherwise.

cancelAllTasks

public void cancelAllTasks()

Cancels all tasks that are being executed.

requestRender

public void requestRender()

Requests rendering on a frame. The rendering on the next frame will start forcibly even if the scene is not in dirty state.

stopRendering

public void stopRendering()

Stops the rendering loop.

pause

public void pause()

Pause rendering.

resume

public void resume()

Resumes the rendering that has been paused.

setFrameListener

public void setFrameListener(RenderLoop.FrameListener frameListener)

Sets the listener for frame events.

参数:

frameListener - Indicates the listener for frame events.

setVsyncCount

public void setVsyncCount(int vsyncCount)

Sets the vertical synchronization (VSync) based on the rendering frequency. This method can be used to set the rendering frequency target, which depends on the V-Sync of the device.

The rendering frequency values 1, 2, and 3 indicate the rendering is performed on every frame, every other frame, and every three frames respectively. For example, if the VSync is 60 Hz and the rendering frequency value is 2, the rendering frame rate is 30 fps.

参数:

vsyncCount - v-sync based rendering frequency.

getVsyncCount

public int getVsyncCount()

Obtains the V-Sync based on rendering restrictions. For details, see setVsyncCount(int).

返回:

Returns the VSync based on rendering restrictions.

release

public void release()

Releases the rendering loop.