OGLplus  (0.59.0) a C++ wrapper for rendering APIs

AL API wrappers

Classes

class  eagine::oalp::basic_al_operations< ApiTraits >
 Class wrapping the functions from the AL API. More...
 
class  eagine::oalp::al_api_traits
 Policy customizing the generic C-API wrappers for the AL API. More...
 
class  eagine::oalp::basic_al_c_api< ApiTraits >
 Class wrapping the C-functions from the AL API. More...
 
struct  eagine::oalp::al_types
 Collection of aliases for AL types. More...
 
class  eagine::oalp::basic_al_constants< ApiTraits >
 Class wrapping the constants from the AL API. More...
 
struct  eagine::oalp::al_error_code
 Typed enumeration for AL error code constants. More...
 
struct  eagine::oalp::al_capability
 Typed enumeration for AL capability constants. More...
 
struct  eagine::oalp::al_boolean_query
 Typed enumeration for AL boolean query constants. More...
 
struct  eagine::oalp::al_integer_query
 Typed enumeration for AL integer query constants. More...
 
struct  eagine::oalp::al_numeric_query
 Typed enumeration for AL numeric query constants. More...
 
struct  eagine::oalp::al_string_query
 Typed enumeration for AL string query constants. More...
 
struct  eagine::oalp::distance_model
 Typed enumeration for AL distance model constants. More...
 
struct  eagine::oalp::listener_attribute
 Typed enumeration for AL listener attribute constants. More...
 
struct  eagine::oalp::buffer_attribute
 Typed enumeration for AL buffer attribute constants. More...
 
struct  eagine::oalp::buffer_format
 Typed enumeration for AL buffer format constants. More...
 
struct  eagine::oalp::source_attribute
 Typed enumeration for AL source attribute constants. More...
 
struct  eagine::oalp::source_state
 Typed enumeration for AL source state constants. More...
 
struct  eagine::oalp::source_type
 Typed enumeration for AL source type constants. More...
 
class  eagine::oalp::al_no_result_info
 Class storing information about call result for unavailable AL functions. More...
 
class  eagine::oalp::al_result_info
 Class storing information about an AL function call result. More...
 
class  eagine::oalp::basic_alc_operations< ApiTraits >
 Class wrapping the functions from the ALC API. More...
 
class  eagine::oalp::alc_api_traits
 Policy customizing the generic C-API wrappers for the ALC API. More...
 
class  eagine::oalp::basic_alc_c_api< ApiTraits >
 Class wrapping the C-functions from the ALC API. More...
 
struct  eagine::oalp::alc_types
 Collection of aliases for ALC types. More...
 
class  eagine::oalp::basic_alc_constants< ApiTraits >
 Class wrapping the constants from the ALC API. More...
 
struct  eagine::oalp::alc_error_code
 Typed enumeration for ALC error code constants. More...
 
struct  eagine::oalp::context_attribute
 Typed enumeration for ALC context attribute constants. More...
 
struct  eagine::oalp::alc_string_query
 Typed enumeration for ALC string query constants. More...
 
struct  eagine::oalp::alc_integer_query
 Typed enumeration for ALC integer query constants. More...
 
class  eagine::oalp::alc_no_result_info
 Class storing information about call result for unavailable ALC functions. More...
 
class  eagine::oalp::alc_result_info
 Class storing information about an ALC function call result. More...
 
class  eagine::oalp::basic_alut_operations< ApiTraits >
 Class wrapping the functions from the ALUT API. More...
 
class  eagine::oalp::alut_api_traits
 Policy customizing the generic C-API wrappers for the ALUT API. More...
 
class  eagine::oalp::basic_alut_c_api< ApiTraits >
 Class wrapping the C-functions from the ALUT API. More...
 
struct  eagine::oalp::alut_types
 Collection of aliases for ALUT types. More...
 
class  eagine::oalp::basic_alut_constants< ApiTraits >
 Class wrapping the constants from the ALUT API. More...
 
struct  eagine::oalp::alut_error_code
 Typed enumeration for ALUT error code constants. More...
 
struct  eagine::oalp::waveform_function
 Typed enumeration for ALUT waveform function constants. More...
 

Typedefs

using eagine::oalp::al_c_api = basic_al_c_api< al_api_traits >
 Alias for the default AL operations wrapper instantiation.
 
template<typename Self , identifier_t Id>
using eagine::oalp::al_enum_class = enum_class< Self, al_types::enum_type, EAGINE_ID_V(AL), Id >
 Typed wrapper class for AL enum constants/values. More...
 
using eagine::oalp::al_any_enum_class = any_enum_class< EAGINE_ID_V(AL)>
 Type erasure alias for AL enum classes.
 
using eagine::oalp::al_any_enum_value = any_enum_value< EAGINE_ID_V(AL)>
 Type erasure alias for AL enum values.
 
template<typename Result >
using eagine::oalp::al_no_result = api_no_result< Result, al_no_result_info >
 Alias for always-invalid result of a missing AL API function call. More...
 
template<typename Result >
using eagine::oalp::al_result = api_result< Result, al_result_info >
 Class wrapping the result of an AL API function call. More...
 
template<typename Result >
using eagine::oalp::al_opt_result = api_opt_result< Result, al_result_info >
 Alias for conditionally-valid result of an AL API function call. More...
 
using eagine::oalp::al_api = basic_al_api< al_api_traits >
 Alias for the default instantation of basic_al_api.
 
using eagine::oalp::alc_c_api = basic_alc_c_api< alc_api_traits >
 Alias for the default ALC operations wrapper instantiation.
 
template<typename Self , identifier_t Id>
using eagine::oalp::alc_enum_class = enum_class< Self, alc_types::enum_type, EAGINE_ID_V(ALC), Id >
 Typed wrapper class for ALC enum constants/values. More...
 
using eagine::oalp::alc_any_enum_class = any_enum_class< EAGINE_ID_V(ALC)>
 Type erasure alias for ALC enum classes.
 
using eagine::oalp::alc_any_enum_value = any_enum_value< EAGINE_ID_V(ALC)>
 Type erasure alias for ALC enum values.
 
template<typename Result >
using eagine::oalp::alc_no_result = api_no_result< Result, alc_no_result_info >
 Alias for always-invalid result of a missing ALC API function call. More...
 
template<typename Result >
using eagine::oalp::alc_result = api_result< Result, alc_result_info >
 Class wrapping the result of a ALC API function call. More...
 
template<typename Result >
using eagine::oalp::alc_opt_result = api_opt_result< Result, alc_result_info >
 Class wrapping the result of a ALC API function call. More...
 
using eagine::oalp::alc_api = basic_alc_api< alc_api_traits >
 Alias for the default instantation of basic_alc_api.
 
using eagine::oalp::alut_c_api = basic_alut_c_api< alut_api_traits >
 Alias for the default ALUT operations wrapper instantiation.
 
template<typename Self , identifier_t Id>
using eagine::oalp::alut_enum_class = enum_class< Self, alut_types::enum_type, EAGINE_ID_V(ALUT), Id >
 Typed wrapper class for ALUT enum constants/values. More...
 
using eagine::oalp::alut_any_enum_class = any_enum_class< EAGINE_ID_V(ALUT)>
 Type erasure alias for ALUT enum classes.
 
using eagine::oalp::alut_any_enum_value = any_enum_value< EAGINE_ID_V(ALUT)>
 Type erasure alias for ALUT enum values.
 
template<typename Result >
using eagine::oalp::alut_no_result = api_no_result< Result, alut_no_result_info >
 Alias for always-invalid result of a missing ALUT API function call. More...
 
template<typename Result >
using eagine::oalp::alut_result = api_result< Result, alut_result_info >
 Class wrapping the result of a ALUT API function call. More...
 
