olcPixelGameEngine v2.29
The official distribution of olcPixelGameEngine, a tool used in javidx9's YouTube videos and projects
Loading...
Searching...
No Matches
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
olc Namespace Reference

Namespaces

namespace  fx
 
namespace  Mouse
 
namespace  net
 
namespace  popup
 
namespace  QuickGUI
 
namespace  rcw
 
namespace  wire
 

Classes

class  Decal
 
struct  DecalInstance
 
class  Effect
 
struct  EffectConfig
 
class  GFX2D
 
class  GFX3D
 
struct  GPUTask
 
struct  HWButton
 
class  ImageLoader
 
struct  LayerDesc
 
struct  mat3_generic
 
class  PGEX
 
struct  Pixel
 
class  PixelGameEngine
 
class  Platform
 
class  Renderable
 
class  Renderer
 
struct  ResourceBuffer
 
class  ResourcePack
 
class  Shade
 
class  SOUND
 
class  SplashScreen
 
class  Sprite
 
class  TileTransformedView
 
class  TransformedView
 
struct  v_2d
 

Typedefs

typedef v_2d< int32_t > vi2d
 
typedef v_2d< uint32_t > vu2d
 
typedef v_2d< float > vf2d
 
typedef v_2d< double > vd2d
 
typedef mat3_generic< float > Matrix2D
 

Enumerations

enum  rcode { FAIL = 0 , OK = 1 , NO_FILE = -1 }
 
enum class  Key : uint8_t {
  NONE , A , B , C ,
  D , E , F , G ,
  H , I , J , K ,
  L , M , N , O ,
  P , Q , R , S ,
  T , U , V , W ,
  X , Y , Z , K0 ,
  K1 , K2 , K3 , K4 ,
  K5 , K6 , K7 , K8 ,
  K9 , F1 , F2 , F3 ,
  F4 , F5 , F6 , F7 ,
  F8 , F9 , F10 , F11 ,
  F12 , UP , DOWN , LEFT ,
  RIGHT , SPACE , TAB , SHIFT ,
  CTRL , INS , DEL , HOME ,
  END , PGUP , PGDN , BACK ,
  ESCAPE , RETURN , ENTER , PAUSE ,
  SCROLL , NP0 , NP1 , NP2 ,
  NP3 , NP4 , NP5 , NP6 ,
  NP7 , NP8 , NP9 , NP_MUL ,
  NP_DIV , NP_ADD , NP_SUB , NP_DECIMAL ,
  PERIOD , EQUALS , COMMA , MINUS ,
  OEM_1 , OEM_2 , OEM_3 , OEM_4 ,
  OEM_5 , OEM_6 , OEM_7 , OEM_8 ,
  CAPS_LOCK , ENUM_END
}
 
enum class  DecalMode {
  NORMAL , ADDITIVE , MULTIPLICATIVE , STENCIL ,
  ILLUMINATE , WIREFRAME
}
 
enum class  DecalStructure { LINE , FAN , STRIP , LIST }
 
enum class  CullMode : uint8_t { NONE = 0 , CW = 1 , CCW = 2 }
 

Functions

