Engine

```
public interface Engine
```
Provides the 3D engine.
This interface is used to create and use the Advanced Graphic Platform (AGP) engine.

从以下版本开始:

3

嵌套类概要

嵌套类
限定符和类型	接口	说明
`static class`	`Engine.RenderBackend`	Indicates the type of the rendering backend, which can be either OpenGL ES or VULKAN.
`static class`	`Engine.RenderMode`	Indicates the rendering mode.
`static interface`	`Engine.RenderNodeGraph`	Configures a renderer.
`static class`	`Engine.RenderNodeGraphType`	Indicates the type of the rendering node graph.
`static interface`	`Engine.Time`	Provides engine time information.

方法概要

所有方法实例方法抽象方法
限定符和类型	方法	说明
`void`	`activateContext()`	Activates the rendering context.
`MeshBuilder`	`createMeshBuilder(int primitiveCount)`	Creates a `MeshBuilder` for building a 3D mesh.
`ViewHolder`	`createViewHolder(SurfaceProvider surfaceView)`	Creates a `ViewHolder` using `SurfaceProvider`.
`void`	`deactivateContext()`	Deactivates the OpenGl rendering context.
`Engine.Time`	`getEngineTime()`	Obtains the engine time.
`GltfExporter`	`getGltfExporter()`	Obtains a `GltfExporter` instance.
`GltfLoader`	`getGltfLoader()`	Obtains a `GltfLoader` instance.
`ResourceManager`	`getResourceManager()`	Obtains a `ResourceManager` instance.
`Scene`	`getScene()`	Obtains the default scene.
`String`	`getVersion()`	Obtains the engine version.
`boolean`	`handleDevGuiTouchEvent(TouchEvent event)`	Checks whether a touch event is processed on the GUI control of the engine.
`boolean`	`init(Context context, Engine.RenderBackend backend, Map<String,Object> backendExtra, String systemGraphUri)`	Initializes the engine.
`boolean`	`isDebugBuild()`	Checks whether the engine is of the debugging version (debug build).
`Engine.RenderNodeGraph`	`loadRenderNodeGraph(String renderNodeGraphUri)`	Loads a rendering node graph from the specified URI, which can be used to customize the rendering pipeline.
`void`	`postInRenderThread(Runnable task)`	Releases the task to run in a rendering thread.
`void`	`release()`	Deinitializes the initialized engine.
`void`	`renderFrame(Engine.RenderNodeGraph renderNodeGraph)`	Performs rendering on a frame using the customized rendering node graph.
`void`	`renderFrame(Engine.RenderNodeGraphType renderNodeGraphType)`	Render a frame using a built-in render graph.
`void`	`requestRender()`	Requests rendering on the next frame even if the engine or scene is not changed.
`void`	`requireRenderThread()`	Checks whether the current thread is a rendering thread.
`void`	`reset()`	Deinitializes and then initializes the entity-component system by deleting all of the loaded entities, components, and resources.
`void`	`resourceCleanup()`	Ensures that all GPU resources have been cleared.
`void`	`runInRenderThread(Runnable task)`	Runs a task in the rendering thread.
`void`	`setDefaultTargetBuffer(TargetBuffer targetBuffer)`	Sets the default rendering buffer for the engine.
`void`	`setDefaultTargetBuffers(TargetBuffer[] targetBuffers)`	Sets the default rendering buffers array for an engine.
`void`	`setRenderMode(Engine.RenderMode renderMode)`	Sets the rendering mode of an engine.
`boolean`	`update()`	Updates the engine state for rendering purposes.

- 方法详细资料
  - init
```
boolean init(Context context,
             Engine.RenderBackend backend,
             Map<String,Object> backendExtra,
             String systemGraphUri)
```
    Initializes the engine. You must call this method before using the engine. Extra backend mappings can be used to specify certain backend options.
    The OpenGL ES extra backend parameters are as follows:
    
    Key Type Default value
    
    "MSAA_SAMPLE_COUNT" Integer 0
    
    "DEPTH_BUFFER_BITS" Integer 24
    
    "ALPHA_BITS" Integer 0
    
    "STENCIL_BITS" Integer 0
    
    参数:
    
    context - Indicates the rendering context.
    
    backend - Indicates the backend rendering type.
    
    backendExtra - Indicates extra backend parameters transferred to the engine for initialization.
    
    systemGraphUri - Indicates the URI of the system graph file.
    
    返回:
    
    Returns true if the engine is initialized; returns false otherwise.
  - reset
```
void reset()
```
    Deinitializes and then initializes the entity-component system by deleting all of the loaded entities, components, and resources.
  - release
```
void release()
```
    Deinitializes the initialized engine.
  - resourceCleanup
```
void resourceCleanup()
```
    Ensures that all GPU resources have been cleared.
    GPU resources are usually allocated and released in RenderLoop. If RenderLoop is interrupted and the engine is not released, this method can be used to process pending resource tasks if any.
  - getVersion
```
String getVersion()
```
    Obtains the engine version.
    
    返回:
    
    Returns the engine version.
  - isDebugBuild
```
boolean isDebugBuild()
```
    Checks whether the engine is of the debugging version (debug build).
    
    返回:
    
    Returns true if the engine is of the debugging version; returns false otherwise.
  - setDefaultTargetBuffer
