Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RpToonPaint
[RpToon]


Enumerations

enum  RpToonPaintType { RPTOON_PAINTTYPE_FLAT = 0, RPTOON_PAINTTYPE_TOONSHADE, RPTOON_PAINTTYPE_COUNT, RPTOON_PAINTTYPE_FORCEENUMSIZEINT = RWFORCEENUMSIZEINT }

Functions

RpToonPaintRpToonPaintCreate (void)
void RpToonPaintDestroy (RpToonPaint *paint)
void RpToonPaintAddRef (RpToonPaint *paint)
RpToonPaintType RpToonPaintGetType (const RpToonPaint *paint)
void RpToonPaintSetType (RpToonPaint *paint, RpToonPaintType type)
const RwCharRpToonPaintGetName (const RpToonPaint *paint)
void RpToonPaintSetName (RpToonPaint *paint, const RwChar *name)
RwTextureRpToonPaintGetGradientTexture (const RpToonPaint *paint)
void RpToonPaintSetGradientTexture (RpToonPaint *paint, RwTexture *texture)
RpToonPaintRpToonPaintStreamRead (RwStream *stream)
const RpToonPaintRpToonPaintStreamWrite (const RpToonPaint *paint, RwStream *stream)

Enumeration Type Documentation

enum RpToonPaintType
 

RpToonPaintType defines the different ways a toon paint can be rendered. Once a paint has been created, it's type can be changed with RpToonPaintSetType and queried with RpToonPaintGetType.

Enumeration values:
RPTOON_PAINTTYPE_FLAT  Flat shading, material and texture color is fully bright
RPTOON_PAINTTYPE_TOONSHADE  Toon shading, material and texture color blended against shading texture
RPTOON_PAINTTYPE_COUNT  Count of paint types


Function Documentation

void RpToonPaintAddRef RpToonPaint   paint
 

RpToonPaintAddRef is used to increment the reference count of an RpToonPaint.

Parameters:
paint  the RpToonPaint to reference.
Returns:
none.
See also:
RpToonPaintDestroy , RpToonPaintCreate

RpToonPaint* RpToonPaintCreate void   
 

RpToonPaintCreate is used to create a new RpToonPaint with default values and a reference count of 1.

Returns:
Returns a pointer to the newly created RpToonPaint if successful or NULL if there is an error
See also:
RpToonPaintAddRef , RpToonPaintDestroy

void RpToonPaintDestroy RpToonPaint   paint
 

RpToonPaintDestroy is used to destroy an RpToonPaint. It decrements the paint's reference count, and if it's 0, it is destroyed.

Parameters:
paint  the RpToonPaint to destroy.
Returns:
none.
See also:
RpToonPaintAddRef , RpToonPaintDestroy

RwTexture* RpToonPaintGetGradientTexture const RpToonPaint   paint
 

RpToonPaintGetGradientTexture is used to get a paint's gradient texture.

Parameters:
paint  A pointer to the paint.
Returns:
the paints gradient texture.
See also:
RpToonPaintSetGradientTexture

const RwChar* RpToonPaintGetName const RpToonPaint   paint
 

RpToonPaintGetName is used to get a paint's name. Paint names are used as keys in RpToonPaintDictionary objects.

Parameters:
paint  A pointer to the paint.
Returns:
the paints name.
See also:
RpToonPaintSetName

RpToonPaintType RpToonPaintGetType const RpToonPaint   paint
 

RpToonPaintGetType is used to get a paint's type.

Parameters:
paint  A pointer to the paint.
Returns:
The paint's type.
See also:
RpToonPaintSetType , RpToonPaintType

void RpToonPaintSetGradientTexture RpToonPaint   paint,
RwTexture   texture
 

RpToonPaintSetGradientTexture is used to set a paint's gradient texture. The gradient texture is used when the paint's type is RPTOON_PAINTTYPE_TOONSHADE.

Parameters:
paint  A pointer to the paint.
texture  the new gradient texture.
Returns:
none.
See also:
RpToonPaintGetGradientTexture , RpToonPaintType

void RpToonPaintSetName RpToonPaint   paint,
const RwChar   name
 

RpToonPaintSetName is used to set a paint's name. Paint names are used as keys in RpToonPaintDictionary objects.

Parameters:
paint  A pointer to the paint.
name  A string specifying the new name.
Returns:
none.
See also:
RpToonPaintGetName

void RpToonPaintSetType RpToonPaint   paint,
RpToonPaintType    type
 

RpToonPaintSetType is used to set a paint's type.

Parameters:
paint  A pointer to the paint.
type  The new type.
Returns:
none.
See also:
RpToonPaintGetType , RpToonPaintType

RpToonPaint* RpToonPaintStreamRead RwStream   stream
 

RpToonPaintStreamRead is used to read an paint from the specified binary stream.

Parameters:
stream  A pointer to the binary stream from which the paint will be read
Returns:
Returns a pointer to the paint if successful or NULL if there is an error
See also:
RpToonkPaintStreamWrite

const RpToonPaint* RpToonPaintStreamWrite const RpToonPaint   paint,
RwStream   stream
 

RpToonPaintStreamWrite is used to write the specified paint to the given binary stream. The stream must have been opened prior to this function call.

Parameters:
paint  A pointer to the paint to be written
stream  A pointer to the binary stream
Returns:
Returns a pointer to the paint if successful, or NULL if there is an error
See also:
RpToonPaintStreamRead , RwStreamOpen , RwStreamClose


Criterion Software © 1993-2004 Criterion Software Limited. All rights reserved. Built Thu Feb 12 13:47:05 2004. Send Feedback