Max 5 API Reference

Atom Module
[Jitter]

Collaboration diagram for Atom Module:

Functions

t_jit_err jit_atom_setlong (t_atom *a, long b)
 Sets atom value to long integer.
t_jit_err jit_atom_setfloat (t_atom *a, double b)
 Sets atom value to floating point number.
t_jit_err jit_atom_setsym (t_atom *a, t_symbol *b)
 Sets atom value to symbol.
t_jit_err jit_atom_setobj (t_atom *a, void *b)
 Sets atom value to object pointer.
long jit_atom_getlong (t_atom *a)
 Retrieves atom value as long integer.
double jit_atom_getfloat (t_atom *a)
 Retrieves atom value as floating point number.
t_symbol * jit_atom_getsym (t_atom *a)
 Retrieves atom value as symbol pointer.
void * jit_atom_getobj (t_atom *a)
 Retrieves atom value as object pointer.
long jit_atom_getcharfix (t_atom *a)
 Retrieves atom value as an 8 bit fixed point number.
long jit_atom_arg_getlong (long *c, long idx, long ac, t_atom *av)
 Retrieves atom argument at index as long integer if present.
long jit_atom_arg_getfloat (float *c, long idx, long ac, t_atom *av)
 Retrieves atom argument at index as floating point number if present.
long jit_atom_arg_getdouble (double *c, long idx, long ac, t_atom *av)
 Retrieves atom argument at index as double precision floating point number if present.
long jit_atom_arg_getsym (t_symbol **c, long idx, long ac, t_atom *av)
 Retrieves atom argument at index as symbol pointer if present.

Function Documentation

long jit_atom_arg_getdouble ( double *  c,
long  idx,
long  ac,
t_atom *  av 
)

Retrieves atom argument at index as double precision floating point number if present.

This function is useful for setting the values only if there is an argument at the specified index, otherwise, the input value is untouched.

Parameters:
c pointer to double (should contain desired default)
idx atom argument index
ac atom argument count
av atom argument vector
Returns:
t_jit_err error code. JIT_ERR_NONE if successful.

Definition at line 281 of file jit.atom.c.

References jit_atom_getfloat().

Here is the call graph for this function:

long jit_atom_arg_getfloat ( float *  c,
long  idx,
long  ac,
t_atom *  av 
)

Retrieves atom argument at index as floating point number if present.

This function is useful for setting the values only if there is an argument at the specified index, otherwise, the input value is untouched.

Parameters:
c pointer to float (should contain desired default)
idx atom argument index
ac atom argument count
av atom argument vector
Returns:
t_jit_err error code. JIT_ERR_NONE if successful.

Definition at line 257 of file jit.atom.c.

References jit_atom_getfloat().

Here is the call graph for this function:

long jit_atom_arg_getlong ( long *  c,
long  idx,
long  ac,
t_atom *  av 
)

Retrieves atom argument at index as long integer if present.

This function is useful for setting the values only if there is an argument at the specified index, otherwise, the input value is untouched.

Parameters:
c pointer to long (should contain desired default)
idx atom argument index
ac atom argument count
av atom argument vector
Returns:
t_jit_err error code. JIT_ERR_NONE if successful.

Definition at line 233 of file jit.atom.c.

References jit_atom_getlong().

Referenced by jit_qt_movie_matrix_to_image(), and max_jit_mop_matrix_args().

Here is the call graph for this function:

long jit_atom_arg_getsym ( t_symbol **  c,
long  idx,
long  ac,
t_atom *  av 
)

Retrieves atom argument at index as symbol pointer if present.

This function is useful for setting the values only if there is an argument at the specified index, otherwise, the input value is untouched.

Parameters:
c pointer to symbol pointer (should contain desired default)
idx atom argument index
ac atom argument count
av atom argument vector
Returns:
t_jit_err error code. JIT_ERR_NONE if successful.

Definition at line 305 of file jit.atom.c.

References jit_atom_getsym().

Referenced by jit_qt_movie_matrix_to_image(), jit_qt_movie_read_typed(), and max_jit_mop_matrix_args().

Here is the call graph for this function:

long jit_atom_getcharfix ( t_atom *  a  ) 

Retrieves atom value as an 8 bit fixed point number.

Parameters:
a atom pointer
Returns:
8 bit fixed point value in the range 0-255. 0 if atom has no numeric value.

Definition at line 201 of file jit.atom.c.

References A_FLOAT, A_LONG, t_atom::a_type, t_atom::a_w, CLIP, word::w_float, and word::w_long.

