jit.gl.bfg
Description
Generates OpenGL texture output from a library of procedural basis functions. The functions are processed on the graphics card as OpenGL GLSL shaders. The three categories of functions include noise, fractal and distorted.
Attributes
adapt [int] (default: 1)
Enable adapt to input (default = 1). When enabled the texture output dimensions will match the input dimensions.
basis [symbol]
The name of the basis function to use for the evaluation. (default = noise.perlin)
Possible values:
'noise.perlin'
(
Classic Perlin noise, periodic variant
)
'noise.simplex'
(
Simplex weighted pseudo-random values
)
'noise.cell'
(
Coherent blocky noise
)
'noise.checker'
(
Periodic checker squares
)
'fractal.multi.rigid'
(
Multiplicative fractal with sharp ridges
)
'fractal.multi.hybrid'
(
A hybrid additive and multiplicative fractal
)
'fractal.fbm'
(
Fractal Brownian motion
)
'fractal.multi'
(
Multiplicative fractal with varying simularity across scales
)
'fractal.hetero'
(
Heterogenous multiplicative fractal
)
'noise.voronoi'
(
Distance weighted pseudo-random feature points
)
'noise.voronoi.crackle'
(
Variation of Voronoi
)
'noise.voronoi.smooth'
(
Variation of Voronoi with distance filtering
)
'noise.voronoise'
(
Generalized Voronoi and Noise
)
'noise.voronoi.id'
(
Voronoi variation with cells colorized by ID
)
'distorted'
(
Domain distorted combinational noise
)
'distorted.2axis'
(
Distortion along 2 axes
)
'input.distorted'
(
Distortion of input texture
)
'input.distorted.2axis'
(
Distortion of input texture along 2 axes
)
basis.inner [symbol]
Set the innter basis function when basis is a distorted type function (default = noise.perlin).
Possible values:
'noise.perlin'
'noise.simplex'
'noise.cell'
'noise.checker'
'fractal.multi.rigid'
'fractal.multi.hybrid'
'fractal.fbm'
'fractal.multi'
'fractal.hetero'
'noise.voronoi'
'noise.voronoi.crackle'
'noise.voronoi.smooth'
'noise.voronoise'
'noise.voronoi.id'
basis.outer [symbol]
Set the outer basis function when basis is a distorted type function (default = noise.simplex).
Possible values:
'noise.perlin'
'noise.simplex'
'noise.cell'
'noise.checker'
'fractal.multi.rigid'
'fractal.multi.hybrid'
'fractal.fbm'
'fractal.multi'
'fractal.hetero'
'noise.voronoi'
'noise.voronoi.crackle'
'noise.voronoi.smooth'
'noise.voronoise'
'noise.voronoi.id'
colorize [int]
Colorize the output texture using a cosine function (default = 0). See the palette attribute for making adjustments to the colorization.
dim [2 ints]
The texture output dimensions when adapt is disabled (default = 256 256)
dimscale [2 floats]
The output dimension scaling factor of the output (default = 1 1). Useful for upsampling or downsampling texture output.
output.dim = input.dim*dimscale
distortion [float]
Adjust the amount of distortion for distorted type functions (default = 1).
fractal_params [4 floats]
Adjust parameters of fractal type functions. The parameters correspond to h, lacunarity, offset, and gain. Not all fracal functions respond to all parameters. Unused paramters are set to 0.
fractal.multi.rigid uses h, lacunarity, offset, gain
fractal.multi, fractal.hetero and fractal.multi.hybrid uses h, lacunarity, offset
fractal.fbm uses h, lacunarity
offset [2 floats]
The dimensional offsets to use for generating the spatial grid coordinates (default = 0 0).
out_name [32 symbols]
Output texture name
palette [3 floats]
Adjust the colorization effect when colorize is enabled (default = 0 1 2).
rect [4 floats]
Slab geometry rectangle (default = 0 0 1 1). The four values represent normalized coordinates for the left, bottom, right and top sides of the geometry rectangle. To flip the image horizontally use rect 1 0 0 1 or to flip vertically use rect 0 1 1 0 .
rectangle [int]
Enable texture rectangle mode on internal texture objects(default = 1). When enabled the internal GL texture is treated as a rectangular texture, and must be referenced using sampler2DRect and sampled using texture2DRect when sampled from a GLSL shader. When disabled the texture dimensions are upsampled to the nearest power of two value, and must be referenced and sampled using sampler2D and texture2D. Certain texture attributes and GLSL effects require rectangle mode disabled.
scale [2 floats]
The dimensional scale factors to use for generating the spatial grid coordinates (default = 1 1).
time [float]
Time animation parameter
type [symbol]
The output texture data type (default = auto). When type is auto the type is set by the input texture or matrix type.
Possible values:
'auto'
(
Adapt to input data type
)
'char'
(
8bit unsigned byte
)
'long'
(
32bit integer
)
'half'
(
16bit float
)
'float'
(
32bit float
)
'float16'
(
16bit float
)
'float32'
(
32bit float
)
voronoi_crackle [3 floats]
Voronoi crackle effect values (default = 8.0 2.0 0.5). Only used when basis is noise.voronoi.crackle
voronoi_jitter [float]
Voronoi jitter amount (default = 1). Only used when basis is a noise.voronoi type function.
voronoi_shade [float]
Simulate cell shading effect when basis is noise.voronoi.id (default = 0.5).
voronoi_smooth [float]
Adjust the smoothing factor when basis is noise.voronoi.smooth (default = 64).
voronoise_amt [float]
Adjust the mix between the Voronoi and noise functions when basis is noise.voronoise (default = 0).
zoom [float]
Adjust both the scale and offset values to simulate zooming in and out of the function center (default = 1).
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]
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]
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]
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
antialias [int]
Antialiasing flag (default = 0) On some hardware, the blend_enable attribute must also be enabled for antialiasing to work.
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
aux_color [4 floats]
The auxiliary color in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
blend [symbol]
The named blending mode. The possible values are:
add = blend_mode 1 1
multiply = blend_mode 2 1
screen = blend_mode 4 1
exclusion = blend_mode 4 5
colorblend = blend_mode 3 4
alphablend = blend_mode 6 7
coloradd = blend_mode 3 1
alphaadd = blend_mode 6 1
blend_enable [int]
Blending flag (default = 0) When the flag is set, blending is enabled for all rendered objects.
blend_mode [2 ints]
The source and destination planes associated with the blend mode (default = 6 7) Blend modes are specified in the form src_blend_mode dst_blend_mode. The supported modes are:
0 = zero
1 = one
2 = destination color
3 = source color
4 = one minus destination color
5 = one minus source color
6 = source alpha
7 = one minus source alpha
8 = destination alpha
9 = one minus destination alpha
10 = source alpha saturate
capture [symbol]
The name of a texture to be rendered to - e.g. jit.gl.nurbs @capture mytex will capture to jit.gl.texture @name mytex.
depth_clear [int]
Depth buffer clear flag (default = 0) When the flag is set, the depth buffer is cleared before rendering the object.
depth_enable [int]
Depth buffering flag (default = 1) When the flag is set, depth buffering is enabled.
depth_write [int]
Depth write flag (default = 1). When the flag is set, writing to the depth buffer is enabled. This will have no effect if depth_enable is turned off.
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)
smooth_shading [int]
Smooth shading flag (default = 0) When the flag is set, smooth shading is used when rendering.
tex_map [int]
Mode for automatic generation of texture coordinate controls (default = 0)
0 = no coordinates are generated.
1 = OpenGL's texture generation is used with mode GL_OBJECT_LINEAR. This applies the texture in a fixed orientation relative to the object.
2 = OpenGL's texture generation is used with mode GL_SPHERE_MAP. This can be used to create a reflection effect.
3 = OpenGL's texture generation is used with mode GL_EYE_LINEAR. This applies the texture in a fixed orientation relative to OpenGL's eye coordinates.
Modes 1 and 3 are affected by the value of the tex_plane_s and tex_plane_t attributes listed below.
tex_plane_s [4 floats]
The texture generation coefficients a b c d that apply to tex_map modes 1 and 3. (default = 1. 0. 0. 0.)
The four coefficients define a plane used to generate the s texture coordinate, which corresponds to the x axis of the texture image. If the tex_map mode is 1, s = ax + by + cz + dw, where x, y, z, and w are the homogeneous coordinates of the vertex.
tex_plane_t [4 floats]
The texture generation coefficients a b c d, which apply to tex_map modes 1 and 3. (default = 0. 1. 0. 0)
The four coefficients define a plane which is used to generate the t texture coordinate, which corresponds to the y axis of the texture image.
shader [symbol]
The name of the shader to be applied (default = none)
texture [8 symbols]
The name of the texture to be applied (default = none). If multiple textures are specified, uses multi-texturing.
Messages
full_source_code
getparamdefault
Arguments
getparamdescription
Arguments
getparamlist
getparamtype
Arguments
getparamval
Arguments
param
Arguments
message [symbol]
values [list]
sendinput
Arguments
message [symbol]
values [list]
sendoutput
Arguments
values [list]
sendshader
Arguments
values [list]
OB3D Messages
bang
draw
drawraw
drawimmediate
jit_gl_texture
Arguments
See Also
| Name | Description |
|---|---|
| jit.bfg | Evaluate a procedural basis function graph |
| jit.gl.pix | Generates pixel processing shaders from a gen patcher |
| jit.gl.shader | Manage a GL shader |
| jit.gl.slab | Process texture data |
| jit.gl.texture | Create OpenGL textures |
| Tutorial 42: Slab: Data Processing on the GPU | Tutorial 42: Slab: Data Processing on the GPU |
| Tutorial 50: Procedural Texturing & Modeling | Tutorial 50: Procedural Texturing & Modeling |