Browse Source

Documentation update.

Lasse Öörni 14 năm trước cách đây
mục cha
commit
270ba840b3
2 tập tin đã thay đổi với 5 bổ sung5 xóa
  1. 2 2
      CMakeLists.txt
  2. 3 3
      Docs/GettingStarted.dox

+ 2 - 2
CMakeLists.txt

@@ -25,12 +25,12 @@ add_definitions (-DENABLE_PROFILING)
 # If not on Windows, enable use of SDL and OpenGL instead of Direct3D9 (so called "Turso3D" mode.)
 # If not on Windows, enable use of SDL and OpenGL instead of Direct3D9 (so called "Turso3D" mode.)
 # Setting this on Windows is not recommended, as graphics card drivers are usually better optimized 
 # Setting this on Windows is not recommended, as graphics card drivers are usually better optimized 
 # for Direct3D.
 # for Direct3D.
-#if (UNIX)
+if (UNIX)
     set (USE_SDL 1)
     set (USE_SDL 1)
     set (USE_OPENGL 1)
     set (USE_OPENGL 1)
     add_definitions (-DUSE_SDL)
     add_definitions (-DUSE_SDL)
     add_definitions (-DUSE_OPENGL)
     add_definitions (-DUSE_OPENGL)
-#endif ()
+endif ()
 
 
 # Compiler-specific options
 # Compiler-specific options
 if (MSVC)
 if (MSVC)

+ 3 - 3
Docs/GettingStarted.dox

@@ -255,11 +255,11 @@ void SubscribeToEvents()
 }
 }
 \endcode
 \endcode
 
 
-The event handler function needs to have a specific signature. If event type and parameters are not needed, "void HandleEvent()", or "void HandleEvent(StringHash eventType, VariantMap& eventData)" if they are.
+The event handler function needs to have a specific signature. If event type and parameters are not needed, "void HandleEvent()", or if they are, "void HandleEvent(StringHash eventType, VariantMap& eventData)". We might want to expand the application later, so we use the latter form.
 
 
-We might want to expand the application later, so we use the latter form. The current frame's delta time is sent in the update event's parameters, and that will be useful when animating the scene. For now the event handler simply checks from the Input subsystem if the ESC key has been pressed; if it is, the Engine subsystem's \ref Engine::Exit() "Exit()" function will be called. This closes the application window and causes Urho3D.exe to exit after the current main loop iteration finishes.
+The current frame's delta time is sent in the update event's parameters, and that will be useful when animating the scene. For now the event handler simply checks from the Input subsystem if the ESC key has been pressed; if it is, the Engine subsystem's \ref Engine::Exit() "Exit()" function will be called. This closes the application window and causes Urho3D.exe to exit after the current main loop iteration finishes.
 
 
-Note that we could also subscribe to the "KeyDown" event sent by the Input subsystem.
+To get the ESC keypress without having to poll it for each frame, we could also subscribe to the "KeyDown" event sent by the Input subsystem.
 
 
 \code
 \code
 void HandleUpdate(StringHash eventType, VariantMap& eventData)
 void HandleUpdate(StringHash eventType, VariantMap& eventData)