Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RpLogo
[2d Tools]


Functions

RwRectRpLogoGetRenderingRect (void)
RpLogoPosition RpLogoGetPosition (void)
RwBool RpLogoSetPosition (RpLogoPosition pos)
RwBool RpLogoGetState (RwCamera *cam)
RwBool RpLogoSetState (RwCamera *cam, RwBool state)
RwBool RpLogoPluginAttach (void)

Detailed Description

Logo Plugin for RenderWare Graphics.

RpLogo Overview

Requirements

Overview

This plugin renders a RenderWare logo on the screen. The logo will appear automatically when the plugin is attached. It is possible to turn the appearance of the logo on/off after the plugin is attached. It is not possible to change the logo's image.

This plugin is intended for use in examples or demos. It should not be used in the final product.


Function Documentation

RpLogoPosition RpLogoGetPosition void   
 

RpLogoGetPosition returns the current screen placement of the logo

Returns:
Position on success, Null otherwise
See also:
RpLogoGetState , RpLogoPluginAttach , RpLogoSetPosition , RpLogoSetState

RwRect* RpLogoGetRenderingRect void   
 

RpLogoGetRenderingRect gets the rectangle on the camera raster the logo is rendered into.

Returns:
pointer to the rect
See also:
RpLogoGetPosition , RpLogoPluginAttach , RpLogoSetPosition

RwBool RpLogoGetState RwCamera   camera
 

RpLogoGetState gets the current visibility state of the logo

Returns:
the old state
See also:
RpLogoGetPosition , RpLogoPluginAttach , RpLogoSetPosition , RpLogoSetState

RwBool RpLogoPluginAttach void   
 

RpLogoPluginAttach is called by the application to indicate that the Logo plugin should be used. The call to this function should be placed after RwEngineInit and RpWorldPluginAttach

Returns:
True on success, false otherwise
See also:
RpLogoGetPosition , RpLogoGetState , RpLogoSetPosition , RpLogoSetState

RwBool RpLogoSetPosition RpLogoPosition    pos
 

RpLogoSetPosition determines where on the screen the logo should be placed

Parameters:
pos  screen location
Returns:
True on success, false otherwise
See also:
RpLogoGetPosition , RpLogoGetState , RpLogoPluginAttach , RpLogoSetState

RwBool RpLogoSetState RwCamera   camera,
RwBool    state
 

RpLogoSetState turns the logo on and off

Parameters:
camera  determines whether logo in on or off
state  flag TRUE logo on
Returns:
the old state
See also:
RpLogoGetPosition , RpLogoGetState , RpLogoPluginAttach , RpLogoSetPosition


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