XSI::CVertexColor

CVertexColor Struct Reference

Supported Parameter List: vertexcolor

This structure represents a vertex RGBA color. Unlike CColor, each component value of CVertexColor is a byte. More...

#include <xsi_vertexcolor.h>

List of all members.

Public Member Functions
  CVertexColor ()
  CVertexColor (const CVertexColor &in_color)
  CVertexColor (unsigned char in_rc, unsigned char in_gc, unsigned char in_bc, unsigned char in_ac)
bool  operator== (const CVertexColor &in_vertexcolor) const
bool  operator!= (const CVertexColor &in_vertexcolor) const

Public Attributes
unsigned char  r
unsigned char  g
unsigned char  b
unsigned char  a

Detailed Description

This structure represents a vertex RGBA color. Unlike CColor, each component value of CVertexColor is a byte.

CVertexColor can be created from Triangle and TriangleVertex objects.

See also:
CVertexColorArray

Constructor & Destructor Documentation

CVertexColor (  )  [inline]

Default constructor.

CVertexColor ( const CVertexColor &  in_color  )  [inline]

Copy constructor.

Parameters:
in_color  Constant CColor object

CVertexColor ( unsigned char  in_rc,
unsigned char  in_gc,
unsigned char  in_bc,
unsigned char  in_ac  
) [inline]

Constructor. Creates a CVertexColor object from r,g,b,a values.

Parameters:
in_rc  Red component value.
in_gc  Green component value.
in_bc  Blue component value.
in_ac  Alpha component value.

Member Function Documentation

bool operator== ( const CVertexColor &  in_vertexcolor  )  const [inline]

Equality operator.

Parameters:
in_vertexcolor  CVertexColor to compare with.
Returns:
true if they are equal; false if they are not equal.

bool operator!= ( const CVertexColor &  in_vertexcolor  )  const [inline]

Inequality operator.

Parameters:
in_vertexcolor  CVertexColor to compare with.
Returns:
true if they are not equal; false if they are equal.

Member Data Documentation

unsigned char r

Red component value

unsigned char g

Green component value

unsigned char b

Blue component value

unsigned char a

Alpha component value

The documentation for this struct was generated from the following file: