RpEnvironment
[Cameras]


Data Structures
struct	RpEnvironment
Functions
RpEnvironment *	RpEnvironmentCreate (void)
void	RpEnvironmentDestroy (RpEnvironment *environment)
RwInt32	RpEnvironmentStreamGetSize (RpEnvironment *environment)
RpEnvironment *	RpEnvironmentStreamRead (RwStream *stream)
RpEnvironment *	RpEnvironmentStreamWrite (RpEnvironment environment, RwStream stream)
void	RpEnvironmentSetBackground (RpEnvironment *environment, RwRGBA color)
RwRGBA *	RpEnvironmentGetBackground (RpEnvironment *environment)

Detailed Description

Environment Plug-In for RenderWare.

The RpEnvironment plugin can be used by tools to set a background color to assets.

RpEnvironment* RpEnvironmentCreate ( void )

RpEnvironmentCreate creates and returns a standard RpEnvironment. The RpEnvironment created will initialize the corresponding background color to the following values:

red = 0
green = 0
blue = 0
alpha = 255

Returns:
A pointer to the new RpEnvironment if successful, NULL otherwise.
See also:
RpEnvironmentDestroy , RpEnvironmentStreamGetSize , RpEnvironmentStreamRead , RpEnvironmentStreamWrite

void RpEnvironmentDestroy ( RpEnvironment * environment )

RpEnvironmentDestroy destroys a RpEnvironment setting.
Parameters:

environment A pointer to the RpEnvironment settings to destroy

See also:
RpEnvironmentCreate , RpEnvironmentStreamGetSize , RpEnvironmentStreamRead , RpEnvironmentStreamWrite

RwRGBA* RpEnvironmentGetBackground ( RpEnvironment * environment )

RpEnvironmentGetBackground returns the current background color for a specific RpEnvironment object.
Parameters:

environment A pointer to the RpEnvironment object to get the color from.

Returns:
A pointer to the background color of the specified RpEnvironment.
See also:
RpEnvironmentCreate , RpEnvironmentDestroy , RpEnvironmentStreamGetSize , RpEnvironmentStreamRead

void RpEnvironmentSetBackground ( RpEnvironment * environment,

RwRGBA color

)

RpEnvironmentSetBackground sets the background color for a specific RpEnvironment.
Parameters:

environment A pointer to the RpEnvironment object to set the color for.

color The new background color.

See also:
RpEnvironmentCreate , RpEnvironmentDestroy , RpEnvironmentStreamGetSize , RpEnvironmentStreamRead

RwInt32 RpEnvironmentStreamGetSize ( RpEnvironment * environment )

RpEnvironmentStreamGetSize returns the size of an RpEnvironment object.
Parameters:

environment A pointer to the RpEnvironment settings to get the size from.

Returns:
The size of the stream
See also:
RpEnvironmentCreate , RpEnvironmentDestroy , RpEnvironmentStreamRead , RpEnvironmentStreamWrite

RpEnvironment* RpEnvironmentStreamRead ( RwStream * stream )

RpEnvironmentStreamRead reads the RpEnvironment chunk from a Renderware stream.
Parameters:

stream The stream to read the RpEnvironment object from.

Returns:
The RpEnvironment object within the stream.
See also:
RpEnvironmentCreate , RpEnvironmentDestroy , RpEnvironmentStreamGetSize , RpEnvironmentStreamWrite

RpEnvironment* RpEnvironmentStreamWrite ( RpEnvironment * environment,

RwStream * stream

)

RpEnvironmentStreamWrite streams out an RpEnvironment object to a RenderWare stream.
Parameters:

environment A pointer to the RpEnvironment settings to write out.

stream A pointer to the stream to write the RpEnvironment to.

Returns:
A pointer to the RpEnvironment writen out.
See also:
RpEnvironmentCreate , RpEnvironmentDestroy , RpEnvironmentStreamGetSize , RpEnvironmentStreamRead