kino::color_traits< SampleType > Class Template Reference

Describes traits of a type used as a sample within a color specification. More...

#include <kino_plugin_types.h>

List of all members.

Public Types
typedef SampleType	sample_type
Static Public Member Functions
static sample_type	minimum ()
	Returns the maximum value of a sample.
static sample_type	maximum ()
	Returns the minimum value of a sample.
static sample_type	transparent ()
	Returns the sample value corresponding to transparent alpha.
static sample_type	opaque ()
	Returns the sample value corresponding to opaque alpha.
static sample_type	invert (const sample_type &Sample)
	Inverts the value of a sample.

---

Detailed Description

template<typename SampleType>
class kino::color_traits< SampleType >

Describes traits of a type used as a sample within a color specification.

Definition at line 73 of file kino_plugin_types.h.

---

Member Typedef Documentation

template<typename SampleType> typedef SampleType kino::color_traits< SampleType >::sample_type

Definition at line 76 of file kino_plugin_types.h.

---

Member Function Documentation

template<typename SampleType> static sample_type kino::color_traits< SampleType >::invert (  const sample_type &  Sample  )  [static]

Inverts the value of a sample.

template<typename SampleType> static sample_type kino::color_traits< SampleType >::maximum (   )  [static]

Returns the minimum value of a sample. Referenced by kino::color_traits< uint8_t >::convert(), kino::color_traits< double >::invert(), kino::color_traits< uint8_t >::invert(), kino::color_traits< double >::opaque(), kino::color_traits< uint8_t >::opaque(), and kino::color_traits< SampleType >::opaque().

template<typename SampleType> static sample_type kino::color_traits< SampleType >::minimum (   )  [static]

Returns the maximum value of a sample. Referenced by kino::basic_hsv::basic_hsv(), kino::color_traits< double >::transparent(), kino::color_traits< uint8_t >::transparent(), and kino::color_traits< SampleType >::transparent().

template<typename SampleType> static sample_type kino::color_traits< SampleType >::opaque (   )  [inline, static]

Returns the sample value corresponding to opaque alpha. Definition at line 85 of file kino_plugin_types.h. References kino::color_traits< SampleType >::maximum(). { return maximum(); }

template<typename SampleType> static sample_type kino::color_traits< SampleType >::transparent (   )  [inline, static]

Returns the sample value corresponding to transparent alpha. Definition at line 83 of file kino_plugin_types.h. References kino::color_traits< SampleType >::minimum(). { return minimum(); }

---

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

• kino_plugin_types.h

---