Package com.jme3.renderer.opengl

Class ComputeShader

java.lang.Object

com.jme3.util.NativeObject

com.jme3.renderer.opengl.ComputeShader

All Implemented Interfaces:

Cloneable

public class ComputeShader
extends NativeObject

A compute shader for general-purpose GPU computing (GPGPU).

Compute shaders require OpenGL 4.3 or higher.

Field Summary

Fields inherited from class com.jme3.util.NativeObject

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

Constructor Summary

Constructors

Constructor	Description
ComputeShader(GL4 gl, String source)	Creates a new compute shader from GLSL source code.

Method Summary

Modifier and Type	Method	Description
void	bindShaderStorageBuffer(int location, ShaderStorageBufferObject ssbo)
NativeObject	createDestructableClone()	Creates a shallow clone of this GL Object.
void	deleteObject(Object rendererObject)	Deletes the GL object from the GPU when it is no longer used.
void	dispatch(int numGroupsX, int numGroupsY, int numGroupsZ)	Dispatches the compute shader with the specified number of work groups.
int	getUniformLocation(String name)
long	getUniqueId()	Returns a unique ID for this NativeObject.
void	makeActive()	Activates this compute shader for use.
void	resetObject()	Called when the GL context is restarted to reset all IDs.
void	setUniform(int location, float value)
void	setUniform(int location, int value)
void	setUniform(int location, Matrix4f value)
void	setUniform(int location, Vector2f value)
void	setUniform(int location, Vector3f value)
void	setUniform(int location, Vector4f value)

Methods inherited from class com.jme3.util.NativeObject

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

Methods inherited from class java.lang.Object

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

Constructor Details

ComputeShader

public ComputeShader(GL4 gl,
 String source)

Creates a new compute shader from GLSL source code.

Method Details

makeActive

public void makeActive()

Activates this compute shader for use. Must be called before setting uniforms or dispatching.

dispatch

public void dispatch(int numGroupsX,
 int numGroupsY,
 int numGroupsZ)

Dispatches the compute shader with the specified number of work groups.

setUniform

public void setUniform(int location,
 int value)

setUniform

public void setUniform(int location,
 float value)

setUniform

public void setUniform(int location,
 Vector2f value)

setUniform

public void setUniform(int location,
 Vector3f value)

setUniform

public void setUniform(int location,
 Vector4f value)

setUniform

public void setUniform(int location,
 Matrix4f value)

getUniformLocation

public int getUniformLocation(String name)

bindShaderStorageBuffer

public void bindShaderStorageBuffer(int location,
 ShaderStorageBufferObject ssbo)

resetObject

public void resetObject()

Description copied from class: NativeObject

Called when the GL context is restarted to reset all IDs. Prevents "white textures" on display restart.

Specified by:

resetObject in class NativeObject

deleteObject

public void deleteObject(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.