psynth::sound::detail::kth_sample_deref_fn< K, SrcP > Struct Template Reference

Function object that returns a grayscale reference of the K-th sample (specified as a template parameter) of a given reference. More...

#include <buffer_range_factory.hpp>

List of all members.

Public Types
typedef kth_sample_deref_fn< K, const_ref_t >	const_type
typedef frame_value_type < sample_t, mono_layout > ::type	value_type
typedef frame_reference_type < sample_t, mono_layout, false, false >::type	const_reference
typedef SrcP	argument_type
typedef boost::mpl::if_c < is_mutable, ref_t, value_type >::type	reference
typedef reference	result_type
Public Member Functions
	BOOST_STATIC_CONSTANT (bool, is_mutable=frame_is_reference< SrcP >::value &&frame_reference_is_mutable< SrcP >::value)
	kth_sample_deref_fn ()
template<typename P >
	kth_sample_deref_fn (const kth_sample_deref_fn< K, P > &)
result_type	operator() (argument_type srcframe) const

---

Detailed Description

template<int K, typename SrcP>
struct psynth::sound::detail::kth_sample_deref_fn< K, SrcP >

Function object that returns a grayscale reference of the K-th sample (specified as a template parameter) of a given reference.

Models: FrameDereferenceAdaptorConcept.

If the input is a frame value or constant reference, the function object is immutable. Otherwise it is mutable (and returns non-const reference to the k-th sample)

---

Member Typedef Documentation

template<int K, typename SrcP >

typedef SrcP psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::argument_type

template<int K, typename SrcP >

typedef frame_reference_type< sample_t, mono_layout,false,false>::type psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::const_reference

template<int K, typename SrcP >

typedef kth_sample_deref_fn<K,const_ref_t> psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::const_type

template<int K, typename SrcP >

typedef boost::mpl::if_c< is_mutable, ref_t, value_type>::type psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::reference

template<int K, typename SrcP >

typedef reference psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::result_type

template<int K, typename SrcP >

typedef frame_value_type< sample_t, mono_layout>::type psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::value_type

---

Constructor & Destructor Documentation

template<int K, typename SrcP >

psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::kth_sample_deref_fn

(

)

[inline]

template<int K, typename SrcP >

template<typename P >

psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::kth_sample_deref_fn

(

const kth_sample_deref_fn< K, P > &

)

[inline]

---

Member Function Documentation

template<int K, typename SrcP >

psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::BOOST_STATIC_CONSTANT	(	bool	,
		is_mutable	= frame_is_reference< SrcP >::value &&frame_reference_is_mutable< SrcP >::value
	)

template<int K, typename SrcP >

result_type psynth::sound::detail::kth_sample_deref_fn< K, SrcP >::operator()

(

argument_type

srcframe

)

const [inline]

---

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

• /home/raskolnikov/dev/psynth/trunk/src/psynth/sound/buffer_range_factory.hpp