libGDX 1.14.2 · com.badlogic.gdx.graphics.g3d.ModelBatch

Modifier and Type	Class and Description
protected static class	ModelBatch.RenderablePool

Modifier and Type	Field and Description
protected Camera	camera
protected final RenderContext	context the `RenderContext`
private final boolean	ownContext
protected final Array<Renderable>	renderables list of Renderables to be rendered in the current batch
protected final ModelBatch.RenderablePool	renderablesPool
protected final ShaderProvider	shaderProvider the `ShaderProvider`, provides `Shader` instances for Renderables
protected final RenderableSorter	sorter the `RenderableSorter`

Constructor Summary

Access	Constructor and Description
public	ModelBatch(final RenderContext The `RenderContext` to use. context, final ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed. shaderProvider, final RenderableSorter The `RenderableSorter` to use. sorter) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
public	ModelBatch(final RenderContext The `RenderContext` to use. context, final ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed. shaderProvider) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
public	ModelBatch(final RenderContext The `RenderContext` to use. context, final RenderableSorter The `RenderableSorter` to use. sorter) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
public	ModelBatch(final RenderContext The `RenderContext` to use. context) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
public	ModelBatch(final ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed. shaderProvider, final RenderableSorter The `RenderableSorter` to use. sorter) Construct a ModelBatch
public	ModelBatch(final RenderableSorter The `RenderableSorter` to use. sorter) Construct a ModelBatch
public	ModelBatch(final ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed. shaderProvider) Construct a ModelBatch
public	ModelBatch(final FileHandle The `FileHandle` of the vertex shader to use. vertexShader, final FileHandle The `FileHandle` of the fragment shader to use. fragmentShader) Construct a ModelBatch with the default implementation and the specified ubershader.
public	ModelBatch(final String The vertex shader to use. vertexShader, final String The fragment shader to use. fragmentShader) Construct a ModelBatch with the default implementation and the specified ubershader.
public	ModelBatch() Construct a ModelBatch with the default implementation

Method Summary

Modifier and Type	Method and Description
public void	begin(final Camera The `Camera` to be used when rendering and sorting. cam) Start rendering one or more `Renderable`s.
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object.
public void	end() End rendering one or more `Renderable`s.
public void	flush() Flushes the batch, causing all `Renderable`s in the batch to be rendered.
public Camera	Returns: The current camera being used or null if called outside `begin(Camera)` and `end()`. getCamera() Provides access to the current camera in between `begin(Camera)` and `end()`.
public RenderableSorter	getRenderableSorter() Returns: the `RenderableSorter` used by this ModelBatch.
public RenderContext	getRenderContext() Returns: the `RenderContext` used by this ModelBatch.
public ShaderProvider	getShaderProvider() Returns: the `ShaderProvider` used by this ModelBatch.
public boolean	Returns: True if this ModelBatch owns the RenderContext, false otherwise. ownsRenderContext() Checks whether the `RenderContext` returned by `getRenderContext()` is owned and managed by this ModelBatch.
public void	render(final Renderable The `Renderable` to be added. renderable) Add a single `Renderable` to the batch.
public void	render(final RenderableProvider the renderable provider renderableProvider) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public <T extends RenderableProvider> void	render(final Iterable<T> one or more renderable providers renderableProviders) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public void	render(final RenderableProvider the renderable provider renderableProvider, final Environment the `Environment` to use for the renderables environment) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public <T extends RenderableProvider> void	render(final Iterable<T> one or more renderable providers renderableProviders, final Environment the `Environment` to use for the renderables environment) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public void	render(final RenderableProvider the renderable provider renderableProvider, final Shader the shader to use for the renderables shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public <T extends RenderableProvider> void	render(final Iterable<T> one or more renderable providers renderableProviders, final Shader the shader to use for the renderables shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public void	render(final RenderableProvider the renderable provider renderableProvider, final Environment the `Environment` to use for the renderables environment, final Shader the shader to use for the renderables shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public <T extends RenderableProvider> void	render(final Iterable<T> one or more renderable providers renderableProviders, final Environment the `Environment` to use for the renderables environment, final Shader the shader to use for the renderables shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered.
public void	setCamera(final Camera The new camera to use. cam) Change the camera in between `begin(Camera)` and `end()`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

camera	back to summary
protected Camera camera

context	back to summary
protected final RenderContext context the `RenderContext`

ownContext	back to summary
private final boolean ownContext

renderables	back to summary
protected final Array<Renderable> renderables list of Renderables to be rendered in the current batch

renderablesPool	back to summary
protected final ModelBatch.RenderablePool renderablesPool

shaderProvider	back to summary
protected final ShaderProvider shaderProvider the `ShaderProvider`, provides `Shader` instances for Renderables

sorter	back to summary
protected final RenderableSorter sorter the `RenderableSorter`

Constructor Detail

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final RenderContext context, final ShaderProvider shaderProvider, final RenderableSorter sorter) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself. Parameters context:RenderContext The `RenderContext` to use. shaderProvider:ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed. sorter:RenderableSorter The `RenderableSorter` to use.

public ModelBatch(final RenderContext context, final ShaderProvider shaderProvider, final RenderableSorter sorter)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters

context:RenderContext: The RenderContext to use.
shaderProvider:ShaderProvider: The ShaderProvider to use, will be disposed when this ModelBatch is disposed.
sorter:RenderableSorter: The RenderableSorter to use.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final RenderContext context, final ShaderProvider shaderProvider) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself. Parameters context:RenderContext The `RenderContext` to use. shaderProvider:ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed.

public ModelBatch(final RenderContext context, final ShaderProvider shaderProvider)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters

context:RenderContext: The RenderContext to use.
shaderProvider:ShaderProvider: The ShaderProvider to use, will be disposed when this ModelBatch is disposed.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final RenderContext context, final RenderableSorter sorter) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself. Parameters context:RenderContext The `RenderContext` to use. sorter:RenderableSorter The `RenderableSorter` to use.

public ModelBatch(final RenderContext context, final RenderableSorter sorter)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters

context:RenderContext: The RenderContext to use.
sorter:RenderableSorter: The RenderableSorter to use.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final RenderContext context) Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself. Parameters context:RenderContext The `RenderContext` to use.

