DRAFT

SDL_GetKeyFromName

Use this function to get a key code from a human-readable name.

Contents

  1. Syntax
  2. Function Parameters
  3. Return Value
  4. Code Examples
  5. Remarks
  6. Related Functions

Syntax

SDL_Keycode SDL_GetKeyFromName(const char* name)

Function Parameters

name

the human-readable key name

Return Value

Returns key code, or SDLK_UNKNOWN if the name wasn't recognized; call [[SDL_GetError]]() for more information.

Should it refer to SDL_Keycode instead of key code? Leave error call in?

Code Examples

You can add your code example here

Remarks

You can add useful comments here

CategoryAPI, CategoryKeyboard

SDL_GetKeyFromName (last edited 2011-10-26 00:34:38 by SheenaSmith)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit