ge211  2021.5.1
A student game engine
ge211 Namespace Reference

Detailed Description

The game engine namespace.

Namespaces

 audio
 Audio facilities, for playing music and sound effects.
 
 events
 Types for representing mouse and keyboard events.
 
 exceptions
 An exception hierarchy for ge211 to report errors.
 
 geometry
 Geometric objects and their operations.
 
 internal
 Internal facilities that you might want to use if you're doing something fancy.
 
 sprites
 Sprites are images that can be rendered to the screen.
 
 time
 Types for representing time and timers.
 

Classes

class  Abstract_game
 This is the abstract base class for deriving games. More...
 
class  Color
 For representing colors. More...
 
class  Font
 Represents a font that can be used to render a sprites::Text_sprite. More...
 
class  Random_source
 A generic class for generating pseudorandom numbers in uniform distribution over a specified range. More...
 
class  Sprite_set
 A collection of positioned Sprites ready to be rendered to the screen. More...
 
class  unbounded_type
 The type of special tag value unbounded. More...
 
class  Window
 Provides access to the game window and its properties. More...
 

Typedefs

template<typename OBJECT_TYPE >
using Owned = OBJECT_TYPE *
 Type alias to indicate that the given pointer owns its object.
 
template<typename OBJECT_TYPE >
using Borrowed = OBJECT_TYPE *
 Type alias to indicate that the given pointer does not own its object.
 

Functions

std::ifstream open_resource_file (std::string const &filename)
 Opens a file in the Resources/ directory for input in text mode. More...
 
std::ifstream open_binary_resource_file (std::string const &filename)
 Opens a file in the Resources/ directory for input in binary mode. More...
 
template<typename PRINTABLE >
std::string to_string (const PRINTABLE &value)
 Converts any printable type to a std::string.
 

Variables

constexpr unbounded_type const unbounded { }
 A tag value for passing to the constructor Random_source::Random_source(unbounded_type) in order to delay specifying the range of numbers at construction time. More...
 

Function Documentation

◆ open_binary_resource_file()

std::ifstream open_binary_resource_file ( std::string const &  filename)

Opens a file in the Resources/ directory for input in binary mode.

Throws exceptions::File_error if the file cannot be opened.

Definition at line 75 of file ge211_resource.cxx.

◆ open_resource_file()

std::ifstream open_resource_file ( std::string const &  filename)

Opens a file in the Resources/ directory for input in text mode.

Throws exceptions::File_error if the file cannot be opened.

Definition at line 69 of file ge211_resource.cxx.

Variable Documentation

◆ unbounded

constexpr unbounded_type const unbounded { }
constexpr

A tag value for passing to the constructor Random_source::Random_source(unbounded_type) in order to delay specifying the range of numbers at construction time.

Instead, the range of numbers must be passed to Random_source::operator()(result_type, result_type) or Random_source::next_between(result_type, result_type) for each number you generate.

For an example, see Random_source::Random_source(unbounded_type).

Definition at line 181 of file ge211_random.hxx.