com.badlogic.gdx.graphics.g3d.particles

Class ParticleShader

java.lang.Object

com.badlogic.gdx.graphics.g3d.shaders.BaseShader

com.badlogic.gdx.graphics.g3d.particles.ParticleShader

All Implemented Interfaces:

Shader, Disposable

public class ParticleShader
extends BaseShader

This is a custom shader to render the particles. Usually is not required, because the DefaultShader will be used instead. This shader will be used when dealing with billboards using GPU mode or point sprites.

Author:

inferno

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParticleShader.AlignMode
static class	ParticleShader.Config
static class	ParticleShader.Inputs
static class	ParticleShader.ParticleType
static class	ParticleShader.Setters

Nested classes/interfaces inherited from class com.badlogic.gdx.graphics.g3d.shaders.BaseShader

BaseShader.GlobalSetter, BaseShader.LocalSetter, BaseShader.Setter, BaseShader.Uniform, BaseShader.Validator

Field Summary

Fields

Modifier and Type	Field and Description
protected ParticleShader.Config	config
protected static long	implementedFlags

Fields inherited from class com.badlogic.gdx.graphics.g3d.shaders.BaseShader

camera, context, program

Constructor Summary

Constructors

Constructor and Description
ParticleShader(Renderable renderable)
ParticleShader(Renderable renderable, ParticleShader.Config config)
ParticleShader(Renderable renderable, ParticleShader.Config config, ShaderProgram shaderProgram)
ParticleShader(Renderable renderable, ParticleShader.Config config, java.lang.String prefix)
ParticleShader(Renderable renderable, ParticleShader.Config config, java.lang.String prefix, java.lang.String vertexShader, java.lang.String fragmentShader)

Method Summary

Modifier and Type	Method and Description
void	begin(Camera camera, RenderContext context) Initializes the context for exclusive rendering by this shader.
protected void	bindMaterial(Renderable renderable)
boolean	canRender(Renderable renderable) Checks whether this shader is intended to render the Renderable.
int	compareTo(Shader other) Compare this shader against the other, used for sorting, light weight shaders are rendered first.
static java.lang.String	createPrefix(Renderable renderable, ParticleShader.Config config)
void	dispose() Releases all resources of this object.
void	end() Cleanup the context so other shaders can render.
boolean	equals(java.lang.Object obj)
boolean	equals(ParticleShader obj)
int	getDefaultCullFace()
int	getDefaultDepthFunc()
static java.lang.String	getDefaultFragmentShader()
static java.lang.String	getDefaultVertexShader()
void	init() Initializes the Shader, must be called before the Shader can be used.
void	render(Renderable renderable) Renders the Renderable, must be called between Shader.begin(Camera, RenderContext) and Shader.end().
void	setDefaultCullFace(int cullFace)
void	setDefaultDepthFunc(int depthFunc)

Methods inherited from class com.badlogic.gdx.graphics.g3d.shaders.BaseShader

getUniformAlias, getUniformID, has, init, loc, register, register, register, register, register, register, render, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

implementedFlags

protected static long implementedFlags

config

protected final ParticleShader.Config config

Constructor Detail

ParticleShader

public ParticleShader(Renderable renderable)

ParticleShader

public ParticleShader(Renderable renderable,
                      ParticleShader.Config config)

ParticleShader

public ParticleShader(Renderable renderable,
                      ParticleShader.Config config,
                      java.lang.String prefix)

ParticleShader

public ParticleShader(Renderable renderable,
                      ParticleShader.Config config,
                      java.lang.String prefix,
                      java.lang.String vertexShader,
                      java.lang.String fragmentShader)

ParticleShader

public ParticleShader(Renderable renderable,
                      ParticleShader.Config config,
                      ShaderProgram shaderProgram)

Method Detail

getDefaultVertexShader

public static java.lang.String getDefaultVertexShader()

getDefaultFragmentShader

public static java.lang.String getDefaultFragmentShader()

init

public void init()

Description copied from interface: Shader

Initializes the Shader, must be called before the Shader can be used. This typically compiles a ShaderProgram, fetches uniform locations and performs other preparations for usage of the Shader.

createPrefix

public static java.lang.String createPrefix(Renderable renderable,
                                            ParticleShader.Config config)

canRender

public boolean canRender(Renderable renderable)

Description copied from interface: Shader

Checks whether this shader is intended to render the Renderable. Use this to make sure a call to the Shader.render(Renderable) method will succeed. This is expected to be a fast, non-blocking method. Note that this method will only return true if it is intended to be used. Even when it returns false the Shader might still be capable of rendering, but it's not preferred to do so.

Parameters:

renderable - The renderable to check against this shader.

Returns:

true if this shader is intended to render the Renderable, false otherwise.

compareTo

public int compareTo(Shader other)

Description copied from interface: Shader

Compare this shader against the other, used for sorting, light weight shaders are rendered first.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(ParticleShader obj)

begin

public void begin(Camera camera,
                  RenderContext context)

Description copied from interface: Shader

Initializes the context for exclusive rendering by this shader. Use the Shader.render(Renderable) method to render a Renderable. When done rendering the Shader.end() method must be called.

Specified by:

begin in interface Shader

Overrides:

begin in class BaseShader

Parameters:

camera - The camera to use when rendering

context - The context to be used, which must be exclusive available for the shader until the call to the Shader.end() method.

render

public void render(Renderable renderable)

Description copied from interface: Shader

Renders the Renderable, must be called between Shader.begin(Camera, RenderContext) and Shader.end(). The Shader instance might not be able to render every type of Renderables. Use the Shader.canRender(Renderable) method to check if the Shader is capable of rendering a specific Renderable.

Specified by:

render in interface Shader

Overrides:

render in class BaseShader

Parameters:

renderable - The renderable to render, all required fields (e.g. Renderable.material and others) must be set. The Renderable.shader field will be ignored.

end

public void end()

Description copied from interface: Shader

Cleanup the context so other shaders can render. Must be called when done rendering using the Shader.render(Renderable) method, which must be preceded by a call to Shader.begin(Camera, RenderContext). After a call to this method an call to the Shader.render(Renderable) method will fail until the Shader.begin(Camera, RenderContext) is called.

Specified by:

end in interface Shader

Overrides:

end in class BaseShader

bindMaterial

protected void bindMaterial(Renderable renderable)

dispose

public void dispose()

Description copied from interface: Disposable

Releases all resources of this object.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class BaseShader

getDefaultCullFace

public int getDefaultCullFace()

setDefaultCullFace

public void setDefaultCullFace(int cullFace)

getDefaultDepthFunc

public int getDefaultDepthFunc()

setDefaultDepthFunc

public void setDefaultDepthFunc(int depthFunc)