Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RwCameraVertex
[Immediate Mode]


Functions

RwInt32 RwCameraVertexGetQuantity (void)
RwCameraVertex * RwCameraVertexGet (RwInt32 index)
RwCameraVertex * RwCameraVertexGetNext (RwCameraVertex *vertex)
RwUInt8 RwCameraVertexGetClipFlags (RwCameraVertex *vertex)
void RwCameraVertexSetCameraPos (RwCameraVertex *vertex, RwV3d *pos)
RwV3d * RwCameraVertexGetCameraPos (RwCameraVertex *vertex)
void RwCameraVertexSetU (RwCameraVertex *vertex, RwReal u)
RwReal RwCameraVertexGetU (RwCameraVertex *vertex)
void RwCameraVertexSetV (RwCameraVertex *vertex, RwReal v)
RwReal RwCameraVertexGetV (RwCameraVertex *vertex)
void RwCameraVertexSetRGBA (RwCameraVertex *vertex, RwReal red, RwReal green, RwReal blue, RwReal alpha)
void RwCameraVertexAddRGBA (RwCameraVertex *vertex, RwReal red, RwReal green, RwReal blue, RwReal alpha)
RwRGBAReal * RwCameraVertexGetRGBA (RwCameraVertex *vertex)

Detailed Description

Camera space vertex data access

RwCameraVertex Overview

Requirements

Overview

An array of Camera Vertices is generated by the rendering pipeline's transformation and lighting stages. They represent the final, transformed vertices that are sent to the 3D graphics hardware. On platforms with software transform and lighting pipelines, the RwCameraVertex API provides a mechanism for accessing these vertices.

ClipFlags

Although the 'ClipFlags' datatype itself is not exposed, the RwCameraVertexGetClipFlags() function can be used as a simple boolean test to check if a vertex has been clipped. If the value returned is zero, the vertex is not clipped.

Warning:
The RwCameraVertex API should NOT be used on platforms that support hardware transform and lighting.

Function Documentation

void RwCameraVertexAddRGBA (  RwCameraVertex *    vertex,
RwReal    red,
RwReal    green,
RwReal    blue,
RwReal    alpha
) 
 

RwCameraVertexAddRGBA is used to increment the RGBA color of the specified camera vertex by the given components.

Parameters:
vertex  A pointer to the camera vertex
red  An RwReal value equal to the red component
green  An RwReal value equal to the green component
blue  An RwReal value equal to the blue component
alpha  An RwReal value equal to the alpha component.
Returns:
None.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexGetRGBA

RwCameraVertex* RwCameraVertexGet (  RwInt32    index ) 
 

RwCameraVertexGet is used to retrieve the camera vertex corresponding to the given array index.

Parameters:
index  An RwInt32 value equal to the index of the camera vertex.
Returns:
Returns a pointer to the camera vertex.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

RwV3d* RwCameraVertexGetCameraPos (  RwCameraVertex *    vertex ) 
 

RwCameraVertexGetCameraPos is used to retrieve the camera space position of the specified camera vertex.

Parameters:
vertex  A pointer to a camera vertex.
Returns:
Returns a pointer to an RwV3d value equal to the camera space position of the vertex.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

RwUInt8 RwCameraVertexGetClipFlags (  RwCameraVertex *    vertex ) 
 

RwCameraVertexGetClipFlags is used to retrieve the view frustum clip flags for the specified camera vertex. Note the clip flags are only valid after passing through the transform stage of the rendering pipeline. The clip flags are returned packed into an RwUInt8 value.

Parameters:
vertex  A pointer to the camera vertex.
Returns:
Returns an RwUInt8 value equal to the view frustum clip flags of the camera vertex.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

RwCameraVertex* RwCameraVertexGetNext (  RwCameraVertex *    vertex ) 
 

RwCameraVertexGetNext is used to retrieve the next vertex following the specified one in the array of camera vertices.

Parameters:
vertex  A pointer to the camera vertex.
Returns:
Returns a pointer to the next camera vertex.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

RwInt32 RwCameraVertexGetQuantity (  void    ) 
 

RwCameraVertexGetQuantity is used to determine the number of camera vertices produced as a result of executing the rendering pipeline.

Returns:
Returns an RwInt32 value equal to the number of camera vertices.
See also:
RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

RwRGBAReal* RwCameraVertexGetRGBA (  RwCameraVertex *    vertex ) 
 

RwCameraVertexGetRGBA is used to retrieve the color of the specified camera vertex.

Parameters:
vertex  A pointer to the camera vertex.
Returns:
Returns a pointer to an RwRGBAReal value equal to the color of the vertex.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA

RwReal RwCameraVertexGetU (  RwCameraVertex *    vertex ) 
 

RwCameraVertexGetU is used to retrieve the texture u-coordinate of the specified camera vertex.

Parameters:
vertex  A pointer to the camera vertex.
Returns:
Returns an RwReal value equal to the texture u-coordinate.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

RwReal RwCameraVertexGetV (  RwCameraVertex *    vertex ) 
 

RwCameraVertexGetV is used to retrieve the texture v-coordinate of the specified camera vertex.

Parameters:
vertex  A pointer to the camera vertex.
Returns:
Returns an RwReal value equal to the texture v-coordinate.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

void RwCameraVertexSetCameraPos (  RwCameraVertex *    vertex,
RwV3d *    pos
) 
 

RwCameraVertexSetCameraPos is used to define the camera space position of the specified camera vertex.

Parameters:
vertex  A pointer to the camera vertex
pos  A pointer to an RwV3d value equal to the vertex camera position.
Returns:
None.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

void RwCameraVertexSetRGBA (  RwCameraVertex *    vertex,
RwReal    red,
RwReal    green,
RwReal    blue,
RwReal    alpha
) 
 

RwCameraVertexSetRGBA is used to define the RGBA color of the specified camera vertex.

Parameters:
vertex  A pointer to the camera 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:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

void RwCameraVertexSetU (  RwCameraVertex *    vertex,
RwReal    u
) 
 

RwCameraVertexSetU is used to define the texture u-coordinate of the specified camera vertex.

Parameters:
vertex  A pointer to the camera vertex
u  An RwReal value equal to the texture u-coordinate.
Returns:
None.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexGetU , RwCameraVertexSetV , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

void RwCameraVertexSetV (  RwCameraVertex *    vertex,
RwReal    v
) 
 

RwCameraVertexSetV is used to define the texture v-coordinate of the specified camera vertex.

Parameters:
vertex  A pointer to the camera vertex
v  An RwReal value equal to the texture v-coordinate.
Returns:
None.
See also:
RwCameraVertexGetQuantity , RwCameraVertexGet , RwCameraVertexGetNext , RwCameraVertexGetClipFlags , RwCameraVertexSetCameraPos , RwCameraVertexGetCameraPos , RwCameraVertexSetU , RwCameraVertexGetU , RwCameraVertexGetV , RwCameraVertexSetRGBA , RwCameraVertexAddRGBA , RwCameraVertexGetRGBA

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