jit.gl.buffer Reference

A buffer of mesh data on the GPU

jit.gl.buffer

Description

The jit.gl.buffer object is a named reference to a buffer of data stored on the GPU. The data is rendered via jit.gl.mesh, and jit.gl.tf is used to perform transform feedback effects.

Attributes

instance_div [int]

Divides the buffer by the value and applies the values across the total number of instances (default = 1). For example, could be used to create color groups in a large array of mesh instances. Requires instanced enabled.

instanced [int]

Enabling allows the buffer texture to pass different values to each drawn instance of a mesh when using jit.gl.mesh to perform hardware instancing (default = 0).

name [symbol]

g/s(get)

Used internally to manage texture buffers.

outname [symbol]

Required for use with jit.gl.tf, this name is used in the jit.gl.shader transform feedback shader code to process iterations of data on the buffer on the GPU. See the transform-feedback guide for more information.

texbuf [int]

When enabled, the buffer is bound as a texture buffer, allowing for texture-style lookups in the shader code (default = 0). It is important to note that any normal textures will be bound first, and then texture buffers.

type [symbol]

Sets the type of the buffer to bind to as a texture (position, normal, color, vertex_attr0, etc). When passed to a jit.gl.mesh (or through a jit.gl.tf, then to a jit.gl.mesh), it will bind the texture to the mesh object's corresponding internal buffer.
The following types are supported:

  • position
  • texcoord
  • normal
  • tangent
  • bitangent
  • vertex_attr
  • vertex_attr0
  • vertex_attr1
  • vertex_attr2
  • vertex_attr3

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.

Messages

bang

Outpus the currently stored buffer out the left outlet as the message jit_gl_buffer followed by the buffer name.

See Also

Name Description
GL3 Package Topics GL3 Package Topics
jit.gl.tf Manage transform feedback on geometric meshes
jit.gl.mesh Generate GL geometry from matrices
jit.gl.shader Manage a GL shader