template<class TL , class TR >
constexpr auto operator* (const TL &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator* (const v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr auto operator* (const v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator*= (v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr auto operator/ (const TL &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator/ (const v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr auto operator/ (const v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator/= (v_2d< TL > &lhs, const TR &rhs)
 
template<class T >
constexpr auto operator+ (const v_2d< T > &lhs)
 
template<class TL , class TR >
constexpr auto operator+ (const TL &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator+ (const v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr auto operator+ (const v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator+= (v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr auto operator+= (v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class T >
constexpr auto operator- (const v_2d< T > &lhs)
 
template<class TL , class TR >
constexpr auto operator- (const TL &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator- (const v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr auto operator- (const v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr auto operator-= (v_2d< TL > &lhs, const TR &rhs)
 
template<class TL , class TR >
constexpr bool operator< (const v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class TL , class TR >
constexpr bool operator> (const v_2d< TL > &lhs, const v_2d< TR > &rhs)
 
template<class T >
constexpr std::ostream & operator<< (std::ostream &os, const v_2d< T > &rhs)
 
Pixel PixelF (float red, float green, float blue, float alpha=1.0f)
 
Pixel PixelLerp (const olc::Pixel &p1, const olc::Pixel &p2, float t)
 
static const Pixel DARK_GREY (128, 128, 128)
 
static const Pixel VERY_DARK_GREY (64, 64, 64)
 
static const Pixel RED (255, 0, 0)
 
static const Pixel DARK_RED (128, 0, 0)
 
static const Pixel VERY_DARK_RED (64, 0, 0)
 
static const Pixel YELLOW (255, 255, 0)
 
static const Pixel DARK_YELLOW (128, 128, 0)
 
static const Pixel VERY_DARK_YELLOW (64, 64, 0)
 
static const Pixel GREEN (0, 255, 0)
 
static const Pixel DARK_GREEN (0, 128, 0)
 
static const Pixel VERY_DARK_GREEN (0, 64, 0)
 
static const Pixel CYAN (0, 255, 255)
 
static const Pixel DARK_CYAN (0, 128, 128)
 
static const Pixel VERY_DARK_CYAN (0, 64, 64)
 
static const Pixel BLUE (0, 0, 255)
 
static const Pixel DARK_BLUE (0, 0, 128)
 
static const Pixel VERY_DARK_BLUE (0, 0, 64)
 
static const Pixel MAGENTA (255, 0, 255)
 
static const Pixel DARK_MAGENTA (128, 0, 128)
 
static const Pixel VERY_DARK_MAGENTA (64, 0, 64)
 
static const Pixel WHITE (255, 255, 255)
 
static const Pixel BLACK (0, 0, 0)
 
static const Pixel BLANK (0, 0, 0, 0)
 

Variables

constexpr uint8_t nMouseButtons = 5
 
constexpr uint8_t nDefaultAlpha = 0xFF
 
constexpr uint32_t nDefaultPixel = uint32_t(nDefaultAlpha << 24)
 
constexpr uint8_t nTabSizeInSpaces = 4
 
constexpr size_t OLC_MAX_VERTS = 128
 
std::map< size_t, olc::Key > mapKeys
 

Typedef Documentation

◆ Matrix2D

typedef mat3_generic<float> olc::Matrix2D

◆ vd2d

typedef v_2d<double> olc::vd2d

◆ vf2d

typedef v_2d<float> olc::vf2d

◆ vi2d

typedef v_2d<int32_t> olc::vi2d

◆ vu2d

typedef v_2d<uint32_t> olc::vu2d

Enumeration Type Documentation

◆ CullMode

enum class olc::CullMode : uint8_t
strong
Enumerator
NONE 
CW 
CCW 

◆ DecalMode

enum class olc::DecalMode
strong
Enumerator
NORMAL 
ADDITIVE 
MULTIPLICATIVE 
STENCIL 
ILLUMINATE 
WIREFRAME 

◆ DecalStructure

enum class olc::DecalStructure
strong
Enumerator
LINE 
FAN 
STRIP 
LIST 

◆ Key

enum class olc::Key : uint8_t
strong
Enumerator
NONE 
A 
B 
C 
D 
E 
F 
G 
H 
I 
J 
K 
L 
M 
N 
O 
P 
Q 
R 
S 
T 
U 
V 
W 
X 
Y 
Z 
K0 
K1 
K2 
K3 
K4 
K5 
K6 
K7 
K8 
K9 
F1 
F2 
F3 
F4 
F5 
F6 
F7 
F8 
F9 
F10 
F11 
F12 
UP 
DOWN 
LEFT 
RIGHT 
SPACE 
TAB 
SHIFT 
CTRL 
INS 
DEL 
HOME 
END 
PGUP 
PGDN 
BACK 
ESCAPE 
RETURN 
ENTER 
PAUSE 
SCROLL 
NP0 
NP1 
NP2 
NP3 
NP4 
NP5 
NP6 
NP7 
NP8 
NP9 
NP_MUL 
NP_DIV 
NP_ADD 
NP_SUB 
NP_DECIMAL 
PERIOD 
EQUALS 
COMMA 
MINUS 
OEM_1 
OEM_2 
OEM_3 
OEM_4 
OEM_5 
OEM_6 
OEM_7 
OEM_8 
CAPS_LOCK 
ENUM_END 

◆ rcode

enum olc::rcode
Enumerator
FAIL 
OK 
NO_FILE 

Function Documentation

◆ BLACK()

static const Pixel olc::BLACK ( 0 ,
0 ,
0  )

◆ BLANK()

static const Pixel olc::BLANK ( 0 ,
0 ,
0 ,
0  )

◆ BLUE()

static const Pixel olc::BLUE ( 0 ,
0 ,
255  )

◆ CYAN()

static const Pixel olc::CYAN ( 0 ,
255 ,
255  )

◆ DARK_BLUE()

static const Pixel olc::DARK_BLUE ( 0 ,
0 ,
128  )

◆ DARK_CYAN()

static const Pixel olc::DARK_CYAN ( 0 ,
128 ,
128  )

◆ DARK_GREEN()

static const Pixel olc::DARK_GREEN ( 0 ,
128 ,
0  )

◆ DARK_GREY()

static const Pixel olc::DARK_GREY ( 128 ,
128 ,
128  )

◆ DARK_MAGENTA()

static const Pixel olc::DARK_MAGENTA ( 128 ,
0 ,
128  )

◆ DARK_RED()

static const Pixel olc::DARK_RED ( 128 ,
0 ,
0  )

◆ DARK_YELLOW()

static const Pixel olc::DARK_YELLOW ( 128 ,
128 ,
0  )

◆ GREEN()

static const Pixel olc::GREEN ( 0 ,
255 ,
0  )

◆ MAGENTA()

static const Pixel olc::MAGENTA ( 255 ,
0 ,
255  )

◆ operator*() [1/3]

template<class TL , class TR >
auto olc::operator* ( const TL & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator*() [2/3]

template<class TL , class TR >
auto olc::operator* ( const v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator*() [3/3]

template<class TL , class TR >
auto olc::operator* ( const v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator*=()

template<class TL , class TR >
auto olc::operator*= ( v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator+() [1/4]

template<class TL , class TR >
auto olc::operator+ ( const TL & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator+() [2/4]

template<class T >
auto olc::operator+ ( const v_2d< T > & lhs)
inlineconstexpr

◆ operator+() [3/4]

template<class TL , class TR >
auto olc::operator+ ( const v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator+() [4/4]

template<class TL , class TR >
auto olc::operator+ ( const v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator+=() [1/2]

template<class TL , class TR >
auto olc::operator+= ( v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator+=() [2/2]

template<class TL , class TR >
auto olc::operator+= ( v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator-() [1/4]

template<class TL , class TR >
auto olc::operator- ( const TL & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator-() [2/4]

template<class T >
auto olc::operator- ( const v_2d< T > & lhs)
inlineconstexpr

◆ operator-() [3/4]

template<class TL , class TR >
auto olc::operator- ( const v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator-() [4/4]

template<class TL , class TR >
auto olc::operator- ( const v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator-=()

template<class TL , class TR >
auto olc::operator-= ( v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator/() [1/3]

template<class TL , class TR >
auto olc::operator/ ( const TL & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator/() [2/3]

template<class TL , class TR >
auto olc::operator/ ( const v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator/() [3/3]

template<class TL , class TR >
auto olc::operator/ ( const v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator/=()

template<class TL , class TR >
auto olc::operator/= ( v_2d< TL > & lhs,
const TR & rhs )
inlineconstexpr

◆ operator<()

template<class TL , class TR >
bool olc::operator< ( const v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ operator<<()

template<class T >
std::ostream & olc::operator<< ( std::ostream & os,
const v_2d< T > & rhs )
inlineconstexpr

◆ operator>()

template<class TL , class TR >
bool olc::operator> ( const v_2d< TL > & lhs,
const v_2d< TR > & rhs )
inlineconstexpr

◆ PixelF()

Pixel olc::PixelF ( float red,
float green,
float blue,
float alpha = 1.0f )

◆ PixelLerp()

Pixel olc::PixelLerp ( const olc::Pixel & p1,
const olc::Pixel & p2,
float t )

◆ RED()

static const Pixel olc::RED ( 255 ,
0 ,
0  )

◆ VERY_DARK_BLUE()

static const Pixel olc::VERY_DARK_BLUE ( 0 ,
0 ,
64  )

◆ VERY_DARK_CYAN()

static const Pixel olc::VERY_DARK_CYAN ( 0 ,
64 ,
64  )

◆ VERY_DARK_GREEN()

static const Pixel olc::VERY_DARK_GREEN ( 0 ,
64 ,
0  )

◆ VERY_DARK_GREY()

static const Pixel olc::VERY_DARK_GREY ( 64 ,
64 ,
64  )

◆ VERY_DARK_MAGENTA()

static const Pixel olc::VERY_DARK_MAGENTA ( 64 ,
0 ,
64  )

◆ VERY_DARK_RED()

static const Pixel olc::VERY_DARK_RED ( 64 ,
0 ,
0  )

◆ VERY_DARK_YELLOW()

static const Pixel olc::VERY_DARK_YELLOW ( 64 ,
64 ,
0  )

◆ WHITE()

static const Pixel olc::WHITE ( 255 ,
255 ,
255  )

◆ YELLOW()

static const Pixel olc::YELLOW ( 255 ,
255 ,
0  )

Variable Documentation

◆ mapKeys

std::map<size_t, olc::Key> olc::mapKeys
inline

◆ nDefaultAlpha

uint8_t olc::nDefaultAlpha = 0xFF
constexpr

◆ nDefaultPixel

uint32_t olc::nDefaultPixel = uint32_t(nDefaultAlpha << 24)
constexpr

◆ nMouseButtons

uint8_t olc::nMouseButtons = 5
constexpr

◆ nTabSizeInSpaces

uint8_t olc::nTabSizeInSpaces = 4
constexpr

◆ OLC_MAX_VERTS

size_t olc::OLC_MAX_VERTS = 128
constexpr