jit.gl.cubemap Reference

Manage a cubemap texture target

jit.gl.cubemap

Description

Maintains a cubemap texture target in an OpenGL context. It has 6 inputs -- one for each face of the cube. Cubemaps are typically used to map an environment for material effects such as reflection and refraction. When sent a texture to any inlet, jit.gl.cubemap adapts to the input type of the texture.

Examples

Discussion

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

Arguments

None.

Attributes

adapt [int]

Enable adapt to input (default = 1). When enabled the texture output dimensions will match the input dimensions.

autotype [symbol]

g/s(get)

Autotype

bordercolor [4 floats]

Sets the texture bordercolor

edge_length [int]

The length in pixels of a cube edge. Each face of the sube will be edge_length*edge_length in dimension.

file [symbol]

Sets an image file to read that is in panorama format

filter [symbol]

Filter applied to the texture.

level [int]

Specify mipmap level to write input data (default = 0). When level is non-zero inputs will overwrite the mipmap image at the specified mipmap level, where 1 is the largest resolution/nearest level. If necessary the data will be scaled for the appropriate level. The height and width of each level in the mipmap is a factor of two smaller than the previous level.

matrix_name [6 symbols]

g/s(get)

The named matrix to access (default = none)

mipmap [symbol]

Texture mipmap interpolation style (default = none). A mipmap is a pre-calculated sequence of images, each of which is a progressively lower resolution. Mipmap interpolation is used for minification filtering, a technique for increasing efficiency by changing the amount of texture information displayed based on the position of the textured object in a 3D scene. When the area of the fragment in texture space is larger than a texel, a filtered (reduced size) copy of the texture is used instead. Thus objects that are close can use the highest resolution image, then swap for lower resolution copies as the object gets farther away. Setting mipmap to bilinear (better performance) or trilinear (better image quality) will enable automatic mipmap generation whenever the texture is updated.

Possible values:

'none'
'nearest'
'linear'
'bilinear'
'trilinear'

type [symbol]

Force incoming textures to a particular type. If set to auto, jit.gl.cubemap will adapt to the incoming type, otherwise they will be forced to the type specified.

Possible values:

'auto'
'char'
'float16'
'float32'

wrap [3 symbols]

Texture wrapping mode.

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

anim [symbol]

The name of a jit.anim.node object that handles all spatial transforms for this instance (default = UID). The default value references an internal object, but can be overridden by setting to the name of an existing external jit.anim.node instance. This allows for more advanced control of the spatial transform.

anchor [3 floats]

The anchor position in local space (default = 0. 0. 0.). Allows for offsetting the local 3D origin around which transforms are applied.

animmode [symbol]

Determines which space the anim_move and anim_turn messages will affect the position and orientation of this object (default = parent).
local = Rotate relative to local axis
parent = Rotate relative to parent axis
world = Rotate relative to world axis

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

axes [int]

x/y/z axis rendering off/on (default = 0)

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.

filterclass [symbol]

The name of this object's pick filter class (default = default). This controls the visibility of objects to the jit.gl.handle and jit.gl.picker objects. In order to select this object, the filterclass value must be in the picking object's filters list.

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)

position [3 floats]

The 3D origin in the form x y z (default = 0. 0. 0.)

shader [symbol]

The name of the shader to be applied (default = none)

Messages

(drag)

TEXT_HERE

bind

Sets binding of the cubemap to texture geometry.

panorama_matrix

Load a matrix formatted in a cross shape containing every face of the cubemap. The panorama matrix layout is a cross shape holding the 6 faces of the cube. The faces are in a 4x3 grid where the rows are formatted as follows:
  1. ** py ** **
  2. nx pz px nz
  3. ** ny ** **

read

Read in a panorama formatted image file.

unbind

Unbinds the cubemap after a bind operation.

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

anim_move

Arguments

x [float]
y [float]
z [float]
Move the object along the axis provided, relative to the space indicated by animmode.

anim_turn

Arguments

x [float]
y [float]
z [float]
Rotate the object along each axis by the amount provided, relative to the space indicated by animmode.

anim_grow

Arguments

x [float]
y [float]
z [float]
Scale the object along each axis by the amount provided.

anim_reset

Reset the local transformation attributes to their default values (position = 0 0 0, rotatexyz = 0 0 0, and scale = 1 1 1)

update_node

Update the node transformation attributes.

jit_gl_texture

Arguments

texture-name [symbol]
Binds the texture specified by texture-name to this object. Equivalent to setting the texture attribute to texture-name .

See Also

Name Description
Working with OpenGL Working with OpenGL