jit.gl.shader Reference

Manage a GL shader

jit.gl.shader

Description

Manages the process of compiling, binding and submitting a shader to OpenGL. A shader consists of both a vertex program and a fragment (aka pixel) program, which can be defined in a xml shader description file (JXS), or submitted individually. Currently the high level language GLSL, as well as ARB, and NV assembly programs are supported.

Examples

Discussion

Shaders can be attached to any OB3D thru the OB3D shader method. If the shader is attached to an OB3D, the OB3D will automatically manage the compiling and binding for the jit.gl.shader object. The jit.gl.shader object requires one argument: the name of a drawing context. A named drawing context is a named instance of a jit.window, jit.pwindow, or jit.matrix object that has an instance of the jit.gl.render object associated with it. Additionally it can reference the name of a jit.gl.node sub-context. This value may also be set via the OB3D drawto attribute. If no argument is present, the object is implicitly added to the first valid drawing context or sub-context found in the current patch or by searching up the patcher hierarchy.

Attributes

file [symbol]

The shader description file (JXS) to use (default = none)

verbose [int]

Enables or disables verbose output to the max console window (default = 0).

Common Box Attributes

OB3D Attributes

Messages

(drag)

Dragging a JXS file from the Max File Browser or desktop to a jit.gl.shader object, will load the file.

arb

Arguments

vpfile [symbol]
fpfile [symbol]
Loads the given arb vertex and fragment programs from disk.

arbfp

Arguments

fpfile [symbol]
Loads the given arb fragment program from disk.

arbvp

Arguments

vpfile [symbol]
Loads the given arb vertex program from disk.

bind

Manually binds and compiles the shader object.

compile

Manually compiles the shader object.

(mouse)

Double click to open the shader editor. If no file is loaded the editor will load a starter shader to use as the basis for a new shader. This file must be saved to disk for use after the editor is closed.

dispose

Dispose of and unload the current shader.

dump

Arguments

type [symbol]
Dumps the indicated shader data to the max console window. Valid types are params, source, assembly.

flush_cache

Clears the shader cache which stores loaded programs that have been compiled in order to minimize compile time for shaders that have already been compiled and have not been modified on disk.

getparamdefault

Arguments

name [symbol]
Sends the default data values for the indicated shader parameter out the right-most outlet.

getparamdescription

Get a parameter description

getparamlist

Sends the names of all the shader parameters out the right-most outlet.

getparamtype

Arguments

name [symbol]
Sends the name of the datatype for the indicated shader parameter out the right-most outlet.

getparamval

Arguments

name [symbol]
Sends the data values for the indicated shader parameter out the right-most outlet.

glsl

Arguments

vpfile [symbol]
fpfile [symbol]
Loads the given glsl vertex and fragment programs from disk.

glslfp

Arguments

fpfile [symbol]
Loads the given glsl fragment program from disk.

glslvp

Arguments

vpfile [symbol]
Loads the given glsl vertex program from disk.

open

Opens the shader editor. If no file is loaded the editor will load a starter shader to use as the basis for a new shader. This file must be saved to disk for use after the editor is closed.

param

Sets the given shader parameter with the given atom values as defined in a JXS (Jitter shader) file.

program_param

A geometry shader program parameter.

read

Arguments

filename [symbol]
Loads the given JXS shader file from disk.

unbind

Manually unbinds the shader object.

OB3D Messages

See Also

Name Description
Working with OpenGL Working with OpenGL
Video and Graphics Programming Tutorials Video and Graphics Programming Tutorials
jit.gl.mesh
jit.gl.pix
jit.gl.slab
jit.gl.texture
Tutorial 41: Shaders Tutorial 41: Shaders
Appendix C: The JXS File Format Appendix C: The JXS File Format
External Text Editor External Text Editor