Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RpToonInkDictionary
[RpToon]


Typedefs
typedef RpToonInk *(  RpToonInkCallBack )(RpToonInk *ink, void *data)

Functions
RpToonInkDictionary *  RpToonInkDictionaryCreate (void)
void  RpToonInkDictionaryDestroy (RpToonInkDictionary *inkDictionary)
RpToonInkDictionary *  RpToonInkDictionaryAddInk (RpToonInkDictionary *inkDictionary, RpToonInk *ink)
void  RpToonInkDictionaryRemoveInk (RpToonInkDictionary *inkDictionary, RpToonInk *ink)
RpToonInk *  RpToonInkDictionaryFindNamedInk (const RpToonInkDictionary *inkDictionary, const RwChar *name)
void  RpToonInkDictionaryForAllInks (const RpToonInkDictionary *inkDictionary, RpToonInkCallBack *inkCB, void *data)
RpToonInkDictionary *  RpToonInkDictionaryStreamRead (RwStream *stream)
const RpToonInkDictionary *  RpToonInkDictionaryStreamWrite (const RpToonInkDictionary *inkDictionary, RwStream *stream)

Typedef Documentation

typedef RpToonInk*( RpToonInkCallBack)(RpToonInk *ink, void *data)
 

RpToonInkCallBack represents the function called from RpToonInkDictionaryForAllInks for all inks in a given paint dictionary. This function should return the current ink to indicate success. The callback may return NULL to terminate further callbacks on the ink dictionary.

Parameters:
ink  Pointer to the current ink.
data  User-defined data pointer.
Returns:
Pointer to the current ink or NULL
See also:
RpToonInkDictionaryForAllInks

Function Documentation

RpToonInkDictionary* RpToonInkDictionaryAddInk (  RpToonInkDictionary *    inkDictionary,
RpToonInk *    ink
) 
 

RpToonInkDictionaryAddInk is used to add a RpToonInk to a RpToonInkDictionary. RpToonInkAddRef is called on the ink.

Parameters:
inkDictionary  a pointer to the RpToonInkDictionary.
ink  a pointer to the RpToonInk to add.
Returns:
a pointer to the inkDictionary on success, NULL otherwise.
See also:
RpToonInkDictionaryRemoveInk , RpToonInkAddRef
RpToonInkDictionary* RpToonInkDictionaryCreate (  void    ) 
 

RpToonInkDictionaryCreate is used to create a new empty RpToonInkDictionary.

Returns:
Returns a pointer to the newly created RpToonInkDictionary if successful or NULL if there is an error
See also:
RpToonInkDictionaryDestroy
void RpToonInkDictionaryDestroy (  RpToonInkDictionary *    inkDictionary ) 
 

RpToonInkDictionaryDestroy is used to destroy an RpToonInkDictionary. RpToonInkDestroy is called on each ink in the inkDictionary.

Parameters:
inkDictionary  a pointer to the RpToonInkDictionary to destroy.
Returns:
none.
See also:
RpToonInkDictionaryCreate , RpToonInkDestroy
RpToonInk* RpToonInkDictionaryFindNamedInk (  const RpToonInkDictionary *    inkDictionary,
const RwChar *    name
) 
 

RpToonInkDictionaryFindNamedInk is used to find a RpToonInk with a particular name in a RpToonInkDictionary.

Parameters:
inkDictionary  a pointer to the RpToonInkDictionary.
name  the name to match.
Returns:
a pointer to the first RpToonInk with a name that matched, or NULL if there was no such ink.
See also:
RpToonInkDictionaryAddInk , RpToonInkDictionaryRemoveInk
void RpToonInkDictionaryForAllInks (  const RpToonInkDictionary *    inkDictionary,
RpToonInkCallBack *    inkCB,
void *    data
) 
 

RpToonInkDictionaryForAllInks is used to iterate over all the RpToonInk objects in a RpToonInkDictionary.

Parameters:
inkDictionary  a pointer to the RpToonInkDictionary.
inkCB  callback function called with each ink
data  pointer to arbitrary data for use by the callback function
Returns:
none.
See also:
RpToonInkDictionaryAddInk , RpToonInkDictionaryRemoveInk
void RpToonInkDictionaryRemoveInk (  RpToonInkDictionary *    inkDictionary,
RpToonInk *    ink
) 
 

RpToonInkDictionaryRemoveInk is used to remove a RpToonInk from a RpToonInkDictionary. RpToonInkDestroy is called on the ink to decrement its reference count.

Parameters:
inkDictionary  a pointer to the RpToonInkDictionary.
ink  a pointer to the RpToonInk to remove.
Returns:
none.
See also:
RpToonInkDictionaryAddInk , RpToonInkAddRef
RpToonInkDictionary* RpToonInkDictionaryStreamRead (  RwStream *    stream ) 
 

RpToonInkDictionaryStreamRead is used to read an ink dictionary and all the RpToonInk objects in containts from the specified binary stream.

Parameters:
stream  A pointer to the binary stream from which the ink dictionary will be read
Returns:
Returns a pointer to the RpToonInkDictionary if successful or NULL if there is an error
See also:
RpToonInkDictionaryStreamWrite
const RpToonInkDictionary* RpToonInkDictionaryStreamWrite (  const RpToonInkDictionary *    inkDictionary,
RwStream *    stream
) 
 

RpToonInkDictionaryStreamWrite is used to write the specified ink dictionary and all its RpToonInk objects to the given binary stream. The stream must have been opened prior to this function call.

Parameters:
inkDictionary  A pointer to the ink dictionary to be written
stream  A pointer to the binary stream
Returns:
Returns a pointer to the inkDictionary if successful, or NULL if there is an error
See also:
RpToonInkDictionaryStreamRead , RwStreamOpen , RwStreamClose
Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:32 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)