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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.