Photon 0.0.2
Simple Open Source 2D Game API
photon::
Index

Basic Types

Summary
Basic Types
Basic Types
ubyte
Unsigned byte, alias for unsigned char.
uint
Alias for unsigned integer.
scalar
Scalar value, used throughout photon in place of double or float
STL/ Boost Types
StrVec
Typedef for vector of strings, which is used all throughout photon.
shared_ptr
Shared pointer type.
Enums
KeyCode
Enumeration defining keys, used in Application::keyPressed.
MouseButton
Enumeration defining buttons, used in Application::mouseButtonPressed.
ScrollDir
Enumeration defining scroll direction of mouse wheel.

Basic Types

ubyte

Unsigned byte, alias for unsigned char.

uint

Alias for unsigned integer.

scalar

Scalar value, used throughout photon in place of double or float

STL/ Boost Types

StrVec

Typedef for vector of strings, which is used all throughout photon.

shared_ptr

Shared pointer type.  (uses the boost implementation)

Enums

KeyCode

Enumeration defining keys, used in Application::keyPressed.

Enums

KEY_ESCEscape key
KEY_F1F1 key
KEY_F2F2 key
KEY_F3F3 key
KEY_F4F4 key
KEY_F5F5 key
KEY_F6F6 key
KEY_F7F7 key
KEY_F8F8 key
KEY_F9F9 key
KEY_F10F10 key
KEY_F11F11 key
KEY_F12F12 key
KEY_F13F13 key
KEY_F14F14 key
KEY_F15F15 key
KEY_F16F16 key
KEY_F17F17 key
KEY_F18F18 key
KEY_F19F19 key
KEY_F20F20 key
KEY_F21F21 key
KEY_F22F22 key
KEY_F23F23 key
KEY_F24F24 key
KEY_F25F25 key
KEY_INSERTInsert key
KEY_HOMEHome key
KEY_PGUPPage up key
KEY_DELETEDelete key
KEY_ENDEnd key
KEY_PGDOWNPage down key
KEY_UPUp arrow key
KEY_LEFTLeft arrow key
KEY_DOWNDown arrow key
KEY_RIGHTRight arrow key
KEY_TILDETilde key
KEY_11 key
KEY_22 key
KEY_33 key
KEY_44 key
KEY_55 key
KEY_66 key
KEY_77 key
KEY_88 key
KEY_99 key
KEY_00 key
KEY_MINUSMinus key
KEY_EQUALEqual key KEY_BACKSPACE- Backspace key
KEY_TABTab key
KEY_QQ key
KEY_WW key
KEY_EE key
KEY_RR key
KEY_TT key
KEY_YY key
KEY_UU key
KEY_II key
KEY_OO key
KEY_PP key
KEY_LBRACLeft bracket [ key
KEY_RBRACRight bracket ] key
KEY_BKSLASHBackslash \ key
KEY_AA key
KEY_SS key
KEY_DD key
KEY_FF key
KEY_GG key
KEY_HH key
KEY_JJ key
KEY_KK key
KEY_LL key
KEY_COLONColon : key
KEY_QUOTEQuote “ key
KEY_RETURNEnter/Return key
KEY_LSHIFTLeft shift key
KEY_ZZ key
KEY_XX key
KEY_CC key
KEY_VV key
KEY_BB key
KEY_NN key
KEY_MM key
KEY_COMMAComma , key
KEY_PERIODPeriod . key
KEY_SLASHSlash / key
KEY_RSHIFTRight shift key
KEY_LCTRLLeft control key
KEY_LALTLeft alt key
KEY_SPACESpace bar key
KEY_RALTRight alt key
KEY_RCTRLRight control key
KEY_NUM_SLASHNumpad slash / key
KEY_NUM_ASTERIXNumpad asterix * key
KEY_NUM_MINUSNumpad minus - key
KEY_NUM_PLUSNumpad plus + key
KEY_NUM_ENTERNumpad enter key
KEY_NUM_PERIODNumpad period . key
KEY_NUM_0Numpad 0 key
KEY_NUM_1Numpad 1 key
KEY_NUM_2Numpad 2 key
KEY_NUM_3Numpad 3 key
KEY_NUM_4Numpad 4 key
KEY_NUM_5Numpad 5 key
KEY_NUM_6Numpad 6 key
KEY_NUM_7Numpad 7 key
KEY_NUM_8Numpad 8 key
KEY_NUM_9Numpad 9 key

MouseButton

Enumeration defining buttons, used in Application::mouseButtonPressed.

MB_LEFTLeft mouse button.
MB_MIDDLEMiddle mouse button.
MB_RIGHTRight mouse button.

ScrollDir

Enumeration defining scroll direction of mouse wheel.

SCROLL_UPWheel was scrolled up.
SCROLL_DOWNWheel was scrolled down.
Documentation for photon. Copyright © 2004-2005 James Turk.  Generated by Natural Docs.
bool keyPressed(KeyCode key)
Check if a given key is currently pressed.
bool mouseButtonPressed(MouseButton button)
Check if a given mouse button is currently pressed.