public ModelBatch(final RenderContext context)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters

context:RenderContext: The RenderContext to use.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final ShaderProvider shaderProvider, final RenderableSorter sorter) Construct a ModelBatch Parameters shaderProvider:ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed. sorter:RenderableSorter The `RenderableSorter` to use.

public ModelBatch(final ShaderProvider shaderProvider, final RenderableSorter sorter)

Construct a ModelBatch

Parameters

shaderProvider:ShaderProvider: The ShaderProvider to use, will be disposed when this ModelBatch is disposed.
sorter:RenderableSorter: The RenderableSorter to use.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final RenderableSorter sorter) Construct a ModelBatch Parameters sorter:RenderableSorter The `RenderableSorter` to use.

public ModelBatch(final RenderableSorter sorter)

Construct a ModelBatch

Parameters

sorter:RenderableSorter: The RenderableSorter to use.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final ShaderProvider shaderProvider) Construct a ModelBatch Parameters shaderProvider:ShaderProvider The `ShaderProvider` to use, will be disposed when this ModelBatch is disposed.

public ModelBatch(final ShaderProvider shaderProvider)

Construct a ModelBatch

Parameters

shaderProvider:ShaderProvider: The ShaderProvider to use, will be disposed when this ModelBatch is disposed.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final FileHandle vertexShader, final FileHandle fragmentShader) Construct a ModelBatch with the default implementation and the specified ubershader. See `DefaultShader` for more information about using a custom ubershader. Requires OpenGL ES 2.0. Parameters vertexShader:FileHandle The `FileHandle` of the vertex shader to use. fragmentShader:FileHandle The `FileHandle` of the fragment shader to use.

public ModelBatch(final FileHandle vertexShader, final FileHandle fragmentShader)

Construct a ModelBatch with the default implementation and the specified ubershader. See DefaultShader for more information about using a custom ubershader. Requires OpenGL ES 2.0.

Parameters

vertexShader:FileHandle: The FileHandle of the vertex shader to use.
fragmentShader:FileHandle: The FileHandle of the fragment shader to use.

ModelBatch back to summary

ModelBatch	back to summary
public ModelBatch(final String vertexShader, final String fragmentShader) Construct a ModelBatch with the default implementation and the specified ubershader. See `DefaultShader` for more information about using a custom ubershader. Requires OpenGL ES 2.0. Parameters vertexShader:String The vertex shader to use. fragmentShader:String The fragment shader to use.