Referenced by jit_matrix_setall(), and jit_matrix_setcell().

double jit_atom_getfloat ( t_atom *  a  ) 

Retrieves atom value as floating point number.

Parameters:
a atom pointer
Returns:
floating point value. 0 if atom has no numeric value.

Definition at line 133 of file jit.atom.c.

References A_FLOAT, A_LONG, t_atom::a_type, t_atom::a_w, word::w_float, and word::w_long.

Referenced by jit_atom_arg_getdouble(), jit_atom_arg_getfloat(), jit_matrix_setall(), and jit_matrix_setcell().

long jit_atom_getlong ( t_atom *  a  ) 

Retrieves atom value as long integer.

Parameters:
a atom pointer
Returns:
long integer value. 0 if atom has no numeric value.

Definition at line 110 of file jit.atom.c.

Referenced by jit_atom_arg_getlong(), jit_matrix_exprfill(), jit_matrix_getcell(), jit_matrix_setall(), jit_matrix_setcell(), jit_matrix_setcell1d(), jit_matrix_setcell2d(), jit_matrix_setcell3d(), jit_matrix_setplane1d(), jit_matrix_setplane2d(), and jit_matrix_setplane3d().

void* jit_atom_getobj ( t_atom *  a  ) 

Retrieves atom value as object pointer.

Parameters:
a atom pointer
Returns:
object pointer. NULL if atom has no object value.

Definition at line 179 of file jit.atom.c.

References A_OBJ, t_atom::a_type, t_atom::a_w, and word::w_obj.

Referenced by jit_matrix_setcell().

t_symbol * jit_atom_getsym ( t_atom *  a  ) 

Retrieves atom value as symbol pointer.

Parameters:
a atom pointer
Returns:
symbol pointer. _jit_sym_nothing if atom has no symbolic value.

Definition at line 156 of file jit.atom.c.

Referenced by jit_atom_arg_getsym(), jit_matrix_exprfill(), jit_matrix_jit_gl_texture(), jit_matrix_op(), jit_matrix_setcell(), and max_jit_mop_jit_matrix().

t_jit_err jit_atom_setfloat ( t_atom *  a,
double  b 
)

Sets atom value to floating point number.

Parameters:
a atom pointer
b floating point value
Returns:
t_jit_err error code.

Definition at line 48 of file jit.atom.c.

References A_FLOAT, t_atom::a_type, t_atom::a_w, and word::w_float.

Referenced by jit_matrix_getcell(), and jit_qt_movie_matrix_calc().

t_jit_err jit_atom_setlong ( t_atom *  a,
long  b 
)

Sets atom value to long integer.

Parameters:
a atom pointer
b integer value
Returns:
t_jit_err error code.

Definition at line 27 of file jit.atom.c.

Referenced by jit_matrix_getcell(), jit_matrix_setcell1d(), jit_matrix_setcell2d(), jit_matrix_setcell3d(), jit_matrix_setplane1d(), jit_matrix_setplane2d(), jit_matrix_setplane3d(), jit_ob3d_draw_chunk(), and jit_qt_movie_read_typed().

t_jit_err jit_atom_setobj ( t_atom *  a,
void *  b 
)

Sets atom value to object pointer.

Parameters:
a atom pointer
b object pointer
Returns:
t_jit_err error code.

Definition at line 90 of file jit.atom.c.

References A_OBJ, t_atom::a_type, t_atom::a_w, and word::w_obj.

Referenced by jit_matrix_getcell(), and jit_matrix_jit_gl_texture().

t_jit_err jit_atom_setsym ( t_atom *  a,
t_symbol *  b 
)

Sets atom value to symbol.

Parameters:
a atom pointer
b symbol value
Returns:
t_jit_err error code.

Definition at line 69 of file jit.atom.c.

References A_SYM, t_atom::a_type, t_atom::a_w, and word::w_sym.

Referenced by jit_matrix_getcell(), jit_matrix_setcell1d(), jit_matrix_setcell2d(), jit_matrix_setcell3d(), jit_matrix_setplane1d(), jit_matrix_setplane2d(), jit_matrix_setplane3d(), jit_mop_single_type(), jit_ob3d_new(), jit_object_exportattrs(), jit_qt_codec_getcodeclist_audio(), jit_qt_codec_getcodeclist_gfx(), jit_qt_codec_getcodeclist_video(), jit_qt_movie_matrix_to_image(), jit_qt_movie_read_typed(), and max_jit_mop_outputmatrix().

Copyright © 2008, Cycling '74