```
void setDefaultTargetBuffer(TargetBuffer targetBuffer)
```
    Sets the default rendering buffer for the engine. This method needs to be called again if the buffer size is changed.
    
    参数:
    
    targetBuffer - Indicates the rendering buffer of the engine.
  - setDefaultTargetBuffers
```
void setDefaultTargetBuffers(TargetBuffer[] targetBuffers)
```
    Sets the default rendering buffers array for an engine.
    
    参数:
    
    targetBuffers - Indicates the rendering buffers array of the engine.
  - getEngineTime
```
Engine.Time getEngineTime()
```
    Obtains the engine time.
    
    返回:
    
    Returns the engine time.
  - getResourceManager
```
ResourceManager getResourceManager()
```
    Obtains a ResourceManager instance.
    
    返回:
    
    Returns the ResourceManager instance.
  - getScene
```
Scene getScene()
```
    Obtains the default scene.
    
    返回:
    
    Returns the default scene.
  - getGltfLoader
```
GltfLoader getGltfLoader()
```
    Obtains a GltfLoader instance.
    
    返回:
    
    Returns the GltfLoader instance.
  - getGltfExporter
```
GltfExporter getGltfExporter()
```
    Obtains a GltfExporter instance.
    
    返回:
    
    Returns the GltfExporter instance.
  - createMeshBuilder
```
MeshBuilder createMeshBuilder(int primitiveCount)
```
    Creates a MeshBuilder for building a 3D mesh.
    
    参数:
    
    primitiveCount - Indicates the number of primitives in the mesh.
    
    返回:
    
    Returns the created MeshBuilder.
  - createViewHolder
```
ViewHolder createViewHolder(SurfaceProvider surfaceView)
```
    Creates a ViewHolder using SurfaceProvider.
    
    参数:
    
    surfaceView - Indicates the SurfaceProvider.
    
    返回:
    
    Returns the created ViewHolder.
  - loadRenderNodeGraph
```
Engine.RenderNodeGraph loadRenderNodeGraph(String renderNodeGraphUri)
```
    Loads a rendering node graph from the specified URI, which can be used to customize the rendering pipeline.
    
    参数:
    
    renderNodeGraphUri - Indicates the URI of the rendering node graph.
    
    返回:
    
    Returns the loaded rendering node graph. Returns an invalid rendering node graph if the loading fails.
  - setRenderMode
```
void setRenderMode(Engine.RenderMode renderMode)
```
    Sets the rendering mode of an engine.
    
    参数:
    
    renderMode - Indicates the rendering mode of the engine.
  - update
```
boolean update()
```
    Updates the engine state for rendering purposes. You can also use RenderLoop for the same purpose.
    
    返回:
    
    Returns true if rendering is required by the updated engine; returns false otherwise.
  - requestRender
```
void requestRender()
```
    Requests rendering on the next frame even if the engine or scene is not changed. This method is called when RenderMode#RENDER_IF_DIRTY is used.
  - renderFrame
```
void renderFrame(Engine.RenderNodeGraph renderNodeGraph)
```
    Performs rendering on a frame using the customized rendering node graph. If rendering is required, call Engine#update() before calling this method.
    
    参数:
    
    renderNodeGraph - Indicates the customized rendering node graph.
  - renderFrame
```
void renderFrame(Engine.RenderNodeGraphType renderNodeGraphType)
```
    Render a frame using a built-in render graph. call Engine#update() before calling this to see if rendering is actually required. Instead of calling this a RenderLoop can be used to simplify rendering.
    
    参数:
    
    renderNodeGraphType - render node graph to use when rendering.
  - activateContext
```
void activateContext()
```
    Activates the rendering context.
  - deactivateContext
```
void deactivateContext()
```
    Deactivates the OpenGl rendering context.
  - handleDevGuiTouchEvent
```
boolean handleDevGuiTouchEvent(TouchEvent event)
```
    Checks whether a touch event is processed on the GUI control of the engine.
    
    参数:
    
    event - Indicates the touch event.
    
    返回:
    
    Returns true if the touch event is processed; returns false otherwise.
  - requireRenderThread
```
void requireRenderThread()
```
    Checks whether the current thread is a rendering thread.
    
    抛出:
    
    IllegalStateException - Throws this exception if the current thread is not a rendering thread.
  - postInRenderThread
```
void postInRenderThread(Runnable task)
```
    Releases the task to run in a rendering thread.
    
    参数:
    
    task - Indicates the task to run.
  - runInRenderThread
```
void runInRenderThread(Runnable task)
```
    Runs a task in the rendering thread.
    If the rendering thread has already been called, the task runs immediately. Otherwise, the task is passed to the corresponding handle to run.
    
    参数:
    
    task - Indicates the task to run.

Key	Type	Default value
"MSAA_SAMPLE_COUNT"	Integer	0
"DEPTH_BUFFER_BITS"	Integer	24
"ALPHA_BITS"	Integer	0
"STENCIL_BITS"	Integer	0

接口 Engine

嵌套类概要

方法概要

方法详细资料

init

reset

release

resourceCleanup

getVersion

isDebugBuild

setDefaultTargetBuffer

setDefaultTargetBuffers

getEngineTime

getResourceManager

getScene

getGltfLoader

getGltfExporter

createMeshBuilder

createViewHolder

loadRenderNodeGraph

setRenderMode

update

requestRender

renderFrame

renderFrame

activateContext

deactivateContext

handleDevGuiTouchEvent

requireRenderThread

postInRenderThread

runInRenderThread