com.bonzaiengine.renderer

Class Renderer

java.lang.Object

com.bonzaiengine.renderer.Renderer

public final class Renderer
extends java.lang.Object

Usage for optimized rendering of a collection of model, batch, etc ...:

  RendererPipeline pipeline = BonzaiEngine.get().getRenderer();
  pipeline.start(glApi);
  for(...) {
        pipeline.render(...);
  }
  pipeline.end();
  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Renderer.Pass

Field Summary

Fields

Modifier and Type	Field and Description
static float	POLYGON_OFFSET_SCALE Polygon offset scale
static float	POLYGON_OFFSET_UNITS Polygon offset unit

Constructor Summary

Constructors

Constructor and Description
Renderer(BonzaiEngine engine) For internal use.

Method Summary

Modifier and Type	Method and Description
BatchProfile	end() End of model rendering
Batch	getBatch()
IGLApi	getCurrentContext()
int	getNumBatchForTransparentPass()
SamplerState	getSamplerState()
boolean	isRenderingContext(IGL gl)
boolean	isRenderingContextSet()
static void	onContextLost(HwData hwData)
static void	recycle(IDestroyable destroyable) Deprecated.
void	render(Batch batch, RenderOptions renderOptions, Transform t, Shader shader, int numHwInstances)
void	render(Batch batch, Transform t, boolean diffuseTexture, boolean alphaTest, Lights<?> lights, int numHwInstances)
void	render(Batch batch, Transform t, IMaterial material, int numHwInstances)
void	render(Batch batch, Transform t, Shader shader, int numHwInstances)
static BatchProfile	render(IGLApi glApi, Model model, RenderOptions renderOptions) Deprecated.
void	render(Model model, RenderOptions renderOptions) Usage: RendererPipeline pipeline = BonzaiEngine.get().getRendererPipeline(); pipeline.start(glApi); // Render all models pipeline.render(model, renderOptions); [...]
void	render(Model model, RenderOptions renderOptions, Renderer.Pass pass)
void	setDefaultStates() Reset OpenGL states to default.
void	setRenderingContext(IGL renderingContext)
void	setRenderState(RenderState renderState)
void	start(IGLApi glApi) Start rendering models

Methods inherited from class java.lang.Object

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

Field Detail

POLYGON_OFFSET_SCALE

public static float POLYGON_OFFSET_SCALE

Polygon offset scale

POLYGON_OFFSET_UNITS

public static float POLYGON_OFFSET_UNITS

Polygon offset unit

Constructor Detail

Renderer

public Renderer(BonzaiEngine engine)

For internal use.

See Also:

BonzaiEngine.getRenderer()

Method Detail

setRenderingContext

public void setRenderingContext(IGL renderingContext)

isRenderingContextSet

public boolean isRenderingContextSet()

isRenderingContext

public boolean isRenderingContext(IGL gl)

getSamplerState

public SamplerState getSamplerState()

recycle

@Deprecated
public static final void recycle(IDestroyable destroyable)

Deprecated.

render

@Deprecated
public static final BatchProfile render(IGLApi glApi,
                                                     Model model,
                                                     RenderOptions renderOptions)

Deprecated.

For rendering more than one Model or Batch, the preferred way is:

  RendererPipeline pipeline = BonzaiEngine.get().getRendererPipeline();
  pipeline.start(glApi);
  for(...) {
        pipeline.render(model, ...);
        pipeline.render(batch, ...);
  }
  pipeline.end();
  

See Also:

start(IGLApi), render(Model, RenderOptions), end()

start

public final void start(IGLApi glApi)

Start rendering models

setDefaultStates

public final void setDefaultStates()

Reset OpenGL states to default. This is not usually useful, as it is ensures by start(IGLApi) and called by end().
It however may be useful in particular situation where some OpenGL calls are inserted while the Renderer is active and when OpenGL states affect them.
Only the states change by the renderer will be reseted to default.

getCurrentContext

public IGLApi getCurrentContext()

Returns:

the current opengl context, only valid between start(IGLApi) and end()

Throws:

java.lang.IllegalStateException - if not called between start(IGLApi) and end()

setRenderState

public void setRenderState(RenderState renderState)

render

public final void render(Batch batch,
                         Transform t,
                         IMaterial material,
                         int numHwInstances)

render

public final void render(Batch batch,
                         Transform t,
                         boolean diffuseTexture,
                         boolean alphaTest,
                         Lights<?> lights,
                         int numHwInstances)

See Also:

setRenderState(RenderState)

render

public final void render(Batch batch,
                         Transform t,
                         Shader shader,
                         int numHwInstances)

render

public final void render(Batch batch,
                         RenderOptions renderOptions,
                         Transform t,
                         Shader shader,
                         int numHwInstances)

render

public final void render(Model model,
                         RenderOptions renderOptions)

Usage:

  RendererPipeline pipeline = BonzaiEngine.get().getRendererPipeline();
  pipeline.start(glApi);
  // Render all models
  pipeline.render(model, renderOptions);
  [...]
  pipeline.end();
  

Note: For performance, it's best to reduce the number of start/end per frame to ideally only one.

See Also:

start(IGLApi), end()

render

public final void render(Model model,
                         RenderOptions renderOptions,
                         Renderer.Pass pass)

Parameters:

model -

renderOptions -

pass - #Pass.All #Pass.Opaque or #Pass.Transparent

See Also:

render(Model, RenderOptions)

onContextLost

public static final void onContextLost(HwData hwData)

end

public final BatchProfile end()

End of model rendering

Returns:

BatchProfile of all objects rendered

getBatch

public final Batch getBatch()

getNumBatchForTransparentPass

public final int getNumBatchForTransparentPass()