Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages
kino::basic_rgba

kino::basic_rgba< SampleType, SampleTraits > Class Template Reference

Encapsulates storage for an RGBA color sample. More...

#include <kino_plugin_types.h>

Collaboration diagram for kino::basic_rgba< SampleType, SampleTraits >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef SampleType sample_type
typedef SampleTraits sample_traits
typedef basic_rgba< sample_type,
sample_traits > 		this_type

Public Member Functions

 basic_rgba ()
 Default constructor sets all samples to zero.
 basic_rgba (const sample_type Red, const sample_type Green, const sample_type Blue)
 Constructor that takes red, green, and blue samples, and sets alpha opaque.
 basic_rgba (const sample_type Red, const sample_type Green, const sample_type Blue, const sample_type Alpha)
 Constructor that takes red, green, blue, and alpha samples.
template<typename ForeignType, typename ForeignTraits>
 basic_rgba (const basic_luma< ForeignType, ForeignTraits > &RHS)
template<typename ForeignType, typename ForeignTraits>
 basic_rgba (const basic_rgb< ForeignType, ForeignTraits > &RHS)
template<typename ForeignType, typename ForeignTraits>
 basic_rgba (const basic_rgba< ForeignType, ForeignTraits > &RHS)

Public Attributes

sample_type red
sample_type green
sample_type blue
sample_type alpha

Friends

std::ostream & operator<< (std::ostream &Stream, const basic_rgba< sample_type, sample_traits > &RHS)
 Serialization.
std::istream & operator>> (std::istream &Stream, basic_rgba< sample_type, sample_traits > &RHS)
 Deserialization.

Detailed Description

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
class kino::basic_rgba< SampleType, SampleTraits >

Encapsulates storage for an RGBA color sample.

Definition at line 442 of file kino_plugin_types.h.

Member Typedef Documentation

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
typedef SampleTraits kino::basic_rgba< SampleType, SampleTraits >::sample_traits
 

Definition at line 446 of file kino_plugin_types.h.

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
typedef SampleType kino::basic_rgba< SampleType, SampleTraits >::sample_type
 

Definition at line 445 of file kino_plugin_types.h.

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
typedef basic_rgba<sample_type, sample_traits> kino::basic_rgba< SampleType, SampleTraits >::this_type
 

Definition at line 447 of file kino_plugin_types.h.

Constructor & Destructor Documentation

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
kino::basic_rgba< SampleType, SampleTraits >::basic_rgba (   )  [inline]
 

Default constructor sets all samples to zero.

Definition at line 450 of file kino_plugin_types.h.

00450                  :
00451         red(sample_traits::minimum()),
00452         green(sample_traits::minimum()),
00453         blue(sample_traits::minimum()),
00454         alpha(sample_traits::opaque())
00455     {
00456     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
kino::basic_rgba< SampleType, SampleTraits >::basic_rgba (  const sample_type  Red,
const sample_type  Green,
const sample_type  Blue
)  [inline]
 

Constructor that takes red, green, and blue samples, and sets alpha opaque.

Definition at line 459 of file kino_plugin_types.h.

00459                                                                                        :
00460         red(Red),
00461         green(Green),
00462         blue(Blue),
00463         alpha(sample_traits::opaque())
00464     {
00465     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
kino::basic_rgba< SampleType, SampleTraits >::basic_rgba (  const sample_type  Red,
const sample_type  Green,
const sample_type  Blue,
const sample_type  Alpha
)  [inline]
 

Constructor that takes red, green, blue, and alpha samples.

Definition at line 468 of file kino_plugin_types.h.

00468                                                                                                                 :
00469         red(Red),
00470         green(Green),
00471         blue(Blue),
00472         alpha(Alpha)
00473     {
00474     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
template<typename ForeignType, typename ForeignTraits>
kino::basic_rgba< SampleType, SampleTraits >::basic_rgba (  const basic_luma< ForeignType, ForeignTraits > &  RHS  )  [inline]
 

Definition at line 477 of file kino_plugin_types.h.

00477                                                                   :
00478         red(sample_traits::convert(RHS.luma)),
00479         green(sample_traits::convert(RHS.luma)),
00480         blue(sample_traits::convert(RHS.luma)),
00481         alpha(sample_traits::opaque())
00482     {
00483     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
template<typename ForeignType, typename ForeignTraits>
kino::basic_rgba< SampleType, SampleTraits >::basic_rgba (  const basic_rgb< ForeignType, ForeignTraits > &  RHS  )  [inline]
 

Definition at line 486 of file kino_plugin_types.h.

00486                                                                  :
00487         red(sample_traits::convert(RHS.red)),
00488         green(sample_traits::convert(RHS.green)),
00489         blue(sample_traits::convert(RHS.blue)),
00490         alpha(sample_traits::opaque())
00491     {
00492     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
template<typename ForeignType, typename ForeignTraits>
kino::basic_rgba< SampleType, SampleTraits >::basic_rgba (  const basic_rgba< ForeignType, ForeignTraits > &  RHS  )  [inline]
 

Definition at line 495 of file kino_plugin_types.h.

00495                                                                   :
00496         red(sample_traits::convert(RHS.red)),
00497         green(sample_traits::convert(RHS.green)),
00498         blue(sample_traits::convert(RHS.blue)),
00499         alpha(sample_traits::convert(RHS.alpha))
00500     {
00501     }

Friends And Related Function Documentation

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
std::ostream& operator<< (  std::ostream &  Stream,
const basic_rgba< sample_type, sample_traits > &  RHS
)  [friend]
 

Serialization.

Definition at line 504 of file kino_plugin_types.h.

00505     {
00506         Stream << RHS.red << " " << RHS.green << " " << RHS.blue << " " << RHS.alpha;
00507         return Stream;
00508     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
std::istream& operator>> (  std::istream &  Stream,
basic_rgba< sample_type, sample_traits > &  RHS
)  [friend]
 

Deserialization.

Definition at line 511 of file kino_plugin_types.h.

00512     {
00513         Stream >> RHS.red >> RHS.green >> RHS.blue >> RHS.alpha;
00514         return Stream;
00515     }

Member Data Documentation

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
sample_type kino::basic_rgba< SampleType, SampleTraits >::alpha
 

Definition at line 520 of file kino_plugin_types.h.

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
sample_type kino::basic_rgba< SampleType, SampleTraits >::blue
 

Definition at line 519 of file kino_plugin_types.h.

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
sample_type kino::basic_rgba< SampleType, SampleTraits >::green
 

Definition at line 518 of file kino_plugin_types.h.

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
sample_type kino::basic_rgba< SampleType, SampleTraits >::red
 

Definition at line 517 of file kino_plugin_types.h.

The documentation for this class was generated from the following file:
Generated on Sun Mar 11 22:13:29 2007 for Kino by  doxygen 1.4.2