org.jsfml.graphics

Class Shader

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.graphics.Shader

All Implemented Interfaces:

ConstShader, Const

public class Shader
extends SFMLNativeObject
implements ConstShader

Represents a GLSL shader program, consisting of a vertex and a fragment shader.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shader.CurrentTextureType Special type denoting that the texture of the object being drawn should be used, which cannot be known before it is actually being drawn.
static class	Shader.Type Enumeration of shader types.

Field Summary

Fields

Modifier and Type	Field and Description
static Shader.CurrentTextureType	CURRENT_TEXTURE Special value denoting that the texture of the object being drawn should be used, which cannot be known before it is actually being drawn.

Constructor Summary

Constructors

Constructor and Description
Shader() Constructs a new shader.

Method Summary

Methods

Modifier and Type	Method and Description
static void	bind(ConstShader shader) Activates a shader for rendering.
static boolean	isAvailable() Checks if shaders are available on this system.
void	loadFromFile(Path vertexShaderFile, Path fragmentShaderFile) Attempts to load the shader from files.
void	loadFromFile(Path path, Shader.Type shaderType) Attempts to load the shader from a file.
void	loadFromSource(String source, Shader.Type shaderType) Attempts to load a shader from GLSL source code.
void	loadFromSource(String vertexShaderSource, String fragmentShaderSource) Attempts to load a shader from GLSL source code.
void	loadFromStream(InputStream vertexShaderIn, InputStream fragmentShaderIn) Fully loads all available bytes from an InputStream and attempts to load the shader from it.
void	loadFromStream(InputStream in, Shader.Type shaderType) Fully loads all available bytes from an InputStream and attempts to load the shader from it.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
void	setParameter(String name, Color color) Sets a color (vec4) parameter value in the shader.
void	setParameter(String name, ConstTexture texture) Sets a texture (sampler2D) parameter value in the shader.
void	setParameter(String name, float value) Sets a float parameter (float) value in the shader.
void	setParameter(String name, float x, float y) Sets a 2-component-float (vec2) parameter value in the shader.
void	setParameter(String name, float x, float y, float z) Sets a 3-component-float (vec3) parameter value in the shader.
void	setParameter(String name, float x, float y, float z, float w) Sets a 4-component-float (vec4) parameter value in the shader.
void	setParameter(String name, Shader.CurrentTextureType currentTexture) Sets a texture (sampler2D) parameter value in the shader to the texture of the object being drawn in the moment the shader is applied.
void	setParameter(String name, Transform xform) Sets a matrix (mat4) parameter value in the shader.
void	setParameter(String name, Vector2f v) Sets a 2-component-float (vec2) parameter value in the shader.
void	setParameter(String name, Vector3f v) Sets a 3-component-float (vec3) parameter value in the shader.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_TEXTURE

public static final Shader.CurrentTextureType CURRENT_TEXTURE

Special value denoting that the texture of the object being drawn should be used, which cannot be known before it is actually being drawn.

See Also:

setParameter(String, org.jsfml.graphics.Shader.CurrentTextureType)

Constructor Detail

Shader

public Shader()

Constructs a new shader.

Method Detail

bind

public static void bind(ConstShader shader)

Activates a shader for rendering.

This is required only if you wish to use JSFML shaders in custom OpenGL code.

Parameters:

shader - the shader to activate, or null to indicate that no shader is to be used.

isAvailable

public static boolean isAvailable()

Checks if shaders are available on this system.

Returns:

true if shaders are available, false otherwise.

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

loadFromSource

public void loadFromSource(String source,
                  Shader.Type shaderType)
                    throws IOException,
                           ShaderSourceException

Attempts to load a shader from GLSL source code.

Parameters:

source - the GLSL source code.

shaderType - the shader type.

Throws:

IOException - in case an I/O error occurs.

ShaderSourceException - in case the shader could not be compiled or linked.

loadFromSource

public void loadFromSource(String vertexShaderSource,
                  String fragmentShaderSource)
                    throws IOException,
                           ShaderSourceException

Attempts to load a shader from GLSL source code.

Parameters:

vertexShaderSource - the vertex shader's GLSL source code.

fragmentShaderSource - the fragment shader's GLSL source code.

Throws:

IOException - in case an I/O error occurs.

ShaderSourceException - in case the shader could not be compiled or linked.

loadFromStream

public void loadFromStream(InputStream in,
                  Shader.Type shaderType)
                    throws IOException,
                           ShaderSourceException

Fully loads all available bytes from an InputStream and attempts to load the shader from it.

Parameters:

in - the input stream to read from.

shaderType - the shader type.

Throws:

IOException - in case an I/O error occurs.

ShaderSourceException - in case the shader could not be compiled or linked.

loadFromStream

public void loadFromStream(InputStream vertexShaderIn,
                  InputStream fragmentShaderIn)
                    throws IOException,
                           ShaderSourceException

Fully loads all available bytes from an InputStream and attempts to load the shader from it.

Parameters:

vertexShaderIn - the input stream to read the vertex shader from.

fragmentShaderIn - the input stream to read the fragment shader from.

Throws:

IOException - in case an I/O error occurs.

ShaderSourceException - in case the shader could not be compiled or linked.

loadFromFile

public void loadFromFile(Path path,
                Shader.Type shaderType)
                  throws IOException,
                         ShaderSourceException

Attempts to load the shader from a file.

Parameters:

path - the path to the file to load.

shaderType - the shader type.

Throws:

IOException - in case an I/O error occurs.

ShaderSourceException - in case the shader could not be compiled or linked.

loadFromFile

public void loadFromFile(Path vertexShaderFile,
                Path fragmentShaderFile)
                  throws IOException,
                         ShaderSourceException

Attempts to load the shader from files.

Parameters:

vertexShaderFile - the path to the file to read the vertex shader from.

fragmentShaderFile - the path to the file to read the fragment shader from.

Throws:

IOException - in case an I/O error occurs.

ShaderSourceException - in case the shader could not be compiled or linked.

setParameter

public void setParameter(String name,
                float value)

Sets a float parameter (float) value in the shader.

Parameters:

name - the parameter's name.

value - the parameter's value.

setParameter

public void setParameter(String name,
                float x,
                float y)

Sets a 2-component-float (vec2) parameter value in the shader.

Parameters:

name - the parameter's name.

x - the parameter's value.

y - the parameter's value.

setParameter

public void setParameter(String name,
                Vector2f v)

Sets a 2-component-float (vec2) parameter value in the shader.

Parameters:

name - the parameter's name.

v - the parameter's value.

setParameter

public void setParameter(String name,
                float x,
                float y,
                float z)

Sets a 3-component-float (vec3) parameter value in the shader.

Parameters:

name - the parameter's name.

x - the parameter's value.

y - the parameter's value.

z - the parameter's value.

setParameter

public void setParameter(String name,
                Vector3f v)

Sets a 3-component-float (vec3) parameter value in the shader.

Parameters:

name - the parameter's name.

v - the parameter's value.

setParameter

public void setParameter(String name,
                float x,
                float y,
                float z,
                float w)

Sets a 4-component-float (vec4) parameter value in the shader.

Parameters:

name - the parameter's name.

x - the parameter's value.

y - the parameter's value.

z - the parameter's value.

w - the parameter's value.

setParameter

public void setParameter(String name,
                Color color)

Sets a color (vec4) parameter value in the shader.

Parameters:

name - the parameter's name.

color - the parameter's value.

setParameter

public void setParameter(String name,
                Transform xform)

Sets a matrix (mat4) parameter value in the shader.

Parameters:

name - the parameter's name.

xform - the parameter's value.

setParameter

public void setParameter(String name,
                ConstTexture texture)

Sets a texture (sampler2D) parameter value in the shader.

Parameters:

name - the parameter's name.

texture - the parameter's value.

setParameter

public void setParameter(String name,
                Shader.CurrentTextureType currentTexture)

Sets a texture (sampler2D) parameter value in the shader to the texture of the object being drawn in the moment the shader is applied.

Since that texture cannot be known before the object is actually being drawn, this overload can be used to tell the shader to use it when applied.

Parameters:

name - the parameter's name.

currentTexture - should be CURRENT_TEXTURE.