DefaultShader (libGDX Core 1.5.1 API)

java.lang.Object
- com.badlogic.gdx.graphics.g3d.shaders.BaseShader
- - com.badlogic.gdx.graphics.g3d.shaders.DefaultShader

All Implemented Interfaces:

Shader, Disposable

Direct Known Subclasses:

DepthShader
```
public class DefaultShader
extends BaseShader
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultShader.Config

static class DefaultShader.Inputs

static class DefaultShader.Setters
- Nested classes/interfaces inherited from class com.badlogic.gdx.graphics.g3d.shaders.BaseShader
  BaseShader.GlobalSetter, BaseShader.LocalSetter, BaseShader.Setter, BaseShader.Uniform, BaseShader.Validator

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultShader.Config`
`static class`	`DefaultShader.Inputs`
`static class`	`DefaultShader.Setters`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`defaultCullFace` Deprecated. Replaced by `DefaultShader.Config.defaultCullFace` Set to 0 to disable culling
`static int`	`defaultDepthFunc` Deprecated. Replaced by `DefaultShader.Config.defaultDepthFunc` Set to 0 to disable depth test
`int`	`u_alphaTest`
`int`	`u_ambientTexture`
`int`	`u_ambientUVTransform`
`int`	`u_bones`
`int`	`u_cameraDirection`
`int`	`u_cameraPosition`
`int`	`u_cameraUp`
`int`	`u_diffuseColor`
`int`	`u_diffuseTexture`
`int`	`u_diffuseUVTransform`
`int`	`u_emissiveColor`
`int`	`u_emissiveTexture`
`int`	`u_emissiveUVTransform`
`int`	`u_normalMatrix`
`int`	`u_normalTexture`
`int`	`u_normalUVTransform`
`int`	`u_opacity`
`int`	`u_projTrans`
`int`	`u_projViewTrans`
`int`	`u_projViewWorldTrans`
`int`	`u_reflectionColor`
`int`	`u_reflectionTexture`
`int`	`u_reflectionUVTransform`
`int`	`u_shininess`
`int`	`u_specularColor`
`int`	`u_specularTexture`
`int`	`u_specularUVTransform`
`int`	`u_time`
`int`	`u_viewTrans`
`int`	`u_viewWorldTrans`
`int`	`u_worldTrans`

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

Constructor Summary

