A newer version of Max is available. Click here to access the latest version of the documentation

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)

image_mipmaps [int]

Enable Image Mipmaps

verbose [int]

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

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

OB3D Attributes

automatic [int]

Automatic rendering flag (default = 1) When the flag is set, rendering occurs when the associated jit.gl.render object receives a bang message

drawto [symbol]

The named drawing context in which to draw (default = none) 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.

enable [int]

Enable flag (default = 1) When the flag is set, drawing is enabled.

layer [int]

Object layer number (default = 0) When in automatic mode, the layer number determines the rendering order (low to high). Objects in the same layer have no guarantee which will be rendered first.

name [symbol]

The instance name (default = UID)

Messages

(drag)

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

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.
TEXT_HERE

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

bang

Equivalent to the draw message.

draw

Draws the object in the named drawing destination. If the matrixoutput attribute is supported and set to 1, the geometry matrices are sent out the object's left outlet.

drawraw

Equivalent to draw with the inherit_all attribute set to 1.

drawimmediate

Equivalent to draw but ignoring any potential renderer setup

See Also

Name Description
Working with OpenGL Working with OpenGL
Video and Graphics Programming Tutorials Video and Graphics Programming Tutorials
jit.gl.mesh Generate GL geometry from matrices
jit.gl.pix Generates pixel processing shaders from a gen patcher
jit.gl.slab Process texture data
jit.gl.texture Create OpenGL textures
Tutorial 41: Shaders Tutorial 41: Shaders
Appendix C: The JXS File Format Appendix C: The JXS File Format
External Text Editor External Text Editor