public ModelBatch(final String vertexShader, final String fragmentShader)

Construct a ModelBatch with the default implementation and the specified ubershader. See DefaultShader for more information about using a custom ubershader. Requires OpenGL ES 2.0.

Parameters

vertexShader:String: The vertex shader to use.
fragmentShader:String: The fragment shader to use.

ModelBatch	back to summary
public ModelBatch() Construct a ModelBatch with the default implementation

Method Detail

begin back to summary

begin	back to summary
public void begin(final Camera cam) Start rendering one or more `Renderable`s. Use one of the render() methods to provide the renderables. Must be followed by a call to `end()`. The OpenGL context must not be altered between `begin(Camera)` and `end()`. Parameters cam:Camera The `Camera` to be used when rendering and sorting.

public void begin(final Camera cam)

Start rendering one or more Renderables. Use one of the render() methods to provide the renderables. Must be followed by a call to end(). The OpenGL context must not be altered between begin(Camera) and end().

Parameters

cam:Camera: The Camera to be used when rendering and sorting.

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Doc from com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object. Annotations @Override

dispose

back to summary

public void dispose()

Implements com.badlogic.gdx.utils.Disposable.dispose.

Doc from com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

Annotations

@Override

end	back to summary
public void end() End rendering one or more `Renderable`s. Must be called after a call to `begin(Camera)`. This will flush the batch, causing any renderables provided using one of the render() methods to be rendered. After a call to this method the OpenGL context can be altered again.

flush	back to summary
public void flush() Flushes the batch, causing all `Renderable`s in the batch to be rendered. Can only be called after the call to `begin(Camera)` and before the call to `end()`.

getCamera back to summary

getCamera	back to summary
public Camera getCamera() Provides access to the current camera in between `begin(Camera)` and `end()`. Do not change the camera's values. Use `setCamera(Camera)`, if you need to change the camera. Returns:Camera The current camera being used or null if called outside `begin(Camera)` and `end()`.

public Camera getCamera()

Provides access to the current camera in between begin(Camera) and end(). Do not change the camera's values. Use setCamera(Camera), if you need to change the camera.

Returns:Camera: The current camera being used or null if called outside begin(Camera) and end().

getRenderableSorter	back to summary
public RenderableSorter getRenderableSorter() Returns:RenderableSorter the `RenderableSorter` used by this ModelBatch.

getRenderContext	back to summary
public RenderContext getRenderContext() Returns:RenderContext the `RenderContext` used by this ModelBatch.

getShaderProvider	back to summary
public ShaderProvider getShaderProvider() Returns:ShaderProvider the `ShaderProvider` used by this ModelBatch.

ownsRenderContext back to summary

ownsRenderContext	back to summary
public boolean ownsRenderContext() Checks whether the `RenderContext` returned by `getRenderContext()` is owned and managed by this ModelBatch. When the RenderContext isn't owned by the ModelBatch, you are responsible for calling the `RenderContext#begin()` and `RenderContext#end()` methods yourself, as well as disposing the RenderContext. Returns:boolean True if this ModelBatch owns the RenderContext, false otherwise.

public boolean ownsRenderContext()

Checks whether the RenderContext returned by getRenderContext() is owned and managed by this ModelBatch. When the RenderContext isn't owned by the ModelBatch, you are responsible for calling the RenderContext#begin() and RenderContext#end() methods yourself, as well as disposing the RenderContext.

Returns:boolean: True if this ModelBatch owns the RenderContext, false otherwise.

render back to summary

render	back to summary
public void render(final Renderable renderable) Add a single `Renderable` to the batch. The `ShaderProvider` will be used to fetch a suitable `Shader`. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderable:Renderable The `Renderable` to be added.

public void render(final Renderable renderable)

Add a single Renderable to the batch. The ShaderProvider will be used to fetch a suitable Shader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters

renderable:Renderable: The Renderable to be added.

render back to summary

render	back to summary
public void render(final RenderableProvider renderableProvider) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProvider:RenderableProvider the renderable provider

public void render(final RenderableProvider renderableProvider)

Calls RenderableProvider#getRenderables(Array, Pool) and adds all returned Renderable instances to the current batch to be rendered. Can only be called after a call to begin(Camera) and before a call to end().

Parameters

renderableProvider:RenderableProvider: the renderable provider

render back to summary

render	back to summary
public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProviders:Iterable<T> one or more renderable providers

