OpenSceneGraph/doc/doc++/osg/UByte4.html
2002-07-18 19:54:11 +00:00

219 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class osg::UByte4</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">osg::UByte4</A></H2></H2><BLOCKQUOTE>General purpose float quad, uses include representation of colour coordinates.</BLOCKQUOTE>
<HR>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned char <B><A HREF="#DOC.2.133.3">_v</A></B>[4]
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.133.1">UByte4</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.133.2">UByte4</A></B>(unsigned char <!1><A HREF="UByte4.html#DOC.2.133.12">r</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.13">g</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.14">b</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.15">a</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.133.4">operator == </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; v) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.133.5">operator != </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; v) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.133.6">operator < </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; v) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char* <B><A HREF="#DOC.2.133.7">ptr</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const unsigned char* <B><A HREF="#DOC.2.133.8">ptr</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.133.9">set</A></B>(unsigned char <!1><A HREF="UByte4.html#DOC.2.133.12">r</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.13">g</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.14">b</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.15">a</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char&amp; <B><A HREF="#DOC.2.133.10">operator [] </A></B>(const int i)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char <B><A HREF="#DOC.2.133.11">operator [] </A></B>(const int i) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char&amp; <B><A HREF="#DOC.2.133.12">r</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char&amp; <B><A HREF="#DOC.2.133.13">g</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char&amp; <B><A HREF="#DOC.2.133.14">b</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char&amp; <B><A HREF="#DOC.2.133.15">a</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char <B><A HREF="#DOC.2.133.16">r</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char <B><A HREF="#DOC.2.133.17">g</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char <B><A HREF="#DOC.2.133.18">b</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned char <B><A HREF="#DOC.2.133.19">a</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A> <B><A HREF="#DOC.2.133.20">operator * </A></B>(const float rhs) const
<DD><I>multiply by scalar</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; <B><A HREF="#DOC.2.133.21">operator *= </A></B>(const float rhs)
<DD><I>unary multiply by scalar</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A> <B><A HREF="#DOC.2.133.22">operator / </A></B>(const float rhs) const
<DD><I>divide by scalar</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; <B><A HREF="#DOC.2.133.23">operator /= </A></B>(const float rhs)
<DD><I>unary divide by scalar</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A> <B><A HREF="#DOC.2.133.24">operator + </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs) const
<DD><I>binary vector add</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; <B><A HREF="#DOC.2.133.25">operator += </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs)
<DD><I>unary vector add.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A> <B><A HREF="#DOC.2.133.26">operator - </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs) const
<DD><I>binary vector subtract</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; <B><A HREF="#DOC.2.133.27">operator -= </A></B>(const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs)
<DD><I>unary vector subtract</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>General purpose float quad, uses include representation
of colour coordinates.
No support yet added for float * UByte4 - is it necessary?
Need to define a non-member non-friend operator* etc.
UByte4 * float is okay</BLOCKQUOTE>
<DL>
<A NAME="UByte4"></A>
<A NAME="DOC.2.133.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> UByte4()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="UByte4"></A>
<A NAME="DOC.2.133.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> UByte4(unsigned char <!1><A HREF="UByte4.html#DOC.2.133.12">r</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.13">g</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.14">b</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.15">a</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_v"></A>
<A NAME="DOC.2.133.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned char _v[4]</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator == "></A>
<A NAME="DOC.2.133.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool operator == (const <!1><A HREF="UByte4.html">UByte4</A>&amp; v) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator != "></A>
<A NAME="DOC.2.133.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool operator != (const <!1><A HREF="UByte4.html">UByte4</A>&amp; v) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator < "></A>
<A NAME="DOC.2.133.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool operator < (const <!1><A HREF="UByte4.html">UByte4</A>&amp; v) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="ptr"></A>
<A NAME="DOC.2.133.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char* ptr()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ptr"></A>
<A NAME="DOC.2.133.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const unsigned char* ptr() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.2.133.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void set(unsigned char <!1><A HREF="UByte4.html#DOC.2.133.12">r</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.13">g</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.14">b</A>, unsigned char <!1><A HREF="UByte4.html#DOC.2.133.15">a</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator [] "></A>
<A NAME="DOC.2.133.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char&amp; operator [] (const int i)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator [] "></A>
<A NAME="DOC.2.133.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char operator [] (const int i) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="r"></A>
<A NAME="DOC.2.133.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char&amp; r()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="g"></A>
<A NAME="DOC.2.133.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char&amp; g()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="b"></A>
<A NAME="DOC.2.133.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char&amp; b()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="a"></A>
<A NAME="DOC.2.133.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char&amp; a()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="r"></A>
<A NAME="DOC.2.133.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char r() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="g"></A>
<A NAME="DOC.2.133.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char g() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="b"></A>
<A NAME="DOC.2.133.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char b() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="a"></A>
<A NAME="DOC.2.133.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned char a() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator * "></A>
<A NAME="DOC.2.133.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A> operator * (const float rhs) const </B></TT>
<DD>multiply by scalar
<DL><DT><DD></DL><P>
<A NAME="operator *= "></A>
<A NAME="DOC.2.133.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; operator *= (const float rhs)</B></TT>
<DD>unary multiply by scalar
<DL><DT><DD></DL><P>
<A NAME="operator / "></A>
<A NAME="DOC.2.133.22"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A> operator / (const float rhs) const </B></TT>
<DD>divide by scalar
<DL><DT><DD></DL><P>
<A NAME="operator /= "></A>
<A NAME="DOC.2.133.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; operator /= (const float rhs)</B></TT>
<DD>unary divide by scalar
<DL><DT><DD></DL><P>
<A NAME="operator + "></A>
<A NAME="DOC.2.133.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A> operator + (const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs) const </B></TT>
<DD>binary vector add
<DL><DT><DD></DL><P>
<A NAME="operator += "></A>
<A NAME="DOC.2.133.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; operator += (const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs)</B></TT>
<DD>unary vector add. Slightly more efficient because no temporary
intermediate object
<DL><DT><DD></DL><P>
<A NAME="operator - "></A>
<A NAME="DOC.2.133.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A> operator - (const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs) const </B></TT>
<DD>binary vector subtract
<DL><DT><DD></DL><P>
<A NAME="operator -= "></A>
<A NAME="DOC.2.133.27"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="UByte4.html">UByte4</A>&amp; operator -= (const <!1><A HREF="UByte4.html">UByte4</A>&amp; rhs)</B></TT>
<DD>unary vector subtract
<DL><DT><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></DL>
<DL><DT><DT><B>Friends:</B><DD> inline std::ostream& operator << (std::ostream& output, const <!1><A HREF="UByte4.html">UByte4</A>& vec)<BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>