Max 5 API Reference

Matrix Module
[Jitter]

Collaboration diagram for Matrix Module:

Functions

void jit_linklist_free (t_jit_linklist *x)
 Frees instance of t_jit_linklist.
void * jit_matrix_new (t_jit_matrix_info *info)
 Constructs instance of t_jit_matrix.
void * jit_matrix_newcopy (t_jit_matrix *copyme)
 Constructs instance of t_jit_matrix, copying from input.
t_jit_err jit_matrix_free (t_jit_matrix *x)
 Frees instance of t_jit_matrix.
t_jit_err jit_matrix_setinfo (t_jit_matrix *x, t_jit_matrix_info *info)
 Sets all attributes according to the t_jit_matrix_info struct provided.
t_jit_err jit_matrix_setinfo_ex (t_jit_matrix *x, t_jit_matrix_info *info)
 Sets all attributes according to the t_jit_matrix_info struct provided (including data flags).
t_jit_err jit_matrix_getinfo (t_jit_matrix *x, t_jit_matrix_info *info)
 Retrieves all attributes, copying into the t_jit_matrix_info struct provided.
t_jit_err jit_matrix_getdata (t_jit_matrix *x, void **data)
 Retrieves matrix data pointer.
t_jit_err jit_matrix_data (t_jit_matrix *x, void *data)
 Sets matrix data pointer.
t_jit_err jit_matrix_freedata (t_jit_matrix *x)
 Frees matrix's internal data pointer if an internal reference and sets to NULL.
t_jit_err jit_matrix_info_default (t_jit_matrix_info *info)
 Initializes matrix info struct to default values.
t_jit_err jit_matrix_clear (t_jit_matrix *x)
 Sets all cells in matrix to the zero.
t_jit_err jit_matrix_setcell1d (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets cell at index to the value provided.
t_jit_err jit_matrix_setcell2d (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets cell at index to the value provided.
t_jit_err jit_matrix_setcell3d (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets cell at index to the value provided.
t_jit_err jit_matrix_setplane1d (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets plane of cell at index to the value provided.
t_jit_err jit_matrix_setplane2d (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets plane of cell at index to the value provided.
t_jit_err jit_matrix_setplane3d (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets plane of cell at index to the value provided.
t_jit_err jit_matrix_setcell (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets cell at index to the value provided.
t_jit_err jit_matrix_getcell (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv, long *rac, t_atom **rav)
 Gets cell at index to the value provided.
t_jit_err jit_matrix_setall (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Sets all cells to the value provided.
t_jit_err jit_matrix_togworld (t_jit_matrix *x, GWorldPtr gp, t_gworld_conv_info *gcinfo)
 Copies Jitter matrix data to GWorld data.
t_jit_err jit_matrix_fromgworld (t_jit_matrix *x, GWorldPtr gp, t_gworld_conv_info *gcinfo)
 Copies Jitter matrix data from GWorld data.
t_jit_err jit_matrix_frommatrix (t_jit_matrix *dst_matrix, t_jit_matrix *src_matrix, t_matrix_conv_info *mcinfo)
 Copies Jitter matrix data from another matrix.
t_jit_err jit_matrix_op (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Applies unary or binary operator to matrix See Jitter user documentation for more information.
t_jit_err jit_matrix_exprfill (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Fills cells according to the jit.expr expression provided.
t_jit_err jit_matrix_jit_gl_texture (t_jit_matrix *x, t_symbol *s, long argc, t_atom *argv)
 Copies texture information to matrix.

Function Documentation

void jit_linklist_free ( t_jit_linklist *  x  ) 

Frees instance of t_jit_linklist.

Parameters:
x t_jit_linklist object pointer
Returns:
t_jit_err error code
Warning:
Use jit_object_free instead.
t_jit_err jit_matrix_clear ( t_jit_matrix *  x  ) 

Sets all cells in matrix to the zero.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_data ( t_jit_matrix *  x,
void *  data 
)

Sets matrix data pointer.

Parameters:
x t_jit_matrix object pointer
data data pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_exprfill ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Fills cells according to the jit.expr expression provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_free ( t_jit_matrix *  x  ) 

Frees instance of t_jit_matrix.

Parameters:
x t_jit_matrix object pointer
Returns:
t_jit_err error code
Warning:
Use jit_object_free instead.
t_jit_err jit_matrix_freedata ( t_jit_matrix *  x  ) 

Frees matrix's internal data pointer if an internal reference and sets to NULL.

Parameters:
x t_jit_matrix object pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_fromgworld ( t_jit_matrix *  x,
GWorldPtr  gp,
t_gworld_conv_info *  gcinfo 
)

Copies Jitter matrix data from GWorld data.

Parameters:
x t_jit_matrix object pointer
gp gworld pointer
gcinfo conversion information pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_frommatrix ( t_jit_matrix *  dst_matrix,
t_jit_matrix *  src_matrix,
t_matrix_conv_info mcinfo 
)

Copies Jitter matrix data from another matrix.

Parameters:
dst_matrix destination t_jit_matrix object pointer
src_matrix destination t_jit_matrix object pointer
mcinfo conversion information pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_getcell ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv,
long *  rac,
t_atom **  rav 
)

Gets cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
rac return value atom count
rav return value atom vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_getdata ( t_jit_matrix *  x,
void **  data 
)

Retrieves matrix data pointer.

Parameters:
x t_jit_matrix object pointer
data pointer to data pointer (set to NULL if matrix is not available)
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_getinfo ( t_jit_matrix *  x,
t_jit_matrix_info info 
)

Retrieves all attributes, copying into the t_jit_matrix_info struct provided.

Parameters:
x t_jit_matrix object pointer
info t_jit_matrix_info pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_info_default ( t_jit_matrix_info info  ) 

Initializes matrix info struct to default values.

Parameters:
info t_jit_matrix_info struct pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_jit_gl_texture ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Copies texture information to matrix.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
void * jit_matrix_new ( t_jit_matrix_info info  ) 

Constructs instance of t_jit_matrix.

Parameters:
info t_jit_matrix_info struct pointer
Returns:
t_jit_matrix object pointer
Warning:
This function is not exported, but is provided for reference when calling via jit_object_new.
void * jit_matrix_newcopy ( t_jit_matrix *  copyme  ) 

Constructs instance of t_jit_matrix, copying from input.

Parameters:
copyme t_jit_matrix object pointer
Returns:
t_jit_matrix object pointer
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_op ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Applies unary or binary operator to matrix See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setall ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets all cells to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setcell ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setcell1d ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setcell2d ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setcell3d ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setinfo ( t_jit_matrix *  x,
t_jit_matrix_info info 
)

Sets all attributes according to the t_jit_matrix_info struct provided.

Parameters:
x t_jit_matrix object pointer
info t_jit_matrix_info pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setinfo_ex ( t_jit_matrix *  x,
t_jit_matrix_info info 
)

Sets all attributes according to the t_jit_matrix_info struct provided (including data flags).

Parameters:
x t_jit_matrix object pointer
info t_jit_matrix_info pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setplane1d ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets plane of cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setplane2d ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets plane of cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_setplane3d ( t_jit_matrix *  x,
t_symbol s,
long  argc,
t_atom argv 
)

Sets plane of cell at index to the value provided.

See Jitter user documentation for more information.

Parameters:
x t_jit_matrix object pointer
s message symbol pointer
argc argument count
argv argument vector
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.
t_jit_err jit_matrix_togworld ( t_jit_matrix *  x,
GWorldPtr  gp,
t_gworld_conv_info *  gcinfo 
)

Copies Jitter matrix data to GWorld data.

Parameters:
x t_jit_matrix object pointer
gp gworld pointer
gcinfo conversion information pointer
Returns:
t_jit_err error code
Warning:
This function is not exported, but is provided for reference when calling via jit_object_method on an intance of t_jit_matrix.

Copyright © 2008, Cycling '74