Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RwIm2DVertex
[Immediate Mode]


Typedefs

typedef RwIm2DVertex RwIm2DVertex
typedef RxVertexIndex RxVertexIndex
typedef RwImVertexIndex RwImVertexIndex

Functions

void RwIm2DVertexSetCameraX (RwIm2DVertex *vertex, RwReal cameraX)
void RwIm2DVertexSetCameraY (RwIm2DVertex *vertex, RwReal cameraY)
void RwIm2DVertexSetCameraZ (RwIm2DVertex *vertex, RwReal cameraZ)
void RwIm2DVertexSetRecipCameraZ (RwIm2DVertex *vertex, RwReal reciprocalZ)
RwReal RwIm2DVertexGetCameraX (RwIm2DVertex *vertex)
RwReal RwIm2DVertexGetCameraY (RwIm2DVertex *vertex)
RwReal RwIm2DVertexGetCameraZ (RwIm2DVertex *vertex)
RwReal RwIm2DVertexGetRecipCameraZ (RwIm2DVertex *vertex)
void RwIm2DVertexSetScreenX (RwIm2DVertex *vertex, RwReal screenX)
void RwIm2DVertexSetScreenY (RwIm2DVertex *vertex, RwReal screenY)
void RwIm2DVertexSetScreenZ (RwIm2DVertex *vertex, RwReal screenZ)
RwReal RwIm2DVertexGetScreenX (RwIm2DVertex *vertex)
RwReal RwIm2DVertexGetScreenY (RwIm2DVertex *vertex)
RwReal RwIm2DVertexGetScreenZ (RwIm2DVertex *vertex)
void RwIm2DVertexSetU (RwIm2DVertex *vertex, RwReal u, RwReal reciprocalZ)
void RwIm2DVertexSetV (RwIm2DVertex *vertex, RwReal v, RwReal reciprocalZ)
RwReal RwIm2DVertexGetU (RwIm2DVertex *vertex)
RwReal RwIm2DVertexGetV (RwIm2DVertex *vertex)
void RwIm2DVertexSetRealRGBA (RwIm2DVertex *vertex, RwReal red, RwReal green, RwReal blue, RwReal alpha)
void RwIm2DVertexSetIntRGBA (RwIm2DVertex *vertex, RwUInt8 red, RwUInt8 green, RwUInt8 blue, RwUInt8 alpha)
RwUInt32 RwIm2DVertexGetRed (RwIm2DVertex *vertex)
RwUInt32 RwIm2DVertexGetGreen (RwIm2DVertex *vertex)
RwUInt32 RwIm2DVertexGetBlue (RwIm2DVertex *vertex)
RwUInt32 RwIm2DVertexGetAlpha (RwIm2DVertex *vertex)

Detailed Description

Im2D Vertex data access

RwIm2DVertex Overview

Requirements

Overview

While rendering 2D Immediate Mode geometry, a set of RwIm2DVertex objects is produced. The functions documented here are exposed to allow access to these vertices. The vertices have been transformed to device space.

Typedef Documentation

typedef RwIm2DVertex RwIm2DVertex
 

RwIm2DVertex Typedef for a RenderWare Graphics Immediate Mode 2D Vertex

typedef RwImVertexIndex RwImVertexIndex
 

RwImVertexIndex Typedef for a RenderWare Graphics Immediate Mode Vertex.

typedef RxVertexIndex RxVertexIndex
 

RxVertexIndex

Typedef for a RenderWare Graphics PowerPipe Immediate Mode Vertex

Function Documentation

RwUInt32 RwIm2DVertexGetAlpha (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetAlpha is used to retrieve the alpha component of the color from the specified device vertex. Component colors are specified as a value in the range 0 to 255.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwUInt32 value equal to the alpha component.
See also:
RwIm2DVertexGetRed , RwIm2DVertexGetGreen , RwIm2DVertexGetBlue , RwIm2DVertexSetRealRGBA , RwIm2DVertexSetIntRGBA

RwUInt32 RwIm2DVertexGetBlue (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetBlue is used to retrieve the blue component of the color from the specified device vertex. Component colors are specified as a value in the range 0 to 255.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwUInt32 value equal to the blue component.
See also:
RwIm2DVertexGetRed , RwIm2DVertexGetGreen , RwIm2DVertexGetAlpha , RwIm2DVertexSetRealRGBA , RwIm2DVertexSetIntRGBA

RwReal RwIm2DVertexGetCameraX (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetCameraX is used to retrieve the camera x-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the immediate mode 2D vertex.
Returns:
Returns an RwReal value equal to the camera x-coordinate.
See also:
RwIm2DVertexGetCameraY , RwIm2DVertexGetCameraZ , RwIm2DVertexGetRecipCameraZ , RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraY , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ

RwReal RwIm2DVertexGetCameraY (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetCameraY is used to retrieve the camera y-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the camera y-coordinate.
See also:
RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraZ , RwIm2DVertexGetRecipCameraZ , RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraY , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ

RwReal RwIm2DVertexGetCameraZ (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetCameraZ is used to retrieve the camera z-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the camera z-coordinate.
See also:
RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraY , RwIm2DVertexGetRecipCameraZ , RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraY , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ

RwUInt32 RwIm2DVertexGetGreen (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetGreen is used to retrieve the green component of the color from the specified device vertex. Component colors are specified as a value in the range 0 to 255.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwUInt32 value equal to the green component.
See also:
RwIm2DVertexGetRed , RwIm2DVertexGetBlue , RwIm2DVertexGetAlpha , RwIm2DVertexSetRealRGBA , RwIm2DVertexSetIntRGBA

RwReal RwIm2DVertexGetRecipCameraZ (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetRecipCameraZ is used to retrieve the reciprocal camera z-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the reciprocal camera z-coordinate.
See also:
RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraY , RwIm2DVertexGetCameraZ , RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraY , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ

RwUInt32 RwIm2DVertexGetRed (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetRed is used to retrieve the red component of the color from the specified device vertex. Component colors are specified as a value in the range 0 to 255.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwUInt32 value equal to the red component.
See also:
RwIm2DVertexGetGreen , RwIm2DVertexGetBlue , RwIm2DVertexGetAlpha , RwIm2DVertexSetRealRGBA , RwIm2DVertexSetIntRGBA

RwReal RwIm2DVertexGetScreenX (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetScreenX is used to retrieve the screen x-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the screen x-coordinate.
See also:
RwIm2DVertexGetScreenY , RwIm2DVertexGetScreenZ , RwIm2DVertexSetScreenX , RwIm2DVertexSetScreenY , RwIm2DVertexSetScreenZ

RwReal RwIm2DVertexGetScreenY (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetScreenY is used to retrieve the screen y-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the screen y-coordinate.
See also:
RwIm2DVertexGetScreenX , RwIm2DVertexGetScreenZ , RwIm2DVertexSetScreenX , RwIm2DVertexSetScreenY , RwIm2DVertexSetScreenZ

RwReal RwIm2DVertexGetScreenZ (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetScreenZ is used to retrieve the screen z-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the screen z-coordinate.
See also:
RwIm2DVertexGetScreenX , RwIm2DVertexGetScreenY , RwIm2DVertexSetScreenX , RwIm2DVertexSetScreenY , RwIm2DVertexSetScreenZ

RwReal RwIm2DVertexGetU (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetU is used to retrieve the texture u-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the texture u-coordinate.
See also:
RwIm2DVertexGetV , RwIm2DVertexSetU , RwIm2DVertexSetV

RwReal RwIm2DVertexGetV (  RwIm2DVertex *    vertex ) 
 

RwIm2DVertexGetV is used to retrieve the texture v-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex.
Returns:
Returns an RwReal value equal to the texture v-coordinate.
See also:
RwIm2DVertexGetU , RwIm2DVertexSetU , RwIm2DVertexSetV

void RwIm2DVertexSetCameraX (  RwIm2DVertex *    vertex,
RwReal    cameraX
) 
 

RwIm2DVertexSetCameraX is used to define the camera x-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
cameraX  An RwReal value equal to the camera x-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetCameraY , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ , RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraY , RwIm2DVertexGetCameraZ , RwIm2DVertexGetRecipCameraZ

void RwIm2DVertexSetCameraY (  RwIm2DVertex *    vertex,
RwReal    cameraY
) 
 

RwIm2DVertexSetCameraY is used to define the camera y-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
cameraY  An RwReal value equal to the camera y-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ , RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraY , RwIm2DVertexGetCameraZ , RwIm2DVertexGetRecipCameraZ

void RwIm2DVertexSetCameraZ (  RwIm2DVertex *    vertex,
RwReal    cameraZ
) 
 

RwIm2DVertexSetCameraZ is used to define the camera z-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
cameraZ  An RwReal value equal to the camera z-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraZ , RwIm2DVertexSetRecipCameraZ , RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraY , RwIm2DVertexGetCameraZ , RwIm2DVertexGetRecipCameraZ

void RwIm2DVertexSetIntRGBA (  RwIm2DVertex *    vertex,
RwUInt8    red,
RwUInt8    green,
RwUInt8    blue,
RwUInt8    alpha
) 
 

RwIm2DVertexSetIntRGBA is used to define the RGBA color of the specified device vertex. Each color component is specified as an integer value in the range 0 to 255.

RwIm2DVertexSetIntRGBA should be used in preference to the related macro, RwIm2DVertexSetRealRGBA, if the native hardware stores colors in integer format, as it leads to faster execution.

Parameters:
vertex  A pointer to the device vertex
red  An RwUInt8 value equal to the color's red component
green  An RwUInt8 value equal to the color's green component
blue  An RwUInt8 value equal to the color's blue component
alpha  An RwUInt8 value equal to the color's alpha component.
Returns:
None.
See also:
RwIm2DVertexGetRed , RwIm2DVertexGetGreen , RwIm2DVertexGetBlue , RwIm2DVertexGetAlpha , RwIm2DVertexSetRealRGBA

void RwIm2DVertexSetRealRGBA (  RwIm2DVertex *    vertex,
RwReal    red,
RwReal    green,
RwReal    blue,
RwReal    alpha
) 
 

RwIm2DVertexSetRealRGBA is used to define the RGBA color of the specified device vertex. Each color component is specified as a real value in the range (RwReal)((0.0)) to (RwReal)((255.0)).

Parameters:
vertex  A pointer to the device vertex
red  An RwReal value equal to the color's red component
green  An RwReal value equal to the color's green component
blue  An RwReal value equal to the color's blue component
alpha  An RwReal value equal to the color's alpha component.
Returns:
None.
See also:
RwIm2DVertexGetRed , RwIm2DVertexGetGreen , RwIm2DVertexGetBlue , RwIm2DVertexGetAlpha , RwIm2DVertexSetIntRGBA

void RwIm2DVertexSetRecipCameraZ (  RwIm2DVertex *    vertex,
RwReal    reciprocalZ
) 
 

RwIm2DVertexSetRecipCameraZ is used to define the reciprocal of the camera z-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
reciprocalZ  An RwReal value equal to the reciprocal camera z-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetCameraX , RwIm2DVertexSetCameraY , RwIm2DVertexSetCameraZ , RwIm2DVertexGetCameraX , RwIm2DVertexGetCameraY , RwIm2DVertexGetCameraZ , RwIm2DVertexGetRecipCameraZ

void RwIm2DVertexSetScreenX (  RwIm2DVertex *    vertex,
RwReal    screenX
) 
 

RwIm2DVertexSetScreenX is used to define the screen x-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
screenX  An RwReal value equal to the screen x-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetScreenY , RwIm2DVertexSetScreenZ , RwIm2DVertexGetScreenX , RwIm2DVertexGetScreenY , RwIm2DVertexGetScreenZ

void RwIm2DVertexSetScreenY (  RwIm2DVertex *    vertex,
RwReal    screenY
) 
 

RwIm2DVertexSetScreenY is used to define the screen y-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
screenY  An RwReal value equal to the screen y-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetScreenX , RwIm2DVertexSetScreenZ , RwIm2DVertexGetScreenX , RwIm2DVertexGetScreenY , RwIm2DVertexGetScreenZ

void RwIm2DVertexSetScreenZ (  RwIm2DVertex *    vertex,
RwReal    screenZ
) 
 

RwIm2DVertexSetScreenZ is used to define the screen z-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
screenZ  An RwReal value equal to the screen z-coordinate.
Returns:
None.
See also:
RwIm2DVertexSetScreenX , RwIm2DVertexSetScreenY , RwIm2DVertexGetScreenX , RwIm2DVertexGetScreenY , RwIm2DVertexGetScreenZ

void RwIm2DVertexSetU (  RwIm2DVertex *    vertex,
RwReal    u,
RwReal    reciprocalZ
) 
 

RwIm2DVertexSetU is used to define the texture u-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
u  An RwReal value equal to the texture u-coordinate
reciprocalZ  An RwReal value equal to the reciprocal z-coordinate (for perspective correction purposes).
Returns:
None.
See also:
RwIm2DVertexSetV , RwIm2DVertexGetU , RwIm2DVertexGetV

void RwIm2DVertexSetV (  RwIm2DVertex *    vertex,
RwReal    v,
RwReal    reciprocalZ
) 
 

RwIm2DVertexSetV is used to define the texture v-coordinate of the specified device vertex.

Parameters:
vertex  A pointer to the device vertex
v  An RwReal value equal to the texture v-coordinate
reciprocalZ  An RwReal value equal to the reciprocal z-coordinate (for perspective correction purposes).
Returns:
None.
See also:
RwIm2DVertexSetU , RwIm2DVertexGetU , RwIm2DVertexGetV

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