Keyboard.h

Go to the documentation of this file.

 
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_KEYBOARD_H
#define SFML_KEYBOARD_H
 
// Headers
#include <SFML/Window/Export.h>
 
 
typedef enum
{
    sfKeyUnknown = -1, 
    sfKeyA,            
    sfKeyB,            
    sfKeyC,            
    sfKeyD,            
    sfKeyE,            
    sfKeyF,            
    sfKeyG,            
    sfKeyH,            
    sfKeyI,            
    sfKeyJ,            
    sfKeyK,            
    sfKeyL,            
    sfKeyM,            
    sfKeyN,            
    sfKeyO,            
    sfKeyP,            
    sfKeyQ,            
    sfKeyR,            
    sfKeyS,            
    sfKeyT,            
    sfKeyU,            
    sfKeyV,            
    sfKeyW,            
    sfKeyX,            
    sfKeyY,            
    sfKeyZ,            
    sfKeyNum0,         
    sfKeyNum1,         
    sfKeyNum2,         
    sfKeyNum3,         
    sfKeyNum4,         
    sfKeyNum5,         
    sfKeyNum6,         
    sfKeyNum7,         
    sfKeyNum8,         
    sfKeyNum9,         
    sfKeyEscape,       
    sfKeyLControl,     
    sfKeyLShift,       
    sfKeyLAlt,         
    sfKeyLSystem,      
    sfKeyRControl,     
    sfKeyRShift,       
    sfKeyRAlt,         
    sfKeyRSystem,      
    sfKeyMenu,         
    sfKeyLBracket,     
    sfKeyRBracket,     
    sfKeySemicolon,    
    sfKeyComma,        
    sfKeyPeriod,       
    sfKeyApostrophe,   
    sfKeySlash,        
    sfKeyBackslash,    
    sfKeyGrave,        
    sfKeyEqual,        
    sfKeyHyphen,       
    sfKeySpace,        
    sfKeyEnter,        
    sfKeyBackspace,    
    sfKeyTab,          
    sfKeyPageUp,       
    sfKeyPageDown,     
    sfKeyEnd,          
    sfKeyHome,         
    sfKeyInsert,       
    sfKeyDelete,       
    sfKeyAdd,          
    sfKeySubtract,     
    sfKeyMultiply,     
    sfKeyDivide,       
    sfKeyLeft,         
    sfKeyRight,        
    sfKeyUp,           
    sfKeyDown,         
    sfKeyNumpad0,      
    sfKeyNumpad1,      
    sfKeyNumpad2,      
    sfKeyNumpad3,      
    sfKeyNumpad4,      
    sfKeyNumpad5,      
    sfKeyNumpad6,      
    sfKeyNumpad7,      
    sfKeyNumpad8,      
    sfKeyNumpad9,      
    sfKeyF1,           
    sfKeyF2,           
    sfKeyF3,           
    sfKeyF4,           
    sfKeyF5,           
    sfKeyF6,           
    sfKeyF7,           
    sfKeyF8,           
    sfKeyF9,           
    sfKeyF10,          
    sfKeyF11,          
    sfKeyF12,          
    sfKeyF13,          
    sfKeyF14,          
    sfKeyF15,          
    sfKeyPause,        
 
    sfKeyCount,      
 
    // Deprecated values:
 
    sfKeyTilde     = sfKeyGrave,     
    sfKeyDash      = sfKeyHyphen,    
    sfKeyBack      = sfKeyBackspace, 
    sfKeyBackSlash = sfKeyBackslash, 
    sfKeySemiColon = sfKeySemicolon, 
    sfKeyReturn    = sfKeyEnter,     
    sfKeyQuote     = sfKeyApostrophe 
} sfKeyCode;
 
 
typedef enum
{
    sfScanUnknown = -1,       
    sfScanA = 0,              
    sfScanB,                  
    sfScanC,                  
    sfScanD,                  
    sfScanE,                  
    sfScanF,                  
    sfScanG,                  
    sfScanH,                  
    sfScanI,                  
    sfScanJ,                  
    sfScanK,                  
    sfScanL,                  
    sfScanM,                  
    sfScanN,                  
    sfScanO,                  
    sfScanP,                  
    sfScanQ,                  
    sfScanR,                  
    sfScanS,                  
    sfScanT,                  
    sfScanU,                  
    sfScanV,                  
    sfScanW,                  
    sfScanX,                  
    sfScanY,                  
    sfScanZ,                  
    sfScanNum1,               
    sfScanNum2,               
    sfScanNum3,               
    sfScanNum4,               
    sfScanNum5,               
    sfScanNum6,               
    sfScanNum7,               
    sfScanNum8,               
    sfScanNum9,               
    sfScanNum0,               
    sfScanEnter,              
    sfScanEscape,             
    sfScanBackspace,          
    sfScanTab,                
    sfScanSpace,              
    sfScanHyphen,             
    sfScanEqual,              
    sfScanLBracket,           
    sfScanRBracket,           
    // For US keyboards mapped to key 29 (Microsoft Keyboard Scan Code Specification)
    // For Non-US keyboards mapped to key 42 (Microsoft Keyboard Scan Code Specification)
    // Typical language mappings: Belg:£µ` FrCa:<>} Dan:*' Dutch:`´ Fren:µ* Ger:'# Ital:§ù LatAm:[}` Nor:*@ Span:ç} Swed:*' Swiss:$£} UK:~# Brazil:}]
    sfScanBackslash,          
    sfScanSemicolon,          
    sfScanApostrophe,         
    sfScanGrave,              
    sfScanComma,              
    sfScanPeriod,             
    sfScanSlash,              
    sfScanF1,                 
    sfScanF2,                 
    sfScanF3,                 
    sfScanF4,                 
    sfScanF5,                 
    sfScanF6,                 
    sfScanF7,                 
    sfScanF8,                 
    sfScanF9,                 
    sfScanF10,                
    sfScanF11,                
    sfScanF12,                
    sfScanF13,                
    sfScanF14,                
    sfScanF15,                
    sfScanF16,                
    sfScanF17,                
    sfScanF18,                
    sfScanF19,                
    sfScanF20,                
    sfScanF21,                
    sfScanF22,                
    sfScanF23,                
    sfScanF24,                
    sfScanCapsLock,           
    sfScanPrintScreen,        
    sfScanScrollLock,         
    sfScanPause,              
    sfScanInsert,             
    sfScanHome,               
    sfScanPageUp,             
    sfScanDelete,             
    sfScanEnd,                
    sfScanPageDown,           
    sfScanRight,              
    sfScanLeft,               
    sfScanDown,               
    sfScanUp,                 
    sfScanNumLock,            
    sfScanNumpadDivide,       
    sfScanNumpadMultiply,     
    sfScanNumpadMinus,        
    sfScanNumpadPlus,         
    sfScanNumpadEqual,        
    sfScanNumpadEnter,        
    sfScanNumpadDecimal,      
    sfScanNumpad1,            
    sfScanNumpad2,            
    sfScanNumpad3,            
    sfScanNumpad4,            
    sfScanNumpad5,            
    sfScanNumpad6,            
    sfScanNumpad7,            
    sfScanNumpad8,            
    sfScanNumpad9,            
    sfScanNumpad0,            
    // For US keyboards doesn't exist
    // For Non-US keyboards mapped to key 45 (Microsoft Keyboard Scan Code Specification)
    // Typical language mappings: Belg:<> FrCa:«°» Dan:<> Dutch:]|[ Fren:<> Ger:<|> Ital:<> LatAm:<> Nor:<> Span:<> Swed:<|> Swiss:<> UK:\| Brazil: \|.
    sfScanNonUsBackslash,     
    sfScanApplication,        
    sfScanExecute,            
    sfScanModeChange,         
    sfScanHelp,               
    sfScanMenu,               
    sfScanSelect,             
    sfScanRedo,               
    sfScanUndo,               
    sfScanCut,                
    sfScanCopy,               
    sfScanPaste,              
    sfScanVolumeMute,         
    sfScanVolumeUp,           
    sfScanVolumeDown,         
    sfScanMediaPlayPause,     
    sfScanMediaStop,          
    sfScanMediaNextTrack,     
    sfScanMediaPreviousTrack, 
    sfScanLControl,           
    sfScanLShift,             
    sfScanLAlt,               
    sfScanLSystem,            
    sfScanRControl,           
    sfScanRShift,             
    sfScanRAlt,               
    sfScanRSystem,            
    sfScanBack,               
    sfScanForward,            
    sfScanRefresh,            
    sfScanStop,               
    sfScanSearch,             
    sfScanFavorites,          
    sfScanHomePage,           
    sfScanLaunchApplication1, 
    sfScanLaunchApplication2, 
    sfScanLaunchMail,         
    sfScanLaunchMediaSelect,  
 
    sfScancodeCount           
} sfScancode;
 
 
CSFML_WINDOW_API sfBool sfKeyboard_isKeyPressed(sfKeyCode key);
 
CSFML_WINDOW_API sfBool sfKeyboard_isScancodePressed(sfScancode code);
 
CSFML_WINDOW_API sfKeyCode sfKeyboard_localize(sfScancode code);
 
CSFML_WINDOW_API sfScancode sfKeyboard_delocalize(sfKeyCode key);
 
CSFML_WINDOW_API const char* sfKeyboard_getDescription(sfScancode code);
 
CSFML_WINDOW_API void sfKeyboard_setVirtualKeyboardVisible(sfBool visible);
 
#endif // SFML_KEYBOARD_H