Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RpToonPaintDictionary
[RpToon]


Typedefs
typedef RpToonPaint *(  RpToonPaintCallBack )(RpToonPaint *paint, void *data)

Functions
RpToonPaintDictionary *  RpToonPaintDictionaryCreate (void)
void  RpToonPaintDictionaryDestroy (RpToonPaintDictionary *paintDictionary)
RpToonPaintDictionary *  RpToonPaintDictionaryAddPaint (RpToonPaintDictionary *paintDictionary, RpToonPaint *paint)
void  RpToonPaintDictionaryRemovePaint (RpToonPaintDictionary *paintDictionary, RpToonPaint *paint)
RpToonPaint *  RpToonPaintDictionaryFindNamedPaint (const RpToonPaintDictionary *paintDictionary, const RwChar *name)
void  RpToonPaintDictionaryForAllPaints (const RpToonPaintDictionary *paintDictionary, RpToonPaintCallBack *paintCB, void *data)
RpToonPaintDictionary *  RpToonPaintDictionaryStreamRead (RwStream *stream)
const RpToonPaintDictionary *  RpToonPaintDictionaryStreamWrite (const RpToonPaintDictionary *paintDictionary, RwStream *stream)

Typedef Documentation

typedef RpToonPaint*( RpToonPaintCallBack)(RpToonPaint *paint, void *data)
 

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

Parameters:
paint  Pointer to the current texture.
data  User-defined data pointer.
Returns:
Pointer to the current paint or NULL
See also:
RpToonPaintDictionaryForAllPaints

Function Documentation

RpToonPaintDictionary* RpToonPaintDictionaryAddPaint (  RpToonPaintDictionary *    paintDictionary,
RpToonPaint *    paint
) 
 

RpToonPaintDictionaryAddPaint is used to add a RpToonPaint to a RpToonPaintDictionary. RpToonPaintAddRef is called on the paint.

Parameters:
paintDictionary  a pointer to the RpToonPaintDictionary.
paint  a pointer to the RpToonPaint to add.
Returns:
a pointer to the paintDictionary on success, NULL otherwise.
See also:
RpToonPaintDictionaryRemovePaint , RpToonPaintAddRef
RpToonPaintDictionary* RpToonPaintDictionaryCreate (  void    ) 
 

RpToonPaintDictionaryCreate is used to create a new empty RpToonPaintDictionary.

Returns:
Returns a pointer to the newly created RpToonPaintDictionary if successful or NULL if there is an error
See also:
RpToonPaintDictionaryDestroy
void RpToonPaintDictionaryDestroy (  RpToonPaintDictionary *    paintDictionary ) 
 

RpToonPaintDictionaryDestroy is used to destroy an RpToonPaintDictionary. RpToonPaintDestroy is called on each paint in paintDictionary.

Parameters:
paintDictionary  a pointer to the RpToonPaintDictionary to destroy.
Returns:
none.
See also:
RpToonPaintDictionaryCreate , RpToonPaintDestroy
RpToonPaint* RpToonPaintDictionaryFindNamedPaint (  const RpToonPaintDictionary *    paintDictionary,
const RwChar *    name
) 
 

RpToonPaintDictionaryFindNamedPaint is used to find a RpToonPaint with a particular name in a RpToonPaintDictionary.

Parameters:
paintDictionary  a pointer to the RpToonPaintDictionary.
name  the name to match.
Returns:
a pointer to the first RpToonPaint with a name that matched, or NULL if there was no such paint.
See also:
RpToonPaintDictionaryAddPaint , RpToonPaintDictionaryRemovePaint
void RpToonPaintDictionaryForAllPaints (  const RpToonPaintDictionary *    paintDictionary,
RpToonPaintCallBack *    paintCB,
void *    data
) 
 

RpToonPaintDictionaryForAllPaints is used to iterate over all the RpToonPaint objects in a RpToonPaintDictionary.

Parameters:
paintDictionary  a pointer to the RpToonPaintDictionary.
paintCB  callback function called with each paint
data  pointer to arbitrary data for use by the callback function
Returns:
none.
See also:
RpToonPaintDictionaryAddPaint , RpToonPaintDictionaryRemovePaint
void RpToonPaintDictionaryRemovePaint (  RpToonPaintDictionary *    paintDictionary,
RpToonPaint *    paint
) 
 

RpToonPaintDictionaryRemovePaint is used to remove a RpToonPaint from a RpToonPaintDictionary. RpToonPaintDestroy is called on the paint to decrement its reference count.

Parameters:
paintDictionary  a pointer to the RpToonPaintDictionary.
paint  a pointer to the RpToonPaint to remove.
Returns:
none.
See also:
RpToonPaintDictionaryAddPaint , RpToonPaintAddRef
RpToonPaintDictionary* RpToonPaintDictionaryStreamRead (  RwStream *    stream ) 
 

RpToonPaintDictionaryStreamRead is used to read an paint dictionary and all the RpToonPaint objects in containts from the specified binary stream.

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

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

Parameters:
paintDictionary  A pointer to the paint dictionary to be written
stream  A pointer to the binary stream
Returns:
Returns a pointer to the paintDictionary if successful, or NULL if there is an error
See also:
RpToonPaintDictionaryStreamRead , 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)