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

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

Encapsulates storage for a luma color sample. More...

#include <kino_plugin_types.h>

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

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Member Functions

 basic_luma ()
 Default constructor sets all samples to zero.
 basic_luma (const sample_type Luma)
 Straightforward constructor that initializes samples.
template<typename ForeignType, typename ForeignTraits>
 basic_luma (const basic_luma< ForeignType, ForeignTraits > &RHS)
template<typename ForeignType, typename ForeignTraits>
 basic_luma (const basic_rgb< ForeignType, ForeignTraits > &RHS)
template<typename ForeignType, typename ForeignTraits>
 basic_luma (const basic_rgba< ForeignType, ForeignTraits > &RHS)
 basic_luma (const basic_hsv &RHS)

Public Attributes

sample_type luma
sample_type alpha

Friends

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

Detailed Description

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

Encapsulates storage for a luma color sample.

Definition at line 251 of file kino_plugin_types.h.

Member Typedef Documentation

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

Definition at line 255 of file kino_plugin_types.h.

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

Definition at line 254 of file kino_plugin_types.h.

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

Definition at line 256 of file kino_plugin_types.h.

Constructor & Destructor Documentation

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

Default constructor sets all samples to zero.

Definition at line 259 of file kino_plugin_types.h.

00259                  :
00260         luma(sample_traits::minimum()),
00261         alpha(sample_traits::opaque())
00262     {
00263     }

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
kino::basic_luma< SampleType, SampleTraits >::basic_luma (  const sample_type  Luma  )  [inline]
 

Straightforward constructor that initializes samples.

Definition at line 266 of file kino_plugin_types.h.

00266                                        :
00267         luma(Luma)
00268     {
00269     }

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

Definition at line 272 of file kino_plugin_types.h.

00272                                                                   :
00273         luma(sample_traits::convert(RHS.luma))
00274     {
00275     }

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

Definition at line 278 of file kino_plugin_types.h.

00278                                                                  :
00279         luma(sample_traits::convert(std::max(RHS.red, std::max(RHS.green, RHS.blue))))
00280     {
00281     }

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

Definition at line 284 of file kino_plugin_types.h.

00284                                                                   :
00285         luma(sample_traits::convert(std::max(RHS.red, std::max(RHS.green, RHS.blue))))
00286     {
00287     }

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

Definition at line 289 of file kino_plugin_types.h.

00289                                      :
00290         luma(sample_traits::convert(RHS.value))
00291     {
00292     }

Friends And Related Function Documentation

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

Serialization.

Definition at line 295 of file kino_plugin_types.h.

00296     {
00297         Stream << RHS.luma;
00298         return Stream;
00299     }

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

Deserialization.

Definition at line 302 of file kino_plugin_types.h.

00303     {
00304         Stream >> RHS.luma;
00305         return Stream;
00306     }

Member Data Documentation

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

Definition at line 309 of file kino_plugin_types.h.

template<typename SampleType, typename SampleTraits = color_traits<SampleType>>
sample_type kino::basic_luma< SampleType, SampleTraits >::luma
 

Definition at line 308 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