com.mousebird.maply

Class Shader

java.lang.Object

com.mousebird.maply.Shader

public class Shader
extends java.lang.Object

The shader is a direct interface to OpenGL ES 2.0 shader language.

You can set your own shader programs in the toolkit! Yeah, that's as complex as it sounds. The underyling toolkit makes a distinction between the name of the shader and the scene name. The scene name is used as a way to replace the default shaders we use for triangles and lines. This would let you replace the shaders you're already using with your own. See the addShaderProgram:sceneName: method in the MaplyBaseViewController. You can also add your own shader and hook it up to any features that can call out a specific shader, such as the MaplyQuadImageTilesLayer. When writing a new shader, go take a look at DefaultShaderPrograms.mm, particularly the vertexShaderTri and fragmentShaderTri. The documentation here is for the uniforms and attributes the system is going to hook up for you. All of these are optional, but obviously nothing much will happen if you don't use the vertices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shader.AttributeType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BillboardEyeShader
static java.lang.String	BillboardGroundShader
static java.lang.String	DefaultLineShader
static java.lang.String	DefaultMarkerShader
static java.lang.String	DefaultModelTriShader
static java.lang.String	DefaultScreenSpaceMotionShader
static java.lang.String	DefaultScreenSpaceShader
static java.lang.String	DefaultTriangleShader
static java.lang.String	DefaultTriMultiTexRampShader
static java.lang.String	DefaultTriMultiTexShader
static java.lang.String	DefaultTriNightDayShader
static java.lang.String	DefaultTriScreenTexShader
static java.lang.String	DefaultWideVectorGlobeShader
static java.lang.String	DefaultWideVectorShader
static java.lang.String	NoBackfaceLineShader
static java.lang.String	NoLightTriangleShader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Shader()
	Shader(RenderControllerInterface inControl) Initialise with an empty program we'll fill in later.
	Shader(java.lang.String name, java.lang.String vertexSrc, java.lang.String fragSrc, RenderControllerInterface inControl) Initialize with the file names for the shader program.

Method Summary

