com.badlogic.gdx.graphics.g3d.shaders

Class DepthShader

java.lang.Object

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

com.badlogic.gdx.graphics.g3d.shaders.DefaultShader

com.badlogic.gdx.graphics.g3d.shaders.DepthShader

All Implemented Interfaces:

Shader, Disposable

public class DepthShader
extends DefaultShader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DepthShader.Config

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

DefaultShader.Inputs, DefaultShader.Setters

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

BaseShader.Setter, BaseShader.Uniform, BaseShader.Validator

Field Summary

Fields

Modifier and Type	Field and Description
int	numBones
int	weights

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

defaultCullFace, defaultDepthFunc, u_alphaTest, u_bones, u_cameraDirection, u_cameraPosition, u_cameraUp, u_diffuseColor, u_diffuseTexture, u_emissiveColor, u_normalMatrix, u_normalTexture, u_opacity, u_projTrans, u_projViewTrans, u_projViewWorldTrans, u_reflectionColor, u_shininess, u_specularColor, u_specularTexture, u_time, u_viewTrans, u_viewWorldTrans, u_worldTrans

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

context, program

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	begin(Camera camera, RenderContext context) Initializes the context for exclusive rendering by this shader.
boolean	canRender(Renderable renderable) Checks whether this shader is intended to render the Renderable.
static String	createPrefix(Renderable renderable, DepthShader.Config config)
void	end() Cleanup the context so other shaders can render.
static String	getDefaultFragmentShader()
static String	getDefaultVertexShader()
void	render(Renderable renderable) Renders the Renderable, must be called between Shader.begin(Camera, RenderContext) and Shader.end().

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

compareTo, createPrefix, dispose, equals, equals, getDefaultCullFace, getDefaultDepthFunc, init, setDefaultCullFace, setDefaultDepthFunc

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

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

Field Detail

numBones

public final int numBones

weights

public final int weights

Constructor Detail

DepthShader

public DepthShader(Renderable renderable)

DepthShader

public DepthShader(Renderable renderable,
           DepthShader.Config config)

DepthShader

public DepthShader(Renderable renderable,
           DepthShader.Config config,
           String prefix)

DepthShader

public DepthShader(Renderable renderable,
           DepthShader.Config config,
           String prefix,
           String vertexShader,
           String fragmentShader)

DepthShader

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

Method Detail

getDefaultVertexShader

public static final String getDefaultVertexShader()

getDefaultFragmentShader

public static final String getDefaultFragmentShader()

createPrefix

public static String createPrefix(Renderable renderable,
                  DepthShader.Config config)

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 DefaultShader

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.

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 DefaultShader

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.

Specified by:

canRender in interface Shader

Overrides:

canRender in class DefaultShader

Parameters:

renderable - The renderable to check against this shader.

Returns:

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

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 DefaultShader

Parameters:

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