OALplus (0.52.0) a C++ wrapper for OpenAL

oalplus::CurrentContext Class Reference

A context that is made current right after construction. More...

#include </home/chochlik/devel/oglplus/include/oalplus/context.hpp>

Inheritance diagram for oalplus::CurrentContext:
Collaboration diagram for oalplus::CurrentContext:

Public Member Functions

 CurrentContext (const Device &device)
 Creates a new context and makes it current. More...
 
 CurrentContext (const Device &device, const FinishedContextAttribs &attribs)
 Creates a new context and makes it current. More...
 
 CurrentContext (CurrentContext &&tmp)
 CurrentContext is move-constructible. More...
 
DeviceOps< tag::Playback > ContextsDevice (void) const
 Returns the device of this context.
 
bool MakeCurrent (void)
 Makes this context current. More...
 
void Process (void)
 Processes this context. More...
 
void Suspend (void)
 Suspends this context. More...
 

Static Public Member Functions

static ContextOps Current (void)
 Returns the current OpenAL context. More...
 
static const ALchar * GetString (StringQuery query)
 Queries a string from the current OpenAL context. More...
 
static const char * Vendor (void)
 Returns the vendor name. More...
 
static const char * Version (void)
 Returns the version string. More...
 
static const char * Renderer (void)
 Returns the renderer name. More...
 
static Range< StringExtensions (void)
 Returns a range of extension strings. More...
 
static void DistanceModel (oalplus::DistanceModel dist_model)
 Sets the distance model to be used by the current context. More...
 
static oalplus::DistanceModel DistanceModel (void)
 Returns the distance model used by the current context. More...
 
static void DopplerFactor (ALfloat doppler_factor)
 Sets the doppler factor for the current context. More...
 
static ALfloat DopplerFactor (void)
 Returns the doppler factor used by the current context. More...
 
static void SpeedOfSound (ALfloat speed_of_sound)
 Sets the value of speed of sound for the current context. More...
 
static ALfloat SpeedOfSound (void)
 Returns the value of speed of sound used by the current context. More...
 

Detailed Description

A context that is made current right after construction.

Examples:
oalplus/001_hello.cpp, oalplus/001_info.cpp, and oalplus/002_hello_path.cpp.

Constructor & Destructor Documentation

oalplus::CurrentContext::CurrentContext ( const Device device)

Creates a new context and makes it current.

Related OpenAL symbols:
alcCreateContext alcMakeContextCurrent

References oalplus::ContextOps::MakeCurrent().

oalplus::CurrentContext::CurrentContext ( const Device device,
const FinishedContextAttribs attribs 
)

Creates a new context and makes it current.

Related OpenAL symbols:
alcCreateContext alcMakeContextCurrent

References oalplus::ContextOps::MakeCurrent().

oalplus::CurrentContext::CurrentContext ( CurrentContext &&  tmp)

CurrentContext is move-constructible.

Related OpenAL symbols:
alcMakeContextCurrent

References oalplus::ContextOps::MakeCurrent().

Member Function Documentation

static ContextOps oalplus::ContextOps::Current ( void  )
staticinherited

Returns the current OpenAL context.

Related OpenAL symbols:
alcGetCurrentContext alcGetContextsDevice
static void oalplus::ContextOps::DistanceModel ( oalplus::DistanceModel  dist_model)
staticinherited

Sets the distance model to be used by the current context.

Related OpenAL symbols:
alDistanceModel

References oalplus::ContextOps::DistanceModel().

static oalplus::DistanceModel oalplus::ContextOps::DistanceModel ( void  )
staticinherited

Returns the distance model used by the current context.

Related OpenAL symbols:
alGetIntegerv AL_DISTANCE_MODEL

Referenced by oalplus::ContextOps::DistanceModel().

static void oalplus::ContextOps::DopplerFactor ( ALfloat  doppler_factor)
staticinherited

Sets the doppler factor for the current context.

Related OpenAL symbols:
alDopplerFactor

References oalplus::ContextOps::DopplerFactor().

static ALfloat oalplus::ContextOps::DopplerFactor ( void  )
staticinherited

Returns the doppler factor used by the current context.

Related OpenAL symbols:
alGetFloatv AL_DOPPLER_FACTOR

Referenced by oalplus::ContextOps::DopplerFactor().

static Range<String> oalplus::ContextOps::Extensions ( void  )
staticinherited

Returns a range of extension strings.

Related OpenAL symbols:
alGetString AL_EXTENSIONS
Examples:
oalplus/001_info.cpp.
static const ALchar* oalplus::ContextOps::GetString ( StringQuery  query)
staticinherited

Queries a string from the current OpenAL context.

Related OpenAL symbols:
alGetString

Referenced by oalplus::ContextOps::Renderer(), oalplus::ContextOps::Vendor(), and oalplus::ContextOps::Version().

bool oalplus::ContextOps::MakeCurrent ( void  )
inherited

Makes this context current.

Related OpenAL symbols:
alcMakeContextCurrent

Referenced by CurrentContext().

void oalplus::ContextOps::Process ( void  )
inherited

Processes this context.

Related OpenAL symbols:
alcProcessContext
static const char* oalplus::ContextOps::Renderer ( void  )
staticinherited

Returns the renderer name.

Related OpenAL symbols:
alGetString AL_RENDERER
Examples:
oalplus/001_info.cpp.

References oalplus::ContextOps::GetString(), and oalplus::Renderer.

static void oalplus::ContextOps::SpeedOfSound ( ALfloat  speed_of_sound)
staticinherited

Sets the value of speed of sound for the current context.

Related OpenAL symbols:
alSpeedOfSound

References oalplus::ContextOps::SpeedOfSound().

static ALfloat oalplus::ContextOps::SpeedOfSound ( void  )
staticinherited

Returns the value of speed of sound used by the current context.

Related OpenAL symbols:
alGetFloatv AL_SPEED_OF_SOUND

Referenced by oalplus::ContextOps::SpeedOfSound().

void oalplus::ContextOps::Suspend ( void  )
inherited

Suspends this context.

Related OpenAL symbols:
alcSuspendContext
static const char* oalplus::ContextOps::Vendor ( void  )
staticinherited

Returns the vendor name.

Related OpenAL symbols:
alGetString AL_VENDOR
Examples:
oalplus/001_info.cpp.

References oalplus::ContextOps::GetString(), and oalplus::Vendor.

static const char* oalplus::ContextOps::Version ( void  )
staticinherited

Returns the version string.

Related OpenAL symbols:
alGetString AL_VERSION
Examples:
oalplus/001_info.cpp.

References oalplus::ContextOps::GetString(), and oalplus::Version.


The documentation for this class was generated from the following file:
  • /home/chochlik/devel/oglplus/include/oalplus/context.hpp

Copyright © 2010-2014 Matúš Chochlík, University of Žilina, Žilina, Slovakia.
<matus.chochlik -at- fri.uniza.sk>
<chochlik -at -gmail.com>
Documentation generated on Mon Sep 22 2014 by Doxygen (version 1.8.6).