Modifier and Type	Method and Description
void	addTexture(java.lang.String name, MaplyTexture texture) Add a texture for use in the shader.
void	addVarying(java.lang.String name) Varyings will be passed from one shader to another using transform feedback.
void	delayedSetup(java.lang.String name, java.lang.String vertexSrc, java.lang.String fragSrc) This is called after an a minimal setup.
void	finalize()
long	getID() Returns the internal Maply ID for the shader.
java.lang.String	getName() Returns the shader's name.
boolean	setUniform(java.lang.String name, double uni) Set a float uniform in the shader with the given name.
boolean	setUniform(java.lang.String name, int uni) Set an int uniform in the shader with the given name.
boolean	setUniform(java.lang.String name, Point2d pt) Set a pair of doubles in the shader with the given name.
boolean	setUniform(java.lang.String name, Point3d pt) Set a pair of doubles in the shader with the given name.
boolean	setUniform(java.lang.String name, Point4d pt) Set a pair of doubles in the shader with the given name.
boolean	setUniformByIndex(java.lang.String name, double uni, int index) Set a float uniform in the shader with a given name at the given index.
boolean	setUniformByIndexNative(java.lang.String name, double uni, int index)
boolean	setUniformColor(java.lang.String name, int color) Set the 4 component color value for a uniform.
boolean	setUniformColorByIndex(java.lang.String name, int color, int index) Set the 4 component color value for a uniform with the given index (e.g.
boolean	setUniformNative(java.lang.String name, double uni)
boolean	setUniformNative(java.lang.String name, int uni)
boolean	valid() Check if the shader is valid.

Methods inherited from class java.lang.Object

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

Field Detail

DefaultTriangleShader

public static final java.lang.String DefaultTriangleShader

See Also:

Constant Field Values

NoLightTriangleShader

public static final java.lang.String NoLightTriangleShader

See Also:

Constant Field Values

DefaultLineShader

public static final java.lang.String DefaultLineShader

See Also:

Constant Field Values

NoBackfaceLineShader

public static final java.lang.String NoBackfaceLineShader

See Also:

Constant Field Values

DefaultModelTriShader

public static final java.lang.String DefaultModelTriShader

See Also:

Constant Field Values

DefaultTriScreenTexShader

public static final java.lang.String DefaultTriScreenTexShader

See Also:

Constant Field Values

DefaultTriMultiTexShader

public static final java.lang.String DefaultTriMultiTexShader

See Also:

Constant Field Values

DefaultTriMultiTexRampShader

public static final java.lang.String DefaultTriMultiTexRampShader

See Also:

Constant Field Values

DefaultMarkerShader

public static final java.lang.String DefaultMarkerShader

See Also:

Constant Field Values

DefaultTriNightDayShader

public static final java.lang.String DefaultTriNightDayShader

See Also:

Constant Field Values

BillboardGroundShader

public static final java.lang.String BillboardGroundShader

See Also:

Constant Field Values

BillboardEyeShader

public static final java.lang.String BillboardEyeShader

See Also:

Constant Field Values

DefaultWideVectorShader

public static final java.lang.String DefaultWideVectorShader

See Also:

Constant Field Values

DefaultWideVectorGlobeShader

public static final java.lang.String DefaultWideVectorGlobeShader

See Also:

Constant Field Values

DefaultScreenSpaceMotionShader

public static final java.lang.String DefaultScreenSpaceMotionShader

See Also:

Constant Field Values

DefaultScreenSpaceShader

public static final java.lang.String DefaultScreenSpaceShader

See Also:

Constant Field Values

Constructor Detail

Shader

public Shader(java.lang.String name,
              java.lang.String vertexSrc,
              java.lang.String fragSrc,
              RenderControllerInterface inControl)

Initialize with the file names for the shader program.

See initWithName:vertex:fragment:viewC: for more details on how this works.

Parameters:

name - The name of the shader program. Used for identification and sometimes lookup.

vertexSrc - The string containing the full vertex program.

fragSrc - The string containing the full fragment program.

inControl - The controller where we'll register the new shader.

Shader

public Shader(RenderControllerInterface inControl)

Initialise with an empty program we'll fill in later.

Parameters:

inControl - The control we'll associate this program with.

Shader

protected Shader()

Method Detail

delayedSetup

public void delayedSetup(java.lang.String name,
                         java.lang.String vertexSrc,
                         java.lang.String fragSrc)

This is called after an a minimal setup. Presumably you'll be setting other attributes (like varying names) which must be passed in when the program is created.

Parameters:

name - The name of the shader program. Used for identification and sometimes lookup.

vertexSrc - The string containing the full vertex program.

fragSrc - The string containing the full fragment program.

valid

public boolean valid()

Check if the shader is valid.

The shader setup can fail in a number of ways. Check this after creating the shader to see if it succeeded. If not, look to getError to see why.

getName

public java.lang.String getName()

Returns the shader's name.

addTexture

public void addTexture(java.lang.String name,
                       MaplyTexture texture)

Add a texture for use in the shader.

Parameters:

name - Name to be used in the shader.

texture - Texture to pass into the shader.

setUniform

public boolean setUniform(java.lang.String name,
                          double uni)

Set a float uniform in the shader with the given name.

Returns:

Returns true if there was such a uniform, false otherwise.

setUniformByIndex

public boolean setUniformByIndex(java.lang.String name,
                                 double uni,
                                 int index)

Set a float uniform in the shader with a given name at the given index. Specifically for arrays.

setUniformNative

public boolean setUniformNative(java.lang.String name,
                                double uni)

setUniformByIndexNative

public boolean setUniformByIndexNative(java.lang.String name,
                                       double uni,
                                       int index)

setUniform

public boolean setUniform(java.lang.String name,
                          int uni)

Set an int uniform in the shader with the given name.

Returns:

Returns true if there was such a uniform, false otherwise.

setUniformNative

public boolean setUniformNative(java.lang.String name,
                                int uni)

setUniform

public boolean setUniform(java.lang.String name,
                          Point2d pt)

Set a pair of doubles in the shader with the given name.

Parameters:

pt - Point to set the uniform to.

Returns:

Returns true if there was such a uniform, false otherwise.

setUniform

public boolean setUniform(java.lang.String name,
                          Point3d pt)

Set a pair of doubles in the shader with the given name.

Parameters:

pt - Point to set the uniform to.

Returns:

Returns true if there was such a uniform, false otherwise.

setUniform

public boolean setUniform(java.lang.String name,
                          Point4d pt)

Set a pair of doubles in the shader with the given name.

Parameters:

pt - Point to set the uniform to.

Returns:

Returns true if there was such a uniform, false otherwise.

setUniformColorByIndex

public boolean setUniformColorByIndex(java.lang.String name,
                                      int color,
                                      int index)

Set the 4 component color value for a uniform with the given index (e.g. it's an array)

setUniformColor

public boolean setUniformColor(java.lang.String name,
                               int color)

Set the 4 component color value for a uniform.

addVarying

public void addVarying(java.lang.String name)

Varyings will be passed from one shader to another using transform feedback. It's weird and it's annoying and it has to be done at Shader setup.

Parameters:

name - Name of the output of the vertex stage to turn into a varying.

getID

public long getID()

Returns the internal Maply ID for the shader.

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object