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

Application wrapper

Classes

class  eagine::application::orbiting_camera
 Extension of orbiting camera wrapper. More...
 
class  eagine::application::video_context
 Class holding video rendering-related application support objects. More...
 
class  eagine::application::audio_context
 Class holding audio playback and recording-related application support objects. More...
 
class  eagine::application::execution_context
 Class holding shared video/audio rendering application support objects. More...
 
class  eagine::application::input_setup
 Class that managers user input state. More...
 
class  eagine::application::input
 Class representing a user input. More...
 
struct  eagine::application::input_slot
 Class that allows binding of a user input device to a handler callable. More...
 
class  eagine::application::video_options
 Class holding and managing video-related application options. More...
 
class  eagine::application::audio_options
 Class holding and managing audio-related application options. More...
 
class  eagine::application::launch_options
 Class managing options for an application with video / audio rendering. More...
 
class  eagine::application::context_state
 Class managing application context variables. More...
 
class  eagine::application::context_state_view
 Read-only view of application context state values. More...
 

Typedefs

using eagine::application::input_value_kinds = bitfield< input_value_kind >
 Application input value kind bitfield. More...
 
template<typename T >
using eagine::application::input_value = value_with_history< T, 3 >
 Alias for input value with history. More...
 
template<typename T >
using eagine::application::input_variable = variable_with_history< T, 3 >
 Alias for input value with history. More...
 
using eagine::application::input_handler = callable_ref< void(const input &)>
 Alias for a input handler callable reference.
 
template<typename T >
using eagine::application::state_value = value_with_history< T, 3 >
 Alias for application state value with history. More...
 
template<typename T >
using eagine::application::state_variable = variable_with_history< T, 3 >
 Alias for application state variable with history. More...
 

Enumerations

enum  eagine::application::input_value_kind : unsigned { eagine::application::input_value_kind::relative, eagine::application::input_value_kind::absolute_norm, eagine::application::input_value_kind::absolute_free }
 Application input value kind bits enumeration. More...
 
enum  eagine::application::video_context_kind : std::uint8_t { eagine::application::video_context_kind::opengl, eagine::application::video_context_kind::openvg }
 Video / graphics rendering context kind. More...
 
enum  eagine::application::audio_context_kind : std::uint8_t { eagine::application::audio_context_kind::openal }
 Audio / sound playback and recodring context kind. More...
 
enum  eagine::application::video_device_kind : std::uint8_t { eagine::application::video_device_kind::dont_care, eagine::application::video_device_kind::hardware, eagine::application::video_device_kind::software }
 Video rendering device kind. More...
 
enum  eagine::application::framedump_data_type : std::uint8_t { eagine::application::framedump_data_type::none, eagine::application::framedump_data_type::float_type, eagine::application::framedump_data_type::byte_type }
 Pixel data type used to store frame dump image data. More...
 
enum  eagine::application::framedump_pixel_format : std::uint8_t { eagine::application::framedump_pixel_format::none, eagine::application::framedump_pixel_format::rgba, eagine::application::framedump_pixel_format::depth, eagine::application::framedump_pixel_format::stencil }
 Pixel data format of frame dump image data. More...
 

Detailed Description

Typedef Documentation

◆ input_value

template<typename T >
using eagine::application::input_value = typedef value_with_history<T, 3>

Alias for input value with history.

See also
input_variable
input_setup
input

◆ input_value_kinds

Application input value kind bitfield.

See also
input_value_kinds

◆ input_variable

template<typename T >
using eagine::application::input_variable = typedef variable_with_history<T, 3>

Alias for input value with history.

See also
input_value
input_setup
input

◆ state_value

template<typename T >
using eagine::application::state_value = typedef value_with_history<T, 3>

Alias for application state value with history.

See also
state_variable
context_state_view

◆ state_variable

template<typename T >
using eagine::application::state_variable = typedef variable_with_history<T, 3>

Alias for application state variable with history.

See also
state_value
context_state_view

Enumeration Type Documentation

◆ audio_context_kind

enum eagine::application::audio_context_kind : std::uint8_t
strong

Audio / sound playback and recodring context kind.

Enumerator
openal 

OpenAL© context.

◆ framedump_data_type

enum eagine::application::framedump_data_type : std::uint8_t
strong

Pixel data type used to store frame dump image data.

See also
framedump_pixel_format
Enumerator
none 

None, not doing frame dump render run.

float_type 

Floating-point pixel data.

byte_type 

Byte pixel data.

◆ framedump_pixel_format

enum eagine::application::framedump_pixel_format : std::uint8_t
strong

Pixel data format of frame dump image data.

See also
framedump_data_type
Enumerator
none 

None.

rgba 

Red, green, blue, alpha color channel data.

depth 

Depth buffer data.

stencil 

Stencil buffer data.

◆ input_value_kind

enum eagine::application::input_value_kind : unsigned
strong

Application input value kind bits enumeration.

See also
input_value_kinds
Enumerator
relative 

Relative input value change.

absolute_norm 

Absolute input value normalized to <-1, 1>.

absolute_free 

Absolute input value without bounds.

◆ video_context_kind

enum eagine::application::video_context_kind : std::uint8_t
strong

Video / graphics rendering context kind.

Enumerator
opengl 

OpenGL© (or OpenGL|ES) context.

openvg 

OpenVG© context.

◆ video_device_kind

enum eagine::application::video_device_kind : std::uint8_t
strong

Video rendering device kind.

Enumerator
dont_care 

No preferrence.

hardware 

Hardware rendering device.

software 

Software rendering device.


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