Constructor Detail

• EntityRenderer

  public EntityRenderer​(java.lang.String key,
                        byte features)

  Constructor of EntityRenderer

  Parameters:

  key - The key of the entity renderer

  features - The extra features of the entity renderer

• EntityRenderer

  public EntityRenderer​(java.lang.String key)

  Constructor of EntityRenderer

  Parameters:

  key - The key of the entity renderer

Method Detail

• initialize

  public void initialize​(Renderer renderer)

  Initialize the entity renderer

  Parameters:

  renderer -

• resetSceneCache

  public void resetSceneCache()
                       throws java.io.IOException

  The scene has changed or removed, need to dispose scene-level render resources in this

  Throws:

  java.io.IOException

• frameBegin

  public void frameBegin​(Renderer renderer,
                         IRenderQueue renderQueue)

  Begin rendering a frame

  Parameters:

  renderer - Current renderer

  renderQueue - Render queue

• frameEnd

  public void frameEnd​(Renderer renderer,
                       IRenderQueue renderQueue)

  Ends rendering a frame

  Parameters:

  renderer - Current renderer

  renderQueue - Render queue

• prepareRenderQueue

  public void prepareRenderQueue​(Renderer renderer,
                                 IRenderQueue queue,
                                 Node node,
                                 Entity entity)

  Prepare rendering commands for specified node/entity pair.

  Parameters:

  renderer - The current renderer instance

  queue - The render queue used to manage render tasks

  node - Current node

  entity - The entity that need to be rendered

• renderEntity

  public void renderEntity​(Renderer renderer,
                           ICommandList commandList,
                           Node node,
                           java.lang.Object renderableResource,
                           int subEntity)

  Each render task pushed to the IRenderQueue will have a corresponding RenderEntity call to perform the concrete rendering job.

  Parameters:

  renderer - The renderer

  commandList - The commandList used to record the rendering commands

  node - The same node that passed to PrepareRenderQueue of the entity that will be rendered

  renderableResource - The custom object that passed to IRenderQueue during the PrepareRenderQueue

  subEntity - The index of the sub entity that passed to IRenderQueue

• dispose

  public void dispose()
               throws java.io.IOException

  The entity renderer is being disposed, release shared resources.

  Throws:

  java.io.IOException