template<typename Result >
using eagine::oalp::alut_opt_result = api_opt_result< Result, alut_result_info >
 Class wrapping the result of a ALUT API function call. More...
 
using eagine::oalp::alut_api = basic_alut_api< alut_api_traits >
 Alias for the default instantation of basic_alut_api.
 

Detailed Description

Typedef Documentation

◆ al_enum_class

template<typename Self , identifier_t Id>
using eagine::oalp::al_enum_class = typedef enum_class<Self, al_types::enum_type, EAGINE_ID_V(AL), Id>

Typed wrapper class for AL enum constants/values.

See also
alc_enum_class
alut_enum_class

This wrapper uses the specified Id to group various AL constants logically belonging together and prevents accidental mismatches and use of AL constants from unrelated groups. For example using a source attribute constant in place of listener attribute constants. Such mismatches result in compilation errors.

◆ al_no_result

template<typename Result >
using eagine::oalp::al_no_result = typedef api_no_result<Result, al_no_result_info>

Alias for always-invalid result of a missing AL API function call.

See also
al_result
al_opt_result

◆ al_opt_result

template<typename Result >
using eagine::oalp::al_opt_result = typedef api_opt_result<Result, al_result_info>

Alias for conditionally-valid result of an AL API function call.

See also
al_result
al_opt_result

◆ al_result

template<typename Result >
using eagine::oalp::al_result = typedef api_result<Result, al_result_info>

Class wrapping the result of an AL API function call.

See also
al_no_result
al_opt_result

◆ alc_enum_class

template<typename Self , identifier_t Id>
using eagine::oalp::alc_enum_class = typedef enum_class<Self, alc_types::enum_type, EAGINE_ID_V(ALC), Id>

Typed wrapper class for ALC enum constants/values.

See also
al_enum_class
alut_enum_class

This wrapper uses the specified Id to group various ALC constants logically belonging together and prevents accidental mismatches and use of ALC constants from unrelated groups. For example using a context attribute constant in place of string query constants. Such mismatches result in compilation errors.

◆ alc_no_result

template<typename Result >
using eagine::oalp::alc_no_result = typedef api_no_result<Result, alc_no_result_info>

Alias for always-invalid result of a missing ALC API function call.

See also
al_result
al_opt_result

◆ alc_opt_result

template<typename Result >
using eagine::oalp::alc_opt_result = typedef api_opt_result<Result, alc_result_info>

Class wrapping the result of a ALC API function call.

See also
al_no_result
al_opt_result

◆ alc_result

template<typename Result >
using eagine::oalp::alc_result = typedef api_result<Result, alc_result_info>

Class wrapping the result of a ALC API function call.

See also
al_no_result
al_opt_result

◆ alut_enum_class

template<typename Self , identifier_t Id>
using eagine::oalp::alut_enum_class = typedef enum_class<Self, alut_types::enum_type, EAGINE_ID_V(ALUT), Id>

Typed wrapper class for ALUT enum constants/values.

See also
al_enum_class
alc_enum_class

This wrapper uses the specified Id to group various ALUT constants logically belonging together and prevents accidental mismatches and use of ALUT constants from unrelated groups.

◆ alut_no_result

template<typename Result >
using eagine::oalp::alut_no_result = typedef api_no_result<Result, alut_no_result_info>

Alias for always-invalid result of a missing ALUT API function call.

See also
al_result
al_opt_result

◆ alut_opt_result

template<typename Result >
using eagine::oalp::alut_opt_result = typedef api_opt_result<Result, alut_result_info>

Class wrapping the result of a ALUT API function call.

See also
al_no_result
al_opt_result

◆ alut_result

template<typename Result >
using eagine::oalp::alut_result = typedef api_result<Result, alut_result_info>

Class wrapping the result of a ALUT API function call.

See also
al_no_result
al_opt_result

Copyright © 2015-2021 Matúš Chochlík.
<chochlik -at -gmail.com>
Documentation generated on Tue Apr 13 2021 by Doxygen (version 1.8.17).