IEngine

  • The IEngine interface supports multiple implementations of the Filament engine, including FilamentEngineWrapper and HeadlessEngineWrapper.

  • It provides methods for creating and destroying core rendering components like cameras, scenes, renderers, and swap chains.

  • Developers can use IEngine to manage resources such as materials, textures, vertex buffers, and index buffers.

  • IEngine offers access to Filament's LightManager, RenderableManager, and TransformManager for manipulating scene elements.

  • The interface includes methods for ensuring engine validity and synchronizing operations with flushAndWait.
public interface IEngine
Known Indirect Subclasses

Engine interface to support multiple flavors of the getFilamentEngine filament engine.

Public Methods

abstract Camera
createCamera()
abstract Camera
createCamera(int entity)
abstract Fence
createFence()
abstract Renderer
createRenderer()
abstract Scene
createScene()
abstract SwapChain
createSwapChain(Object surface, long flags)
Valid surface types: - Android: Surface - Other: none

Flags: see CONFIG flags in SwapChain.
abstract SwapChain
createSwapChain(Object surface)
Valid surface types: - Android: Surface - Other: none
abstract SwapChain
createSwapChainFromNativeSurface(NativeSurface surface, long flags)
abstract View
createView()
abstract void
destroy()
abstract void
destroyCamera(Camera camera)
abstract void
destroyEntity(int entity)
abstract void
destroyFence(Fence fence)
abstract void
destroyIndexBuffer(IndexBuffer indexBuffer)
abstract void
destroyIndirectLight(IndirectLight ibl)
abstract void
destroyMaterial(Material material)
abstract void
destroyMaterialInstance(MaterialInstance materialInstance)
abstract void
destroyRenderer(Renderer renderer)
abstract void
destroyScene(Scene scene)
abstract void
destroySkybox(Skybox skybox)
abstract void
destroyStream(Stream stream)
abstract void
destroySwapChain(SwapChain swapChain)
abstract void
destroyTexture(Texture texture)
abstract void
destroyVertexBuffer(VertexBuffer vertexBuffer)
abstract void
destroyView(View view)
abstract void
flushAndWait()
abstract Engine
getFilamentEngine()
abstract LightManager
getLightManager()
abstract RenderableManager
getRenderableManager()
abstract TransformManager
getTransformManager()
abstract boolean
isValid()

Public Methods

public abstract Camera createCamera ()

public abstract Camera createCamera (int entity)

Parameters
entity

public abstract Fence createFence ()

public abstract Renderer createRenderer ()

public abstract Scene createScene ()

public abstract SwapChain createSwapChain (Object surface, long flags)

Valid surface types: - Android: Surface - Other: none

Flags: see CONFIG flags in SwapChain.

Parameters
surface
flags
See Also

public abstract SwapChain createSwapChain (Object surface)

Valid surface types: - Android: Surface - Other: none

Parameters
surface

public abstract SwapChain createSwapChainFromNativeSurface (NativeSurface surface, long flags)

Parameters
surface
flags

public abstract View createView ()

public abstract void destroy ()

public abstract void destroyCamera (Camera camera)

Parameters
camera

public abstract void destroyEntity (int entity)

Parameters
entity

public abstract void destroyFence (Fence fence)

Parameters
fence

public abstract void destroyIndexBuffer (IndexBuffer indexBuffer)

Parameters
indexBuffer

public abstract void destroyIndirectLight (IndirectLight ibl)

Parameters
ibl

public abstract void destroyMaterial (Material material)

Parameters
material

public abstract void destroyMaterialInstance (MaterialInstance materialInstance)

Parameters
materialInstance

public abstract void destroyRenderer (Renderer renderer)

Parameters
renderer

public abstract void destroyScene (Scene scene)

Parameters
scene

public abstract void destroySkybox (Skybox skybox)

Parameters
skybox

public abstract void destroyStream (Stream stream)

Parameters
stream

public abstract void destroySwapChain (SwapChain swapChain)

Parameters
swapChain

public abstract void destroyTexture (Texture texture)

Parameters
texture

public abstract void destroyVertexBuffer (VertexBuffer vertexBuffer)

Parameters
vertexBuffer

public abstract void destroyView (View view)

Parameters
view

public abstract void flushAndWait ()

public abstract Engine getFilamentEngine ()

public abstract LightManager getLightManager ()

public abstract RenderableManager getRenderableManager ()

public abstract TransformManager getTransformManager ()

public abstract boolean isValid ()