kino::color_traits< uint8_t > Class Template Reference

Specialization of color_traits for uint8_t samples. More...

#include <kino_plugin_types.h>

List of all members.

Public Types
typedef uint8_t	sample_type
	Defines the sample type for this specialization.
Static Public Member Functions
static sample_type	minimum ()
	Returns the minimum value of a sample.
static sample_type	maximum ()
	Returns the maximum 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.
static sample_type	convert (const sample_type Sample)
	Converts a sample from a uint8_t.
static sample_type	convert (const double Sample)
	Converts a sample from a double.

---

Detailed Description

template<>
class kino::color_traits< uint8_t >

Specialization of color_traits for uint8_t samples.

Definition at line 95 of file kino_plugin_types.h.

---

Member Typedef Documentation

typedef uint8_t kino::color_traits< uint8_t >::sample_type

Defines the sample type for this specialization. Definition at line 99 of file kino_plugin_types.h.

---

Member Function Documentation

static sample_type kino::color_traits< uint8_t >::convert (  const double  Sample  )  [inline, static]

Converts a sample from a double. Definition at line 115 of file kino_plugin_types.h. References kino::clamp(), and kino::color_traits< SampleType >::maximum(). { return static_cast<uint8_t>(clamp(Sample, 0.0, 1.0) * maximum()); }

static sample_type kino::color_traits< uint8_t >::convert (  const sample_type  Sample  )  [inline, static]

Converts a sample from a uint8_t. Definition at line 113 of file kino_plugin_types.h. { return Sample; }

static sample_type kino::color_traits< uint8_t >::invert (  const sample_type &  Sample  )  [inline, static]

Inverts the value of a sample. Definition at line 110 of file kino_plugin_types.h. References kino::color_traits< SampleType >::maximum(). { return maximum() - Sample; }

static sample_type kino::color_traits< uint8_t >::maximum (   )  [inline, static]

Returns the maximum value of a sample. Definition at line 104 of file kino_plugin_types.h. { return 255; }

static sample_type kino::color_traits< uint8_t >::minimum (   )  [inline, static]

Returns the minimum value of a sample. Definition at line 102 of file kino_plugin_types.h. { return 0; }

static sample_type kino::color_traits< uint8_t >::opaque (   )  [inline, static]

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

static sample_type kino::color_traits< uint8_t >::transparent (   )  [inline, static]

Returns the sample value corresponding to transparent alpha. Definition at line 106 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

---