The native part. More...

Data Structures
struct	t_symbol
	The t_symbol struture. More...

struct	t_binbuf
	The t_binbuf struture. More...

union	t_word
	The t_word struture. More...

struct	t_atom
	The t_atom struture. More...

struct	t_outlet
	The t_outlet struture. More...

struct	t_gobj
	The graphical t_object struture. More...

struct	t_object
	The t_object struture. More...

struct	t_clock
	The t_clock struture. More...

Macros
#define	CLASS_DEFAULT 0
	The default class flags.

#define	CLASS_PD 1
	The internal pd class flags.

#define	CLASS_GOBJ 2
	The internal array or scalar class flags (don't use it gor GUI)

#define	CLASS_PATCHABLE 3
	The internal text class flags (you should prefer to use CLASS_DEFAULT)

#define	CLASS_NOINLET 8
	The no default first inlet class flags should use it when an t_object should'nt have any inlet.

Typedefs
typedef void(*	t_method )(void *x,...)
	The standart method aka method.

typedef t_class *	t_pd
	pure datum: nothing but a class pointer

Enumerations
enum	t_atomtype { A_NULL, A_FLOAT, A_SYMBOL, A_POINTER, A_SEMI, A_COMMA, A_DEFFLOAT, A_DEFSYM, A_DOLLAR, A_DOLLSYM, A_GIMME, A_CANT }
	The flags that discribes the type of an t_atom. More...

Functions
t_symbol *	gensym (const char *s)
	Retrieves the t_symbol that match with the string. More...

t_clock *	clock_new (void *owner, method fn)
	Allocates a new t_clock. More...

void	clock_free (t_clock *x)
	Frees a t_clock. More...

void	clock_delay (t_clock *x, double delaytime)
	defer the excecution of the t_clock's method. More...

t_outlet *	outlet_new (t_object owner, t_symbol s)
	Allocates and initializes a new t_outlet for an object. More...

void	outlet_bang (t_outlet *x)
	Send a bang through an outlet. More...

void	pd_bang (t_pd *x)
	Send a bang to t_pd internal object. More...

Variables
EXTERN t_symbol	s_pointer
	The pre-defined pointer t_symbol.

EXTERN t_symbol	s_float
	The pre-defined float t_symbol.

EXTERN t_symbol	s_symbol
	The pre-defined symbol t_symbol.

EXTERN t_symbol	s_bang
	The pre-defined bang t_symbol.

EXTERN t_symbol	s_list
	The pre-defined list t_symbol.

EXTERN t_symbol	s_anything
	The pre-defined anything t_symbol.

EXTERN t_symbol	s_signal
	The pre-defined signal t_symbol.

Detailed Description

The native part.

This part refers to the Pd natives methods and definitions. You should never include the part, this is used for documentation.

Data Structure Documentation

struct t_symbol

The t_symbol struture.

The t_symbol is a unique symbol that can be used to bind objects together or as a unique id for strings that can be faster to compare. Use gensym to generate a t_symbol.

Examples:: c.bang.cpp.

Data Fields
char *	s_name	The name of the t_symbol.
struct t_class **	s_thing	The binding list of the t_symbol.
struct t_symbol *	s_next	The next t_symbol.

struct t_binbuf

The t_binbuf struture.

The t_binbuf is just an holder for an array of t_atoms.

Examples:: c.bang.cpp.

Data Fields
int	b_n	The number of t_atom.
t_atom *	b_vec	The array of t_atom.

union t_word

The t_word struture.

The internal value of a t_atom .

Data Fields
t_float	w_float	The float value.
t_symbol *	w_symbol	The t_symbol.
t_gpointer *	w_gpointer
t_array *	w_array	The array.
struct _binbuf *	w_binbuf	The binbuf.
int	w_index

struct t_atom

The t_atom struture.

The t_atom is the formatted structure used to communicates between objects in Pd.

Examples:: c.bang.cpp.

Data Fields
t_atomtype	a_type	The type of the t_atom.
union word	a_w	The value of the t_atom.

struct t_outlet

The t_outlet struture.

The t_outlet is owns the necessary member to send messages to other object.

Examples:: c.bang.cpp.

Data Fields
t_object *	o_owner	The onwer of the t_outlet.
struct _outlet *	o_next	The next t_outlet in the t_object or NULL if it is the last one.
t_outconnect *	o_connections	The connection of the t_outlet.
t_symbol *	o_sym	The symbol that defines caht type of message the outlet send.

struct t_gobj

The graphical t_object struture.

The t_gobj is owns the t_class of an t_object and the pointer to the next t_object.

Data Fields
t_pd	g_pd	pure datum header (class)
struct t_gobj *	g_next	next in list

struct t_object

The t_object struture.

The t_object is owns the necessary member of a patchable object.

Examples:: c.bang.cpp.

Data Fields
t_gobj	te_g	header for graphical t_object
t_binbuf *	te_binbuf	holder for the text
t_outlet *	te_outlet	linked list of outlets
t_inlet *	te_inlet	linked list of inlets
short	te_xpix	x location (within the toplevel)
short	te_ypix	y location (within the toplevel)
short	te_width	requested width in chars, 0 if auto
unsigned int	te_type:2	from defs below

struct t_clock

The t_clock struture.

The t_clock is owns the necessary member of a clock. A t_clock is used to defer the excecution of a method.

Examples:: c.bang.cpp.

Data Fields
double	c_settime	in TIMEUNITS; <0 if unset
void *	c_owner	The owner
t_clockmethod	c_fn	The method to call
struct t_clock *	c_next	The next to t_clock
t_float	c_unit	>0 if in TIMEUNITS; <0 if in samples

Enumeration Type Documentation

enum t_atomtype

The flags that discribes the type of an t_atom.

It define all possible type of an t_atom.

Enumerator
A_NULL	Nothing.
A_FLOAT	A float.
A_SYMBOL	A t_symbol.
A_GIMME	An array of t_atoms or a function with the parameters int and t_atom*.
A_CANT	Nothing or a function that can be called only internally with any kind of parameters.

Function Documentation

t_symbol * gensym ( const char * s )

Retrieves the t_symbol that match with the string.

The function allocates a new t_symbol if it doesn't already exist, otherwise it return the t_symbol that matchs to the string.

Parameters

s	The name of the t_symbol.

Returns: The pointer to the t_symbol.

Examples:: c.bang.cpp.

t_clock * clock_new	(	void *	owner,
		method	fn
	)

Allocates a new t_clock.

The function allocates a new t_clock and attaches it to a function.

Parameters

owner	The owner of the t_clock.
fn	The fn to call.

Returns: The pointer to the t_clock.

Examples:: c.bang.cpp.

void clock_free ( t_clock * x )

Frees a t_clock.

Parameters

x	The t_clock.

Examples:: c.bang.cpp.

void clock_delay	(	t_clock *	x,
		double	delaytime
	)

defer the excecution of the t_clock's method.

Parameters

x	The t_clock.
delaytime	The time to wait.

Examples:: c.bang.cpp.

t_outlet * outlet_new	(	t_object *	owner,
		t_symbol *	s
	)

Allocates and initializes a new t_outlet for an object.

The function allocates a initializes a new t_outlet for an object. The symbol is generally one of the pd default message s_bang, s_symbol, s_list, s_anything, ect.

Parameters

owner	The owner of the outlet.
s	The symbol that of the outlet.

Returns: The pointer to the t_outlet.

Examples:: c.bang.cpp.

void outlet_bang ( t_outlet * x )

Send a bang through an outlet.

Parameters

x	The outlet pointer.

Examples:: c.bang.cpp.

void pd_bang ( t_pd * x )

Send a bang to t_pd internal object.

Parameters

x	The t_pd pointer.

Examples:: c.bang.cpp.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Data Structure Documentation

Enumeration Type Documentation

Function Documentation