public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders)

Parameters

renderableProviders:Iterable<T>: one or more renderable providers

render back to summary

render	back to summary
public void render(final RenderableProvider renderableProvider, final Environment environment) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProvider:RenderableProvider the renderable provider environment:Environment the `Environment` to use for the renderables

public void render(final RenderableProvider renderableProvider, final Environment environment)

Calls RenderableProvider#getRenderables(Array, Pool) and adds all returned Renderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Can only be called after a call to begin(Camera) and before a call to end().

Parameters

renderableProvider:RenderableProvider: the renderable provider
environment:Environment: the Environment to use for the renderables

render back to summary

render	back to summary
public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders, final Environment environment) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProviders:Iterable<T> one or more renderable providers environment:Environment the `Environment` to use for the renderables

public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders, final Environment environment)

Parameters

renderableProviders:Iterable<T>: one or more renderable providers
environment:Environment: the Environment to use for the renderables

render back to summary

render	back to summary
public void render(final RenderableProvider renderableProvider, final Shader shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Any shaders set on the returned renderables will be replaced with the given `Shader`. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProvider:RenderableProvider the renderable provider shader:Shader the shader to use for the renderables

public void render(final RenderableProvider renderableProvider, final Shader shader)

Calls RenderableProvider#getRenderables(Array, Pool) and adds all returned Renderable instances to the current batch to be rendered. Any shaders set on the returned renderables will be replaced with the given Shader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters

renderableProvider:RenderableProvider: the renderable provider
shader:Shader: the shader to use for the renderables

render back to summary

render	back to summary
public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders, final Shader shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Any shaders set on the returned renderables will be replaced with the given `Shader`. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProviders:Iterable<T> one or more renderable providers shader:Shader the shader to use for the renderables

public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders, final Shader shader)

Parameters

renderableProviders:Iterable<T>: one or more renderable providers
shader:Shader: the shader to use for the renderables

render back to summary

render	back to summary
public void render(final RenderableProvider renderableProvider, final Environment environment, final Shader shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Any shaders set on the returned renderables will be replaced with the given `Shader`. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProvider:RenderableProvider the renderable provider environment:Environment the `Environment` to use for the renderables shader:Shader the shader to use for the renderables

public void render(final RenderableProvider renderableProvider, final Environment environment, final Shader shader)

Calls RenderableProvider#getRenderables(Array, Pool) and adds all returned Renderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Any shaders set on the returned renderables will be replaced with the given Shader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters

renderableProvider:RenderableProvider: the renderable provider
environment:Environment: the Environment to use for the renderables
shader:Shader: the shader to use for the renderables

render back to summary

render	back to summary
public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders, final Environment environment, final Shader shader) Calls `RenderableProvider#getRenderables(Array, Pool)` and adds all returned `Renderable` instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Any shaders set on the returned renderables will be replaced with the given `Shader`. Can only be called after a call to `begin(Camera)` and before a call to `end()`. Parameters renderableProviders:Iterable<T> one or more renderable providers environment:Environment the `Environment` to use for the renderables shader:Shader the shader to use for the renderables

public <T extends RenderableProvider> void render(final Iterable<T> renderableProviders, final Environment environment, final Shader shader)

Calls RenderableProvider#getRenderables(Array, Pool) and adds all returned Renderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Any shaders set on the returned renderables will be replaced with the given Shader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters

renderableProviders:Iterable<T>: one or more renderable providers
environment:Environment: the Environment to use for the renderables
shader:Shader: the shader to use for the renderables

setCamera back to summary

setCamera	back to summary
public void setCamera(final Camera cam) Change the camera in between `begin(Camera)` and `end()`. This causes the batch to be flushed. Can only be called after the call to `begin(Camera)` and before the call to `end()`. Parameters cam:Camera The new camera to use.

public void setCamera(final Camera cam)

Change the camera in between begin(Camera) and end(). This causes the batch to be flushed. Can only be called after the call to begin(Camera) and before the call to end().

Parameters

cam:Camera: The new camera to use.

public Class ModelBatch

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class ModelBatch.RenderablePool

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
protected Renderable	newObject() Implements abstract com.badlogic.gdx.utils.Pool.newObject.
public Renderable	obtain() Overrides com.badlogic.gdx.utils.FlushablePool.obtain. Returns an object from this pool.