com.jme3.shader

Class Shader

java.lang.Object

com.jme3.util.NativeObject

com.jme3.shader.Shader

All Implemented Interfaces:

java.lang.Cloneable

public final class Shader
extends NativeObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shader.ShaderSource Shader source describes a shader object in OpenGL.
static class	Shader.ShaderType Type of shader.

Field Summary

Fields inherited from class com.jme3.util.NativeObject

handleRef, id, INVALID_ID, objectManager, OBJTYPE_AUDIOBUFFER, OBJTYPE_AUDIOSTREAM, OBJTYPE_BO, OBJTYPE_FILTER, OBJTYPE_FRAMEBUFFER, OBJTYPE_SHADER, OBJTYPE_SHADERSOURCE, OBJTYPE_TEXTURE, OBJTYPE_VERTEXBUFFER, updateNeeded

Constructor Summary

Constructors

Modifier	Constructor and Description
	Shader() Creates a new shader, initialize() must be called after this constructor for the shader to be usable.
protected	Shader(Shader s) Do not use this constructor.

Method Summary

Modifier and Type	Method and Description
void	addSource(Shader.ShaderType type, java.lang.String name, java.lang.String source, java.lang.String defines, java.lang.String language) Adds source code to a certain pipeline.
void	addUniformBinding(UniformBinding binding)
void	clearUniformsSetByCurrentFlag() Removes the "set-by-current-material" flag from all uniforms.
NativeObject	createDestructableClone() Creates a shallow clone of this GL Object.
void	deleteObject(java.lang.Object rendererObject) Deletes the GL object from the GPU when it is no longer used.
Attribute	getAttribute(VertexBuffer.Type attribType)
java.util.ArrayList<Uniform>	getBoundUniforms()
ShaderBufferBlock	getBufferBlock(java.lang.String name) Gets or creates a buffer block by the name.
ListMap<java.lang.String,ShaderBufferBlock>	getBufferBlockMap() Get the buffer blocks map.
java.util.Collection<Shader.ShaderSource>	getSources()
Uniform	getUniform(java.lang.String name)
ListMap<java.lang.String,Uniform>	getUniformMap()
long	getUniqueId() Returns a unique ID for this NativeObject.
void	removeBufferBlock(java.lang.String name) Removes a buffer block by the name.
void	removeUniform(java.lang.String name)
void	resetLocations() Usually called when the shader itself changes or during any time when the variable locations need to be refreshed.
void	resetObject() Called by the object manager to reset all object IDs.
void	resetUniformsNotSetByCurrent() Resets all uniforms that do not have the "set-by-current-material" flag to their default value (usually all zeroes or false).
void	setUpdateNeeded() Internal use only.
java.lang.String	toString()

Methods inherited from class com.jme3.util.NativeObject

clearUpdateNeeded, clone, deleteNativeBuffers, dispose, getId, getWeakRef, isUpdateNeeded, setId

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Shader

public Shader()

Creates a new shader, initialize() must be called after this constructor for the shader to be usable.

Shader

protected Shader(Shader s)

Do not use this constructor. Used for destructible clones only.

Parameters:

s - (not null)

Method Detail

addSource

public void addSource(Shader.ShaderType type,
                      java.lang.String name,
                      java.lang.String source,
                      java.lang.String defines,
                      java.lang.String language)

Adds source code to a certain pipeline.

Parameters:

type - The pipeline to control

name - a name for the new shader object

source - The shader source code (in GLSL).

defines - Preprocessor defines (placed at the beginning of the shader)

language - The shader source language, currently accepted is GLSL### where ### is the version, e.g. GLSL100 = GLSL 1.0, GLSL330 = GLSL 3.3, etc.

addUniformBinding

public void addUniformBinding(UniformBinding binding)

getUniform

public Uniform getUniform(java.lang.String name)

getBufferBlock

public ShaderBufferBlock getBufferBlock(java.lang.String name)

Gets or creates a buffer block by the name.

Parameters:

name - the buffer block's name.

Returns:

the buffer block.

removeUniform

public void removeUniform(java.lang.String name)

removeBufferBlock

public void removeBufferBlock(java.lang.String name)

Removes a buffer block by the name.

Parameters:

name - the buffer block's name.

getAttribute

public Attribute getAttribute(VertexBuffer.Type attribType)

getUniformMap

public ListMap<java.lang.String,Uniform> getUniformMap()

getBufferBlockMap

public ListMap<java.lang.String,ShaderBufferBlock> getBufferBlockMap()

Get the buffer blocks map.

Returns:

the buffer blocks map.

getBoundUniforms

public java.util.ArrayList<Uniform> getBoundUniforms()

getSources

public java.util.Collection<Shader.ShaderSource> getSources()

toString

public java.lang.String toString()

Overrides:

toString in class NativeObject

clearUniformsSetByCurrentFlag

public void clearUniformsSetByCurrentFlag()

Removes the "set-by-current-material" flag from all uniforms. When a uniform is modified after this call, the flag shall become "set-by-current-material". A call to resetUniformsNotSetByCurrent() will reset all uniforms that do not have the "set-by-current-material" flag to their default value (usually all zeroes or false).

resetUniformsNotSetByCurrent

public void resetUniformsNotSetByCurrent()

Resets all uniforms that do not have the "set-by-current-material" flag to their default value (usually all zeroes or false). When a uniform is modified, that flag is set, to remove the flag, use clearUniformsSetByCurrentFlag().

resetLocations

public void resetLocations()

Usually called when the shader itself changes or during any time when the variable locations need to be refreshed.

setUpdateNeeded

public void setUpdateNeeded()

Description copied from class: NativeObject

Internal use only. Indicates that the object has changed and its state needs to be updated.

Overrides:

setUpdateNeeded in class NativeObject

resetObject

public void resetObject()

Called by the object manager to reset all object IDs. This causes the shader to be reuploaded to the GPU in case the display was restarted.

Specified by:

resetObject in class NativeObject

deleteObject

public void deleteObject(java.lang.Object rendererObject)

Description copied from class: NativeObject

Deletes the GL object from the GPU when it is no longer used. Called automatically by the GL object manager.

Specified by:

deleteObject in class NativeObject

Parameters:

rendererObject - The renderer to be used to delete the object

createDestructableClone

public NativeObject createDestructableClone()

Description copied from class: NativeObject

Creates a shallow clone of this GL Object. The deleteObject method should be functional for this object.

Specified by:

createDestructableClone in class NativeObject

Returns:

a new instance

getUniqueId

public long getUniqueId()

Description copied from class: NativeObject

Returns a unique ID for this NativeObject. No other NativeObject shall have the same ID.

Specified by:

getUniqueId in class NativeObject

Returns:

unique ID for this NativeObject.