Constructors
Constructor and Description
`DefaultShader(Renderable renderable)`
`DefaultShader(Renderable renderable, DefaultShader.Config config)`
`DefaultShader(Renderable renderable, DefaultShader.Config config, ShaderProgram shaderProgram)`
`DefaultShader(Renderable renderable, DefaultShader.Config config, String prefix)`
`DefaultShader(Renderable renderable, DefaultShader.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`.
`int`	`compareTo(Shader other)` Compare this shader against the other, used for sorting, light weight shaders are rendered first.
`static String`	`createPrefix(Renderable renderable, DefaultShader.Config config)`
`void`	`dispose()` Releases all resources of this object.
`void`	`end()` Cleanup the context so other shaders can render.
`boolean`	`equals(DefaultShader obj)`
`boolean`	`equals(Object obj)`
`int`	`getDefaultCullFace()`
`int`	`getDefaultDepthFunc()`
`static String`	`getDefaultFragmentShader()`
`static 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
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultCullFace
```
@Deprecated
public static int defaultCullFace
```
    Deprecated. Replaced by DefaultShader.Config.defaultCullFace Set to 0 to disable culling
  - defaultDepthFunc
```
@Deprecated
public static int defaultDepthFunc
```
    Deprecated. Replaced by DefaultShader.Config.defaultDepthFunc Set to 0 to disable depth test
  - u_projTrans
```
public final int u_projTrans
```
  - u_viewTrans
```
public final int u_viewTrans
```
  - u_projViewTrans
```
public final int u_projViewTrans
```
  - u_cameraPosition
```
public final int u_cameraPosition
```
  - u_cameraDirection
```
public final int u_cameraDirection
```
  - u_cameraUp
```
public final int u_cameraUp
```
  - u_time
```
public final int u_time
```
  - u_worldTrans
```
public final int u_worldTrans
```
  - u_viewWorldTrans
```
public final int u_viewWorldTrans
```
  - u_projViewWorldTrans
```
public final int u_projViewWorldTrans
```
  - u_normalMatrix
```
public final int u_normalMatrix
```
  - u_bones
```
public final int u_bones
```
  - u_shininess
```
public final int u_shininess
```
  - u_opacity
```
public final int u_opacity
```
  - u_diffuseColor
```
public final int u_diffuseColor
```
  - u_diffuseTexture
```
public final int u_diffuseTexture
```
  - u_diffuseUVTransform
```
public final int u_diffuseUVTransform
```
  - u_specularColor
```
public final int u_specularColor
```
  - u_specularTexture
```
public final int u_specularTexture
```
  - u_specularUVTransform
```
public final int u_specularUVTransform
```
  - u_emissiveColor
```
public final int u_emissiveColor
```
  - u_emissiveTexture
```
public final int u_emissiveTexture
```
  - u_emissiveUVTransform
```
public final int u_emissiveUVTransform
```
  - u_reflectionColor
```
public final int u_reflectionColor
```
  - u_reflectionTexture
```
public final int u_reflectionTexture
```
  - u_reflectionUVTransform
```
public final int u_reflectionUVTransform
```
  - u_normalTexture
```
public final int u_normalTexture
```
  - u_normalUVTransform
```
public final int u_normalUVTransform
```
  - u_ambientTexture
```
public final int u_ambientTexture
```
  - u_ambientUVTransform
```
public final int u_ambientUVTransform
```
  - u_alphaTest
```
public final int u_alphaTest
```
- Constructor Detail
  - DefaultShader
```
public DefaultShader(Renderable renderable)
```
  - DefaultShader
```
public DefaultShader(Renderable renderable,
             DefaultShader.Config config)
```
  - DefaultShader
```
public DefaultShader(Renderable renderable,
             DefaultShader.Config config,
             String prefix)
```
  - DefaultShader
```
public DefaultShader(Renderable renderable,
             DefaultShader.Config config,
             String prefix,
             String vertexShader,
             String fragmentShader)
```
  - DefaultShader
```
public DefaultShader(Renderable renderable,
             DefaultShader.Config config,
             ShaderProgram shaderProgram)
```
- Method Detail
  - getDefaultVertexShader
```
public static String getDefaultVertexShader()
```
  - getDefaultFragmentShader
```
public static 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 String createPrefix(Renderable renderable,
                  DefaultShader.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(Object obj)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(DefaultShader 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.mesh, 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
  - 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)
```

Class DefaultShader

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

defaultCullFace

defaultDepthFunc

u_projTrans

u_viewTrans

u_projViewTrans

u_cameraPosition

u_cameraDirection

u_cameraUp

u_time

u_worldTrans

u_viewWorldTrans

u_projViewWorldTrans

u_normalMatrix

u_bones

u_shininess

u_opacity

u_diffuseColor

u_diffuseTexture

u_diffuseUVTransform

u_specularColor

u_specularTexture

u_specularUVTransform

u_emissiveColor

u_emissiveTexture

u_emissiveUVTransform

u_reflectionColor

u_reflectionTexture

u_reflectionUVTransform

u_normalTexture

u_normalUVTransform

u_ambientTexture

u_ambientUVTransform

u_alphaTest

Constructor Detail

DefaultShader

DefaultShader

DefaultShader

DefaultShader

DefaultShader

Method Detail

getDefaultVertexShader

getDefaultFragmentShader

init

createPrefix

canRender

compareTo

equals

equals

begin

render

end

dispose

getDefaultCullFace

setDefaultCullFace

getDefaultDepthFunc

setDefaultDepthFunc